mirror of
https://github.com/RubyMetric/chsrc
synced 2025-08-12 23:27:34 +08:00
Rename doc
This commit is contained in:
Aoran Zeng
parent
ef154fed2b
commit
162deaf807
2
Makefile
2
Makefile
@ -10,7 +10,7 @@
|
||||
# Created On : <2023-08-28>
|
||||
# Last Modified : <2025-07-22>
|
||||
#
|
||||
# 请阅读 ./doc/01-Develop.md 来使用
|
||||
# 请阅读 ./doc/01-开发与构建.md 来使用
|
||||
# --------------------------------------------------------------
|
||||
|
||||
#=========== OS Check ================
|
||||
|
||||
@ -35,7 +35,7 @@
|
||||
（1）
|
||||
|
||||
1. **如果你是 recipe Chef，则你完全负责这个 recipe，如果你拥有写权限，你可以直接推送代码到 `dev` 分支**
|
||||
2. 如果你是 recipe Cook，则你需要参考 [04-MAINTAINERS.md](./04-MAINTAINERS.md)，如果只有你一个人，且你拥有写权限，你可以直接推送代码。如果有多人，则需要提一个 issue，介绍方案，然后 @ 所有 Cook 来 review
|
||||
2. 如果你是 recipe Cook，则你需要参考 recipe 中记录的 Cook 信息，如果只有你一个人，且你拥有写权限，你可以直接推送代码。如果有多人，则需要提一个 issue，介绍方案，然后 @ 所有 Cook 来 review
|
||||
|
||||
---
|
||||
|
||||
|
||||
@ -52,8 +52,8 @@
|
||||
- `source`: 该 `target` 所能换的具体的源，由 `mirror` 提供服务，往往一个 `mirror` 会提供许多 `source`
|
||||
- `recipe`: 是为一个 `target` 定义的具体换源方法，请参考 `src` 目录中的 `recipe` 目录
|
||||
|
||||
- **换源 URL**: 指镜像站所提供的某一个具体的换源使用的URL
|
||||
- **测速 URL**: 用来测速的URL，与 "换源 URL" 不同，可分为 **精准测速** 和 **模糊测速**
|
||||
- **换源链接**: 指镜像站所提供的某一个具体的换源使用的URL
|
||||
- **测速链接**: 用来测速的URL，与 "换源链接" 不同，可分为 **精准测速** 和 **模糊测速**
|
||||
|
||||
- **镜像源**: 为了方便，**偶尔**我们将直接称`mirror`和/或`source`为**镜像源**，这只是一种方便性的称呼，可以统称二者，也可以根据上下文指代二者之一
|
||||
|
||||
@ -81,7 +81,7 @@
|
||||
|
||||
该函数将填充 target 所有的必要信息，包括维护信息、换源信息
|
||||
|
||||
7. [设置/修改 "换源 URL" 和 "测速 URL" (how?)](./11-如何修改URL.md)
|
||||
7. [设置/修改 "换源 URL" 和 "测速 URL" (how?)](./11-如何设置换源链接与测速链接.md)
|
||||
|
||||
8. 按需实现 `_setsrc()` `_getsrc()` `_resetsrc()`， 可以使用这些函数:
|
||||
|
||||
@ -93,7 +93,7 @@
|
||||
|
||||
9. 在 `recipe/menu.c` 中登记此 target
|
||||
|
||||
10. [编译、运行、测试 (how?)](./01-Develop.md)，若无问题可提交 Pull Request
|
||||
10. [编译、运行、测试 (how?)](./01-开发与构建.md)，若无问题可提交 Pull Request
|
||||
|
||||
<br>
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
! SPDX-License-Identifier: GFDL-1.3-or-later
|
||||
! -------------------------------------------------------------
|
||||
! Doc Type : Markdown
|
||||
! Doc Name : 11-如何修改URL.md
|
||||
! Doc Name : 11-如何设置换源链接与测速链接.md
|
||||
! Doc Authors : Aoran Zeng <ccmywish@qq.com>
|
||||
! Contributors : Nul None <nul@none.org>
|
||||
! |
|
||||
@ -10,9 +10,9 @@
|
||||
! Last Modified : <2025-08-11>
|
||||
! ---------------------------------------------------------- -->
|
||||
|
||||
# 新增/修改换源 URL
|
||||
# 新增/修改 "换源链接"
|
||||
|
||||
在 `_prelude()` 函数中，在 `def_sources_begin()` 的位置的**第二列**，新增/修改你想要替换的URL。
|
||||
在 `_prelude()` 函数中，在 `def_sources_begin()` 的位置的**第二列**，新增/修改你想要替换的链接。
|
||||
|
||||
**注: 以下代码仅起解释作用，JavaScript换源的真正实现可能不同**
|
||||
|
||||
@ -22,19 +22,19 @@ def_sources_begin()
|
||||
{&NpmMirror, "https://registry.npmmirror.com", FeedByPrelude},
|
||||
{&Huawei, "https://mirrors.huaweicloud.com/repository/npm/", FeedByPrelude},
|
||||
{&Tencent, "https://mirrors.cloud.tencent.com/npm/", FeedByPrelude},
|
||||
{&某新镜像站, "某镜像站提供的换源URL"， FeedByPrelude}
|
||||
{&某新镜像站, "某镜像站提供的换源链接"， FeedByPrelude}
|
||||
def_sources_end()
|
||||
```
|
||||
|
||||
<br>
|
||||
|
||||
|
||||
# 提供精准测速 URL
|
||||
# 设置/修改 "测速链接"
|
||||
|
||||
在 `_prelude()` 函数中，在 `def_sources_begin()` 的位置的**第三列**，新增/修改你想要替换的URL。
|
||||
在 `_prelude()` 函数中，在 `def_sources_begin()` 的位置的**第三列**，设置/修改你想要替换的链接。
|
||||
|
||||
1. 在下面代码的第一行中，我们直接给了一个链接，**这就是精准测速 URL**
|
||||
2. 在下面代码的第二行和第三行中，我们都设置了一个宏 `DelegateToMirror`，这意味着我们没有直接提供精准测速 URL，而是让 `chsrc` 去测试其对应镜像站定义的测速 URL
|
||||
1. 在下面代码的第一行中，我们直接给了一个链接，**这就是精准测速链接**
|
||||
2. 在下面代码的第二行和第三行中，我们都设置了一个宏 `DelegateToMirror`，这意味着我们没有直接提供精准测速链接，而是让 `chsrc` 去测试其对应镜像站定义的测速链接
|
||||
|
||||
- `NpmMirror` 是专用镜像站，所以其测速链接被设置为了 `ACCURATE`，即精准测速
|
||||
- `Huawei` 是通用镜像站，所以其测速链接被设置为了 `ROUGH `，即模糊测速
|
||||
@ -51,13 +51,13 @@ def_sources_begin()
|
||||
{&Tencent, "https://mirrors.cloud.tencent.com/npm/", FeedByPrelude},
|
||||
def_sources_end()
|
||||
|
||||
// 把所有上述源的测速 URL 设置为 "换源 URL" + postfix
|
||||
// 把所有上述源的 "测速链接" 设置为 "换源链接" + postfix
|
||||
chef_set_sources_speed_measure_url_with_postfix (this, "/dir/BigFile.tar.gz");
|
||||
// 基于 "换源 URL" 做更自定义的操作
|
||||
// 基于 "换源链接" 做更自定义的操作
|
||||
chef_set_sources_speed_measure_url_with_func (this, func, data);
|
||||
|
||||
// 调整某一个镜像站(Provider)的测速 URL
|
||||
// 调整某一个镜像站(Provider)的 "测速链接"
|
||||
chef_set_provider_speed_measure_url (&Tencent, "https://mirrors.cloud.tencent.com/npm/BigFile.tar.gz")
|
||||
// 调整某一个镜像站(Provider)的测速精度
|
||||
// 调整某一个镜像站(Provider)的 "测速精度"
|
||||
chef_set_provider_speed_measure_accuracy (&UpstreamProvider, ROUGH);;
|
||||
```
|
||||
@ -23,7 +23,7 @@ E2E (End-to-End) 开发文档:
|
||||
具体 recipe 相关:
|
||||
|
||||
- 如何编写一个具体的 recipe，请参考 [10-如何编写recipe.md](./10-如何编写recipe.md)
|
||||
- 如何修改换源URL、模糊/精准测速URL，请参考 [11-如何修改URL.md](./11-如何修改URL.md)
|
||||
- 如何修改换源URL、模糊/精准测速URL，请参考 [11-如何设置换源链接与测速链接.md](./11-如何设置换源链接与测速链接.md)
|
||||
|
||||
<br>
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user