Skip to content

Commit 162deaf

Browse files
committed
Rename doc
1 parent ef154fe commit 162deaf

File tree

5 files changed

+19
-19
lines changed

5 files changed

+19
-19
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
# Created On : <2023-08-28>
1111
# Last Modified : <2025-07-22>
1212
#
13-
# 请阅读 ./doc/01-Develop.md 来使用
13+
# 请阅读 ./doc/01-开发与构建.md 来使用
1414
# --------------------------------------------------------------
1515

1616
#=========== OS Check ================

doc/02-提交与贡献.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
(1)
3636

3737
1. **如果你是 recipe Chef,则你完全负责这个 recipe,如果你拥有写权限,你可以直接推送代码到 `dev` 分支**
38-
2. 如果你是 recipe Cook,则你需要参考 [04-MAINTAINERS.md](./04-MAINTAINERS.md),如果只有你一个人,且你拥有写权限,你可以直接推送代码。如果有多人,则需要提一个 issue,介绍方案,然后 @ 所有 Cook 来 review
38+
2. 如果你是 recipe Cook,则你需要参考 recipe 中记录的 Cook 信息,如果只有你一个人,且你拥有写权限,你可以直接推送代码。如果有多人,则需要提一个 issue,介绍方案,然后 @ 所有 Cook 来 review
3939

4040
---
4141

doc/10-如何编写recipe.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@
5252
- `source`: 该 `target` 所能换的具体的源,由 `mirror` 提供服务,往往一个 `mirror` 会提供许多 `source`
5353
- `recipe`: 是为一个 `target` 定义的具体换源方法,请参考 `src` 目录中的 `recipe` 目录
5454

55-
- **换源 URL**: 指镜像站所提供的某一个具体的换源使用的URL
56-
- **测速 URL**: 用来测速的URL,与 "换源 URL" 不同,可分为 **精准测速****模糊测速**
55+
- **换源链接**: 指镜像站所提供的某一个具体的换源使用的URL
56+
- **测速链接**: 用来测速的URL,与 "换源链接" 不同,可分为 **精准测速****模糊测速**
5757

5858
- **镜像源**: 为了方便,**偶尔**我们将直接称`mirror`和/或`source`**镜像源**,这只是一种方便性的称呼,可以统称二者,也可以根据上下文指代二者之一
5959

@@ -81,7 +81,7 @@
8181

8282
该函数将填充 target 所有的必要信息,包括维护信息、换源信息
8383

84-
7. [设置/修改 "换源 URL" 和 "测速 URL" (how?)](./11-如何修改URL.md)
84+
7. [设置/修改 "换源 URL" 和 "测速 URL" (how?)](./11-如何设置换源链接与测速链接.md)
8585

8686
8. 按需实现 `_setsrc()` `_getsrc()` `_resetsrc()`, 可以使用这些函数:
8787

@@ -93,7 +93,7 @@
9393

9494
9.`recipe/menu.c` 中登记此 target
9595

96-
10. [编译、运行、测试 (how?)](./01-Develop.md),若无问题可提交 Pull Request
96+
10. [编译、运行、测试 (how?)](./01-开发与构建.md),若无问题可提交 Pull Request
9797

9898
<br>
9999

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22
! SPDX-License-Identifier: GFDL-1.3-or-later
33
! -------------------------------------------------------------
44
! Doc Type : Markdown
5-
! Doc Name : 11-如何修改URL.md
5+
! Doc Name : 11-如何设置换源链接与测速链接.md
66
! Doc Authors : Aoran Zeng <[email protected]>
77
! Contributors : Nul None <[email protected]>
88
! |
99
! Created On : <2025-08-11>
1010
! Last Modified : <2025-08-11>
1111
! ---------------------------------------------------------- -->
1212

13-
# 新增/修改换源 URL
13+
# 新增/修改 "换源链接"
1414

15-
`_prelude()` 函数中,在 `def_sources_begin()` 的位置的**第二列**,新增/修改你想要替换的URL
15+
`_prelude()` 函数中,在 `def_sources_begin()` 的位置的**第二列**,新增/修改你想要替换的链接
1616

