genisolist.ini 格式有关文档、参考实现与公用配置。
genisolist 用于生成文件下载列表，输出在处理后会用在镜像站以及 MirrorZ 网页端以下地方：
-
镜像站的「获取下载链接」/「获取安装镜像」等页面：
-
MirrorZ 格式中的
info字段。根据镜像站提供的数据，渲染效果如下图：
genisolist.ini 的格式类似于 INI，但是包含 !include 标记，用于引入其他文件。参考例子 example.ini。
# %main% contains mirror site specific settings
[%main%]
root = /tmp/genisolist/
urlbase = /
!include includes/distro.ini
!include includes/os/archlinux.ini
!include includes/app/vlc.ini
!include includes/app/github/rust-analyzer.ini
!include includes/font/adobe_source.ini!include 后的路径如果是相对路径，则是相对于该 ini 文件的路径。
在 !include 被处理后，其是一个与 Python 的 configparser 模块兼容的 INI 格式的配置文件。特别地，由于 INI 格式未规定布尔值，下文中的「布尔值」指代转换为小写后值为 true 或 false 的字符串，其他的值的行为未定义。
INI 格式由多个 section 组成，其中 genisolist.ini 中以 % 开头的 section 为特殊 section，目前定义的特殊 section 如下：
%main%：存储镜像站的特定配置，目前包含root（镜像根目录，默认为当前工作目录）和urlbase（镜像站 URL 前缀，默认为/）。%distro%（可选）：存储发行版排序的权重。可参考 ./includes/distro.ini。早先的版本中这一部分的内容在%main%中。
其他以 % 开头的 section 会被忽略，在新版本的 genisolist 中可能会添加其他的特殊 section。
其他的 section 用于表示展示内容与文件匹配规则，section 的名称（即方括号内的内容）会被忽略，重复的 section 名称出现时的行为未定义。Section 中必须包含以下的字段：
distro：显示名称（发行版名称、软件名称、字体名称等）。允许多个 section 使用相同的显示名称，最终显示时会合并。- 单个
location或一组location_{0..N-1}（N 为数字，从 0 开始）：文件路径匹配的通配符（glob）规则，在参考实现中使用pathlib.Path.glob处理。生成器会根据root与location获取可能匹配的文件列表。 pattern：文件路径正则表达式规则。路径不匹配的文件会被忽略。可以使用可选字段中的pattern_use_name切换为使用文件名（而非路径）匹配。正则表达式中允许使用捕获组特性（即使用括号包裹的部分），被捕获的部分可以在version、type、platform、key_by、sort_by中使用。与其他软件类似，$0代表整个匹配的字符串，$1代表第一个捕获组，以此类推。不存在的匹配组以空字符串处理。可以在 https://regex101.com/ 测试正则表达式行为。
以下是可选字段。其中一个 section 可以由 key_by 字段划分为多个 group（默认整个 section 为一个 group），每个 group 内部稳定排序之后，能够输出的文件数量受到 listvers 限制。最后所有相同 distro 的 group 合并之后再次稳定排序。
-
listvers：每个分组内部版本列出的文件数量，默认为 255 个。 -
version：版本号信息。脚本会尝试使用符合版本语义的方式比较不同的版本号。 -
type：文件类型，默认为空，应对version与platform字段无法覆盖的情况。 -
platform：平台信息。脚本会根据平台的优先级（常见以及重要程度）对不同平台、相同版本的文件排序。 -
category：分类，默认为os，如果对应的文件为软件或者字体，则需要设置为app或font。 -
key_by：Section 内子分组关键字，默认不分组（整个分为一组）。 -
sort_by：（逆序稳定）排序关键字，覆盖默认的排序规则。默认排序规则为按照以下值作为排序关键字逆序稳定排序：[ LooseVersion(file_item["version"]), get_platform_priority(file_item["platform"]), file_item["type"], ]sort_by中的捕获组应被空白符分割。 -
pattern_use_name：布尔值。默认为false。如果为true，则 pattern 的正则表达式规则只使用文件名，而非整个文件路径进行正则匹配。
被弃用的字段：
nosort：使用sort_by字段设置为常量字符串代替（排序操作仍会进行，由于排序是逆序的，最终的列表会反过来）。
输出为 JSON，例如下：
[
{
"distro": "archlinux",
"category": "os",
"urls": [
{
"name": "2024.05.01 (x86_64, CLI-only)",
"url": "/archlinux/iso/latest/archlinux-2024.05.01-x86_64.iso"
}
]
}
]其中的 name 字段，如果对应的文件有 platform 字段，那么格式为 %s (%s%s)：
- 第一个
%s为version字段； - 第二个
%s为platform字段； - 第三个
%s为type字段，格式为, {type}，如果为空则不显示。
如果没有 platform 字段，那么值为 version 字段。
项目提供了 utils/check-config.py 检查配置文件的正确性。使用方法如：
python3 utils/check-config.py includes/如果参数是目录，则脚本会遍历目录下所有的 ini 文件，逐个尝试进行解析和检查；如果是单个文件，则只检查该文件。
includes 目录存储公用的配置文件，目前分为三类：
其中类别下名为 github 的文件夹对应 github-release 收录的软件对应的配置，文件名为对应仓库的所有者（组织）。
genisolist.py 为参考实现，用于从配置与本地文件系统输出以上的 JSON 格式。可以使用其 process_ini() 和 gen_from_sections() 用于整合镜像站点的其他设施，也可以直接运行，例如下：
$ DEBUG=1 python genisolist.py example.ini
DEBUG:__main__:Location: archlinux/iso/latest/archlinux-*.iso
DEBUG:__main__:File: archlinux/iso/latest/archlinux-2024.05.01-x86_64.iso
DEBUG:__main__:Matched: ('2024.05.01', 'x86_64')
DEBUG:__main__:File item: {'path': 'archlinux/iso/latest/archlinux-2024.05.01-x86_64.iso', 'category': 'os', 'distro': 'Arch Linux', 'version': '2024.05.01', 'type': 'CLI-only', 'platform': 'x86_64', 'sort_weight': (LooseVersion ('2024.05.01'), 100, 'CLI-only')}
DEBUG:__main__:File: archlinux/iso/latest/archlinux-x86_64.iso
DEBUG:__main__:Not matched: /tmp/genisolist/archlinux/iso/latest/archlinux-x86_64.iso
DEBUG:__main__:Location: videolan-ftp/vlc/*/*/*
DEBUG:__main__:Location: videolan-ftp/vlc/*/*/*
DEBUG:__main__:Location: videolan-ftp/vlc-android/*/*
DEBUG:__main__:Location: videolan-ftp/vlc-iOS/*/*
DEBUG:__main__:Location: github-release/googlefonts/*/*/*
DEBUG:__main__:Location: github-release/googlefonts/noto-cjk/LatestRelease/*
DEBUG:__main__:Location: github-release/googlefonts/noto-emoji/LatestRelease/*
DEBUG:__main__:Location: github-release/googlefonts/noto-fonts/LatestRelease/*
[{"distro": "Arch Linux", "category": "os", "urls": [{"name": "2024.05.01 (x86_64, CLI-only)", "url": "/archlinux/iso/latest/archlinux-2024.05.01-x86_64.iso"}]}]输出为 JSON 格式的字符串，可以使用 jq 等工具做后续处理。对于本地测试，可以使用 utils/rsync-stub-generator.py 从镜像站获取文件，并在本地生成一致的目录结构：
python utils/rsync-stub-generator.py rsync://rsync.mirrors.ustc.edu.cn/archlinux --dist /tmp/genisolist/archlinux对于镜像站点，推荐使用 git submodule 的方式引入本仓库：
-
添加 submodule：
git submodule add https://github.com/mirrorz-org/genisolist.git mirrorz-genisolist
-
首次使用：
git submodule update --init --recursive
-
在有需要时更新版本：
git submodule update --recursive --remote
同时镜像站点自行维护最外层的 ini 配置文件，假设在仓库根目录下的 genisolist.ini：
[%main%]
root = /data/
urlbase = /
# 导入 mirrorz/genisolist 的子配置
!include mirrorz-genisolist/includes/distro.ini
!include mirrorz-genisolist/includes/os/archlinux.ini
!include mirrorz-genisolist/includes/app/vlc.ini
!include mirrorz-genisolist/includes/app/github/rust-analyzer.ini
!include mirrorz-genisolist/includes/font/adobe_source.ini
# 导入镜像站自己维护的子配置
!include genisolist/os/example.ini
# 镜像站也可以直接写 section
[some-distro]
distro = Some Distro
# ...
