Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename apps directory to tools. #100

Merged
merged 1 commit into from
Dec 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ cmake = "0.1"
crate-type = ["lib", "staticlib"]

[workspace]
members = ["apps"]
members = ["tools"]

[[bench]]
name = "timer_queue"
Expand Down
2 changes: 1 addition & 1 deletion interop/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
13 changes: 10 additions & 3 deletions apps/Cargo.toml → tools/Cargo.toml
Original file line number Diff line number Diff line change
@@ -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"
Expand All @@ -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"]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion website/docs/further_readings/benchmark.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion website/docs/how_to_contribute/development_guides.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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)作为压测客户端,它具有非常灵活的参数,并支持使用多个线程来增加请求压力。


### 测试场景
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ TQUIC项目的顶级目录如下:
| 目录 | 说明 |
| --------- | ----------- |
| src/ | TQUIC实现 |
| apps/ | TQUIC示例工具 |
| tools/ | TQUIC示例工具 |
| benches/ | 基准测试 |
| fuzz/ | 模糊测试 |
| interop/ | 互操作性测试 |
Expand Down
Loading