Skip to content

Commit 253f336

Browse files
authored
lsc: trpc-go-cmdline => trpc-cmdline (trpc-group#72)
1 parent b838f50 commit 253f336

File tree

26 files changed

+49
-49
lines changed

26 files changed

+49
-49
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,13 @@ tRPC-Go has the following features:
2525
- All components are pluggable, with default implementations for various basic functionalities that can be replaced. Other components can be implemented by third parties and registered within the framework.
2626
- All interfaces can be mock tested using gomock&mockgen to generate mock code, facilitating testing.
2727
- The framework supports any third-party protocol by implementing the `codec` interfaces for the respective protocol. It defaults to supporting trpc and http protocols and can be switched at any time.
28-
- It provides the [trpc command-line tool][trpc-go-cmdline] for generating code templates.
28+
- It provides the [trpc command-line tool][trpc-cmdline] for generating code templates.
2929

3030
## Related Documentation
3131

3232
- [quick start guide][quick start] and [detailed documentation][docs]
3333
- readme documents in each directory
34-
- [trpc command-line tool][trpc-go-cmdline]
34+
- [trpc command-line tool][trpc-cmdline]
3535
- [helloworld development guide][helloworld]
3636
- [example documentation for various features][features]
3737

@@ -49,7 +49,7 @@ If you're interested in contributing, please take a look at the [contribution gu
4949
[Go]: https://golang.org
5050
[go-releases]: https://golang.org/doc/devel/release.html
5151
[tRPC]: https://github.com/trpc-group/trpc
52-
[trpc-go-cmdline]: https://github.com/trpc-group/trpc-go-cmdline
52+
[trpc-cmdline]: https://github.com/trpc-group/trpc-cmdline
5353
[docs]: /docs/README.md
5454
[quick start]: /docs/quick_start.md
5555
[contributing]: CONTRIBUTING.md

README.zh_CN.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,13 @@ tRPC-Go 具有以下特点:
2525
- 所有的组件都是可插拔的,内置了各种基本功能的默认实现,可以进行替换。其他组件可以由第三方实现并注册到框架中。
2626
- 所有的接口都可以进行模拟测试,使用 gomock&mockgen 生成 mock 代码,方便进行测试。
2727
- 框架支持任意的第三方协议,只需要实现协议的打包和解包接口即可。默认支持 trpc 和 http 协议,可以随时切换。
28-
- 提供了 [trpc 命令行工具][trpc-go-cmdline] 用于生成代码模板。
28+
- 提供了 [trpc 命令行工具][trpc-cmdline] 用于生成代码模板。
2929

3030
## 相关文档
3131

3232
- [快速上手][quick start] 以及 [详细文档][docs]
3333
- 各个目录下的 README 文档
34-
- [trpc 命令行工具][trpc-go-cmdline]
34+
- [trpc 命令行工具][trpc-cmdline]
3535
- [helloworld 开发指南][helloworld]
3636
- [各种特性的示例文档][features]
3737

@@ -48,7 +48,7 @@ tRPC-Go 具有以下特点:
4848

4949
[Go]: https://golang.org
5050
[tRPC]: https://github.com/trpc-group/trpc
51-
[trpc-go-cmdline]: https://github.com/trpc-group/trpc-go-cmdline
51+
[trpc-cmdline]: https://github.com/trpc-group/trpc-cmdline
5252
[docs]: /docs/README.zh_CN.md
5353
[quick start]: /docs/quick_start.zh_CN.md
5454
[go-releases]: https://golang.org/doc/devel/release.html

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ English | [中文](README.zh_CN.md)
2323
- [Reverse Proxy](/docs/user_guide/reverse_proxy.md)
2424
- [Graceful Restart](/docs/user_guide/graceful_restart.md)
2525
- [Health Check](/healthcheck/README.md)
26-
- [Cmdline Tools](https://github.com/trpc-group/trpc-go-cmdline)
26+
- [Cmdline Tools](https://github.com/trpc-group/trpc-cmdline)
2727
- [High Performance Network Package tnet](/docs/user_guide/tnet.md)
2828
- [Track Running Status](/rpcz/README.md)
2929
- [Attachment (Big Binary Data) Transfer](/docs/user_guide/attachment.md)

docs/README.zh_CN.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
- [反向代理](/docs/user_guide/reverse_proxy.zh_CN.md)
2424
- [优雅重启](/docs/user_guide/graceful_restart.zh_CN.md)
2525
- [健康检查](/healthcheck/README.zh_CN.md)
26-
- [命令行工具](https://github.com/trpc-group/trpc-go-cmdline)
26+
- [命令行工具](https://github.com/trpc-group/trpc-cmdline)
2727
- [高性能网络库 tnet](/docs/user_guide/tnet.zh_CN.md)
2828
- [运行状态追踪](/rpcz/README.zh_CN.md)
2929
- [附件(大二进制数据)传输](/docs/user_guide/attachment.zh_CN.md)

docs/quick_start.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ English | [中文](quick_start.zh_CN.md)
66
## Prerequisites
77

88
- **[Go][]**: any one of the **three latest major** [releases][go-releases].
9-
- **[trpc-go-cmdline][]**: follow the instructions in the [README][trpc-go-cmdline] to install trpc-go-cmdline and its related dependencies correctly.
9+
- **[trpc-cmdline][]**: follow the instructions in the [README][trpc-cmdline] to install trpc-cmdline and its related dependencies correctly.
1010

1111
## Create a Full Project Step by Step
1212

@@ -35,7 +35,7 @@ service HelloWorldService {
3535
}
3636
```
3737

38-
* Using [trpc-go-cmdline][] to generate a full project:
38+
* Using [trpc-cmdline][] to generate a full project:
3939
```shell
4040
$ trpc create -p helloworld.proto -o out
4141
```
@@ -102,7 +102,7 @@ out
102102
`-- helloworld_mock.go
103103
```
104104

105-
The following lists some frequently used flags for [trpc-go-cmdline][].
105+
The following lists some frequently used flags for [trpc-cmdline][].
106106

107107
* `-f`: Force overwrite the existing code.
108108
* `-d some-dir`: Search paths for pb files (including dependent pb files), can be specified multiple times.
@@ -113,12 +113,12 @@ For additional flags please run `trpc -h` and `trpc [subcmd] -h`.
113113

114114
## What's Next
115115
116-
Try [more features][features]. Learn more about [trpc-go-cmdline][]'s [documentation][cmdline-doc].
116+
Try [more features][features]. Learn more about [trpc-cmdline][]'s [documentation][cmdline-doc].
117117

118118
[Go]: https://golang.org
119119
[go-releases]: https://golang.org/doc/devel/release.html
120-
[trpc-go-cmdline]: https://github.com/trpc-group/trpc-go-cmdline
121-
[cmdline-releases]: https://github.com/trpc-group/trpc-go-cmdline/releases
120+
[trpc-cmdline]: https://github.com/trpc-group/trpc-cmdline
121+
[cmdline-releases]: https://github.com/trpc-group/trpc-cmdline/releases
122122
[helloworld]: /examples/helloworld/
123123
[features]: /examples/features/
124-
[cmdline-doc]: https://github.com/trpc-group/trpc-go-cmdline/tree/main/docs
124+
[cmdline-doc]: https://github.com/trpc-group/trpc-cmdline/tree/main/docs

docs/quick_start.zh_CN.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
## 安装依赖
77

88
- **[Go][]**: **最近的三个 major** [releases][go-releases].
9-
- **[trpc-go-cmdline][]**: 正确按照 [README][trpc-go-cmdline] 来安装 trpc-go-cmdline 以及相关依赖
9+
- **[trpc-cmdline][]**: 正确按照 [README][trpc-cmdline] 来安装 trpc-cmdline 以及相关依赖
1010

1111
## 创建完整的项目
1212

@@ -35,7 +35,7 @@ service HelloWorldService {
3535
}
3636
```
3737

38-
* 通过以下命令使用 [trpc-go-cmdline][] 来生成一个完整的项目:
38+
* 通过以下命令使用 [trpc-cmdline][] 来生成一个完整的项目:
3939
```shell
4040
$ trpc create -p helloworld.proto -o out
4141
```
@@ -90,7 +90,7 @@ $ tree
9090

9191
## 创建服务桩代码
9292

93-
* 在执行 trpc-go-cmdline 工具时直接添加 `--rpconly` 即可只生成服务桩代码:
93+
* 在执行 trpc-cmdline 工具时直接添加 `--rpconly` 即可只生成服务桩代码:
9494
```go
9595
$ trpc create -p helloworld.proto -o out --rpconly
9696
$ tree out
@@ -102,7 +102,7 @@ out
102102
`-- helloworld_mock.go
103103
```
104104

105-
下面列举了 [trpc-go-cmdline][] 的一些常用的命令行选项
105+
下面列举了 [trpc-cmdline][] 的一些常用的命令行选项
106106

107107
* `-f`: 覆盖写入输出目录
108108
* `-d some-dir`: 指定 proto 文件的搜索路径,可以指定多次以添加多个路径
@@ -113,12 +113,12 @@ out
113113

114114
## 下一步
115115

116-
尝试 [更多特性][features],学习更多关于 [trpc-go-cmdline][] 的 [用法][cmdline-doc]。
116+
尝试 [更多特性][features],学习更多关于 [trpc-cmdline][] 的 [用法][cmdline-doc]。
117117

118118
[Go]: https://golang.org
119119
[go-releases]: https://golang.org/doc/devel/release.html
120-
[trpc-go-cmdline]: https://github.com/trpc-group/trpc-go-cmdline
121-
[cmdline-releases]: https://github.com/trpc-group/trpc-go-cmdline/releases
120+
[trpc-cmdline]: https://github.com/trpc-group/trpc-cmdline
121+
[cmdline-releases]: https://github.com/trpc-group/trpc-cmdline/releases
122122
[helloworld]: /examples/helloworld/
123123
[features]: /examples/features/
124-
[cmdline-doc]: https://github.com/trpc-group/trpc-go-cmdline/tree/main/docs
124+
[cmdline-doc]: https://github.com/trpc-group/trpc-cmdline/tree/main/docs

docs/user_guide/framework_conf.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ We have introduced that the startup of the program initializes the framework by
239239

240240
### Create Configurations through Tools
241241

242-
The framework configuration file can be automatically generated by [trpc-go-cmdline](https://github.com/trpc-group/trpc-go-cmdline) tool. The services defined in the PB file are automatically added to the configuration file.
242+
The framework configuration file can be automatically generated by [trpc-cmdline](https://github.com/trpc-group/trpc-cmdline) tool. The services defined in the PB file are automatically added to the configuration file.
243243

244244
```shell
245245
# generate the stub code and the framework configuration file "trpc_go.yaml" through PB file

docs/user_guide/framework_conf.zh_CN.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ plugins:
236236

237237
### 通过工具创建配置
238238

239-
框架配置文件可以通过 [trpc-go-cmdline](https://github.com/trpc-group/trpc-go-cmdline) 工具生成。配置文件中会自动添加 PB 文件中定义的服务。
239+
框架配置文件可以通过 [trpc-cmdline](https://github.com/trpc-group/trpc-cmdline) 工具生成。配置文件中会自动添加 PB 文件中定义的服务。
240240

241241
```shell
242242
# 通过 PB 文件生成桩代码和框架配置文件 "trpc_go.yaml"

docs/user_guide/server/flatbuffers.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Drawbacks:
2626
![flatbuffers](/.resources/user_guide/server/flatbuffers/flatbuffers.png)
2727

2828
# Example
29-
Firstly, install the latest version of the [trpc-go-cmdline](https://github.com/trpc-group/trpc-go-cmdline) tool.
29+
Firstly, install the latest version of the [trpc-cmdline](https://github.com/trpc-group/trpc-cmdline) tool.
3030

3131
Next, use the tool to generate flatbuffers corresponding stub code, which currently supports single-send and single-receive, server/client streaming, bidirectional streaming, etc.
3232

@@ -38,7 +38,7 @@ First, define an IDL file. Its syntax can be learned from the flatbuffers offici
3838
namespace trpc.testapp.greeter; // Equivalent to the "package" in protobuf.
3939
4040
// Equivalent to the "go_package" statement in protobuf.
41-
// Note: "attribute" is a standard syntax in flatbuffers, and the "go_package=xxx" syntax is a custom support implemented by trpc-go-cmdline.
41+
// Note: "attribute" is a standard syntax in flatbuffers, and the "go_package=xxx" syntax is a custom support implemented by trpc-cmdline.
4242
attribute "go_package=github.com/trpcprotocol/testapp/greeter";
4343
4444
table HelloReply { // "table" is equivalent to "message" in protobuf.
@@ -222,7 +222,7 @@ The load testing environment consisted of two machines with 8 cores, 2.5 GHz CPU
222222
# FAQ
223223
## Q1: How to generate stub code when other files are included in the .fbs file?
224224

225-
Refer to the following usage examples on https://github.com/trpc-group/trpc-go-cmdline/tree/main/testcase/flatbuffers:
225+
Refer to the following usage examples on https://github.com/trpc-group/trpc-cmdline/tree/main/testcase/flatbuffers:
226226

227227
- 2-multi-fb-same-namespace: Multiple .fbs files with the same namespace are in the same directory (namespace in flatbuffers is equivalent to the package statement in protobuf), and one of the main files includes the other .fbs files.
228228
- 3-multi-fb-diff-namespace: Multiple .fbs files are in the same directory with different namespaces. For example, the main file defining RPC references types in different namespaces.

docs/user_guide/server/flatbuffers.zh_CN.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
![flatbuffers](/.resources/user_guide/server/flatbuffers/flatbuffers_zh_CN.png)
2626

2727
# 示例
28-
首先安装最新版本 [trpc-go-cmdline](https://github.com/trpc-group/trpc-go-cmdline) 工具
28+
首先安装最新版本 [trpc-cmdline](https://github.com/trpc-group/trpc-cmdline) 工具
2929

3030
然后使用该工具来生成 flatbuffers 对应的桩代码,目前已经支持单发单收、服务端/客户端流式、双向流式等
3131

@@ -36,7 +36,7 @@
3636
namespace trpc.testapp.greeter; // 相当于 protobuf 中的 package
3737
3838
// 相当于 protobuf 的 go_package 声明
39-
// 注意:attribute 本身是 flatbuffers 的标准语法,里面加 "go_package=xxx" 这种写法则是通过 trpc-go-cmdline 中实现的自定义支持
39+
// 注意:attribute 本身是 flatbuffers 的标准语法,里面加 "go_package=xxx" 这种写法则是通过 trpc-cmdline 中实现的自定义支持
4040
attribute "go_package=github.com/trpcprotocol/testapp/greeter";
4141
4242
table HelloReply { // table 相当于 protobuf 中的 message
@@ -223,7 +223,7 @@ req.Message() // 访问 req 中的 message 字段
223223
# FAQ
224224
## Q1: .fbs 文件中 include 了其他文件,如何生成桩代码?
225225

226-
参考 https://github.com/trpc-group/trpc-go-cmdline/tree/main/testcase/flatbuffers 中的下面几个使用示例:
226+
参考 https://github.com/trpc-group/trpc-cmdline/tree/main/testcase/flatbuffers 中的下面几个使用示例:
227227

228228
- 2-multi-fb-same-namespace: 在同一目录下有多个 .fbs 文件,每个 .fbs 文件的 namespace 都是一样的(flatbuffers 中的 namespace 等同于 protobuf 中的 package 语句),然后其中一个主文件 include 了其他 .fbs 文件
229229
- 3-multi-fb-diff-namespace: 在同一个目录下有多个 .fbs 文件,每个 .fbs 文件的 namespace 不一样,比如定义 RPC 的主文件中引用了不同 namespace 中的类型

0 commit comments

Comments
 (0)