Skip to content

Commit deb2da1

Browse files
committed
fix(package-styling-manual): make automatic mirroring URL guidelines universal
1 parent 398ef74 commit deb2da1

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

content/developer/packaging/package-styling-manual.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,8 @@ The `SRCS=`, or `$SRCS` variable is used to indicate a list of source file(s) us
9292
|-------------|----------------------------------------|---------------------------------|
9393
| Version substitutions | Required | Source links must replace all versions with substitutions from the `$VER` variable (see above). `SRCS=` must not be defined with hard-coded version(s). |
9494
| Versioned tarballs | Required | Source archives (tarballs) must be versioned in order to ensure consistency. |
95-
| SourceForge releases | Required | Follow [official guidelines](https://sourceforge.net/p/forge/documentation/Downloading%20files%20via%20the%20command%20line/) and include the `/download` suffix in the URL, i.e. `tbl::https://sourceforge.net/projects/wqy/files/wqy-microhei/${UPSTREAM_VER}/wqy-microhei-${UPSTREAM_VER}.tar.gz/download"`; use the aforementioned automatic redirection URL whenever possible and avoid using any one of the mirrors. |
95+
| Tarball origins | Required | Use the upstream-supplied mirroring/automatic redirection URLs whenever possible and avoid using any one of the mirrors. |
96+
| SourceForge releases | Required | Follow [official guidelines](https://sourceforge.net/p/forge/documentation/Downloading%20files%20via%20the%20command%20line/) and include the `/download` suffix in the URL, i.e. `tbl::https://sourceforge.net/projects/wqy/files/wqy-microhei/${UPSTREAM_VER}/wqy-microhei-${UPSTREAM_VER}.tar.gz/download"` |
9697
| URI schemes | Recommended | Use Hypertext Transfer Protocol Secure (HTTPS, https://) where possible. Avoid non-secure connections (http://) and plain FTP (File Transfer Protocol, ftp://). |
9798
| Source format | Recommended | Use XZ-compressed Tar-Archives (.tar.xz) where possible, other formats are considered appropriate. Avoid the inefficient BZip2-compressed Tar-Archives (.tar.bz2) where possible. |
9899
| Platform-generated tarballs | Disallowed | You should not use generated tarballs from various platforms, especially those from GitHub and GitLab, which were known to be re-generated over time, altering checksums. Use `git::` sources with the `commit=tags/...` option instead. |

content/developer/packaging/package-styling-manual.zh.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,8 @@ Executed Packager <[email protected]>
9393
|-------------|----------------------------------------|---------------------------------|
9494
| 版本替换 | 要求 | 源码包地址中的所有软件包版本号必须替换为 `$VER` 变量。`$SRCS` 条目不应含有硬编码的版本号 |
9595
| 源码包版本号 | 要求 | 为了保证可持续性,源码包文件必须要有版本号 |
96-
| SourceForge 源码包 | 要求 | 遵从[官方指引](https://sourceforge.net/p/forge/documentation/Downloading%20files%20via%20the%20command%20line/),在源码 URL 末尾保留 `/download`,如:`tbl::https://sourceforge.net/projects/wqy/files/wqy-microhei/${UPSTREAM_VER}/wqy-microhei-${UPSTREAM_VER}.tar.gz/download"`;在可能的情况下尽可能使用官方推荐的源站或自动重定向设施,避免使用特定镜像站 |
96+
| 源码包来源 | 要求 | 在可能的情况下尽可能使用官方推荐的源站或自动重定向设施,避免使用特定镜像站 |
97+
| SourceForge 源码包 | 要求 | 遵从[官方指引](https://sourceforge.net/p/forge/documentation/Downloading%20files%20via%20the%20command%20line/),在源码 URL 末尾保留 `/download`,如:`tbl::https://sourceforge.net/projects/wqy/files/wqy-microhei/${UPSTREAM_VER}/wqy-microhei-${UPSTREAM_VER}.tar.gz/download"` |
9798
| 统一资源标识符 | 建议 | 尽可能使用 HTTPS(`https://`),避免使用 HTTP(`http://`)和 FTP(`ftp://`|
9899
| 源码包格式 | 建议 | 尽可能使用基于 XZ 压缩方案的压缩包(`.tar.xz`),其它格式也可接受,但尽量避免基于 BZip2 压缩方案的压缩包(`.tar.bz2`|
99100
| 平台自动生成的源码包 | 禁用 | 请勿使用各类托管平台(尤其是 GitHub 和 GitLab)自动生成的源码包,因为这些平台往往会重新生成源码包,导致校验值发生变化;请使用 `git::` 源码类型搭配 `commit=tags/...` 参数使用 |

0 commit comments

Comments
 (0)