1717
**注: 以下代码仅起解释作用,JavaScript换源的真正实现可能不同**
1818

@@ -22,19 +22,19 @@ def_sources_begin()
2222
{&NpmMirror, "https://registry.npmmirror.com", FeedByPrelude},
2323
{&Huawei, "https://mirrors.huaweicloud.com/repository/npm/", FeedByPrelude},
2424
{&Tencent, "https://mirrors.cloud.tencent.com/npm/", FeedByPrelude},
25-
{&某新镜像站, "某镜像站提供的换源URL", FeedByPrelude}
25+
{&某新镜像站, "某镜像站提供的换源链接", FeedByPrelude}
2626
def_sources_end()
2727
```
2828
2929
<br>
3030
3131
32-
# 提供精准测速 URL
32+
# 设置/修改 "测速链接"
3333
34-
在 `_prelude()` 函数中,在 `def_sources_begin()` 的位置的**第三列**,新增/修改你想要替换的URL
34+
在 `_prelude()` 函数中,在 `def_sources_begin()` 的位置的**第三列**,设置/修改你想要替换的链接
3535
36-
1. 在下面代码的第一行中,我们直接给了一个链接,**这就是精准测速 URL**
37-
2. 在下面代码的第二行和第三行中,我们都设置了一个宏 `DelegateToMirror`,这意味着我们没有直接提供精准测速 URL,而是让 `chsrc` 去测试其对应镜像站定义的测速 URL
36+
1. 在下面代码的第一行中,我们直接给了一个链接,**这就是精准测速链接**
37+
2. 在下面代码的第二行和第三行中,我们都设置了一个宏 `DelegateToMirror`,这意味着我们没有直接提供精准测速链接,而是让 `chsrc` 去测试其对应镜像站定义的测速链接
3838
3939
- `NpmMirror` 是专用镜像站,所以其测速链接被设置为了 `ACCURATE`,即精准测速
4040
- `Huawei` 是通用镜像站,所以其测速链接被设置为了 `ROUGH `,即模糊测速
@@ -51,13 +51,13 @@ def_sources_begin()
5151
{&Tencent, "https://mirrors.cloud.tencent.com/npm/", FeedByPrelude},
5252
def_sources_end()
5353
54-
// 把所有上述源的测速 URL 设置为 "换源 URL" + postfix
54+
// 把所有上述源的 "测速链接" 设置为 "换源链接" + postfix
5555
chef_set_sources_speed_measure_url_with_postfix (this, "/dir/BigFile.tar.gz");
56-
// 基于 "换源 URL" 做更自定义的操作
56+
// 基于 "换源链接" 做更自定义的操作
5757
chef_set_sources_speed_measure_url_with_func (this, func, data);
5858
59-
// 调整某一个镜像站(Provider)的测速 URL
59+
// 调整某一个镜像站(Provider)的 "测速链接"
6060
chef_set_provider_speed_measure_url (&Tencent, "https://mirrors.cloud.tencent.com/npm/BigFile.tar.gz")
61-
// 调整某一个镜像站(Provider)的测速精度
61+
// 调整某一个镜像站(Provider)的 "测速精度"
6262
chef_set_provider_speed_measure_accuracy (&UpstreamProvider, ROUGH);;
6363
```

doc/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ E2E (End-to-End) 开发文档:
2323
具体 recipe 相关:
2424

2525
- 如何编写一个具体的 recipe,请参考 [10-如何编写recipe.md](./10-如何编写recipe.md)
26-
- 如何修改换源URL、模糊/精准测速URL,请参考 [11-如何修改URL.md](./11-如何修改URL.md)
26+
- 如何修改换源URL、模糊/精准测速URL,请参考 [11-如何设置换源链接与测速链接.md](./11-如何设置换源链接与测速链接.md)
2727

2828
<br>
2929

0 commit comments

Comments
 (0)