Rename tquic_apps to tquic_tools (#100)

Tencent · Dec 15, 2023 · 2b5b83a · 2b5b83a
1 parent 73fbc6e
commit 2b5b83a
Show file tree

Hide file tree

Showing 11 changed files with 25 additions and 18 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -68,7 +68,7 @@ cmake = "0.1"
 crate-type = ["lib", "staticlib"]
 
 [workspace]
-members = ["apps"]
+members = ["tools"]
 
 [[bench]]
 name = "timer_queue"

diff --git a/interop/Dockerfile b/interop/Dockerfile
@@ -23,7 +23,7 @@ COPY . ./
 
 RUN apt-get update && apt-get install -y cmake && rm -rf /var/lib/apt/lists/*
 
-RUN cargo build --release --manifest-path apps/Cargo.toml
+RUN cargo build --release --manifest-path tools/Cargo.toml
 
 
 FROM martenseemann/quic-network-simulator-endpoint:latest as tquic-interop

diff --git a/src/lib.rs b/src/lib.rs
@@ -38,7 +38,7 @@
 //! ## Get started
 //!
 //! See the [documents](https://tquic.net/docs/category/getting-started) and
-//! [examples](https://github.com/tencent/tquic/tree/master/apps/) to get
+//! [examples](https://github.com/tencent/tquic/tree/master/tools/) to get
 //! started with TQUIC.
 //!
 //! ## Feature flags

diff --git a/apps/Cargo.toml → tools/Cargo.toml b/apps/Cargo.toml → tools/Cargo.toml
@@ -1,7 +1,14 @@
 [package]
-name = "tquic_apps"
-version = "0.1.0"
+name = "tquic_tools"
+version = "0.3.0"
 edition = "2021"
+rust-version = "1.70.0"
+license = "Apache-2.0"
+repository = "https://github.com/tencent/tquic"
+homepage = "https://tquic.net"
+description = "TQUIC client and server tools"
+keywords = ["quic"]
+categories = ["network-programming"]
 
 [dependencies]
 bytes = "1"
@@ -15,7 +22,7 @@ slab = "0.4"
 rand = "0.8.5"
 statrs = "0.16"
 tikv-jemallocator = "0.5"
-tquic = { path = ".." }
+tquic = { path = "..", version = "0.3.0"}
 
 [lib]
 crate-type = ["lib"]

diff --git a/apps/src/bin/tquic_client.rs → tools/src/bin/tquic_client.rs b/apps/src/bin/tquic_client.rs → tools/src/bin/tquic_client.rs
@@ -62,10 +62,10 @@ use tquic::PacketInfo;
 use tquic::TlsConfig;
 use tquic::TransportHandler;
 use tquic::TIMER_GRANULARITY;
-use tquic_apps::alpns;
-use tquic_apps::AppProto;
-use tquic_apps::QuicSocket;
-use tquic_apps::Result;
+use tquic_tools::alpns;
+use tquic_tools::AppProto;
+use tquic_tools::QuicSocket;
+use tquic_tools::Result;
 
 #[global_allocator]
 static GLOBAL: tikv_jemallocator::Jemalloc = tikv_jemallocator::Jemalloc;

diff --git a/apps/src/bin/tquic_server.rs → tools/src/bin/tquic_server.rs b/apps/src/bin/tquic_server.rs → tools/src/bin/tquic_server.rs
@@ -43,10 +43,10 @@ use tquic::PacketInfo;
 use tquic::TlsConfig;
 use tquic::TransportHandler;
 use tquic::TIMER_GRANULARITY;
-use tquic_apps::alpns;
-use tquic_apps::AppProto;
-use tquic_apps::QuicSocket;
-use tquic_apps::Result;
+use tquic_tools::alpns;
+use tquic_tools::AppProto;
+use tquic_tools::QuicSocket;
+use tquic_tools::Result;
 
 #[global_allocator]
 static GLOBAL: tikv_jemallocator::Jemalloc = tikv_jemallocator::Jemalloc;

diff --git a/apps/src/common.rs → tools/src/common.rs b/apps/src/common.rs → tools/src/common.rs
diff --git a/website/docs/further_readings/benchmark.md b/website/docs/further_readings/benchmark.md
@@ -35,7 +35,7 @@ The application logic of each server program is simplified to reflect the actual
 Each server program is compiled in release mode and configured to run in single-thread mode. For detailed configuration parameters, please refer to the [Appendix](benchmark.md#appendix).
 
 
-**Client-side Setup**: The [TQUIC client](https://github.com/tencent/tquic/apps/src/bin/client.rs) is used as a stress testing tool due to its highly flexible parameters, and support for multiple threads, which helps increase the pressure to a test server.
+**Client-side Setup**: The [TQUIC client](https://github.com/tencent/tquic/tools/src/bin/tquic_client.rs) is used as a stress testing tool due to its highly flexible parameters, and support for multiple threads, which helps increase the pressure to a test server.
 
 
 ### Scenarios tested

diff --git a/website/docs/how_to_contribute/development_guides.md b/website/docs/how_to_contribute/development_guides.md
@@ -13,7 +13,7 @@ The top directories are as followings:
 | Directory | Description |
 | --------- | ----------- |
 | src/       | TQUIC implementation |
-| apps/      | TQUIC Example tools |
+| tools/      | TQUIC Example tools |
 | benches/   | Benchmark tests |
 | fuzz/      | Fuzzing tests |
 | interop/   | Interoperability testing |

diff --git a/...te/i18n/zh/docusaurus-plugin-content-docs/current/further_readings/benchmark.md b/...te/i18n/zh/docusaurus-plugin-content-docs/current/further_readings/benchmark.md
@@ -36,7 +36,7 @@ sidebar_position: 2
 各服务端程序编译时使用发布模式，并配置为采用单线程模式运行，具体配置参数参见[附录](benchmark.md#appendix)。
 
 
-**客户端**：我们使用TQUIC[客户端](https://github.com/tencent/tquic/apps/src/bin/client.rs)作为压测客户端，它具有非常灵活的参数，并支持使用多个线程来增加请求压力。
+**客户端**：我们使用TQUIC[客户端](https://github.com/tencent/tquic/tools/src/bin/tquic_client.rs)作为压测客户端，它具有非常灵活的参数，并支持使用多个线程来增加请求压力。
 
 
 ### 测试场景

diff --git a/.../docusaurus-plugin-content-docs/current/how_to_contribute/development_guides.md b/.../docusaurus-plugin-content-docs/current/how_to_contribute/development_guides.md
@@ -13,7 +13,7 @@ TQUIC项目的顶级目录如下:
 | 目录 | 说明 |
 | --------- | ----------- |
 | src/       | TQUIC实现 |
-| apps/      | TQUIC示例工具 |
+| tools/      | TQUIC示例工具 |
 | benches/   | 基准测试 |
 | fuzz/      | 模糊测试 |
 | interop/   | 互操作性测试 |