feat(developer): add DeployKit quirk configuration format specification

Author: MingcongBai

content/developer/deploykit-quirks.md

@@ -0,0 +1,68 @@
++++
+title = "DeployKit: Device-specific Quirks"
+description = ""
++++
+
+# Format Description
+
+A quirk configuration is written in TOML, in the following format:
+
+```toml
+[model]
+# Two modes of operation:
+#
+# - dmi：Match by DMI (modalias, or model alias), useful for model matching.
+# - path：Match by path, usually ones found in sysfs.
+type = [dmi|path]
+
+# path_pattern/dmi_pattern may not be specified at the same time.
+
+# Match by path - does a path exist (usually in sysfs)? Wildcards are allowed.
+#
+# For example, to match an LEFI-based platform.
+#
+# The following must be specified if type = path.
+path_pattern = "/sys/firmware/lefi"
+
+# Match by DMI - taken from /sys/class/dmi/id/modalias, wildcards are allowed.
+#
+# For instance, the modalias for Loongson XA61200:
+#
+#   dmi:bvnLoongson:bvrLoongson-UDK2018-V4.0.05756-prestable202405:bd05/23/24145323:svnLoongson:pnLoongson-3A6000-HV-7A2000-1w-V0.1-EVB:pvrToBeFilledByO.E.M:rvnToBeFilledByO.E.M:rnLoongson-3A6000-HV-7A2000-1w-EVB-V1.21:rvrToBeFilledByO.E.M:cvnLoongson:ct3:cvrToBeFilledByO.E.M:skuToBeFilledByO.E.M:
+#
+# The following will match the motherboard/series:
+#
+#   dmi:*svnLoongson:*pnLoongson-3A6000-HV-7A2000-1w-V0.1-EVB:*
+#
+# And the following will match a specific motherboard revision:
+#
+#   dmi:*svnLoongson:*rnLoongson-3A6000-HV-7A2000-1w-EVB-V1.21:*
+#
+# The following must be specified if type = dmi
+dmi_pattern = "dmi:*svnLoongson:*rnLoongson-3A6000-HV-7A2000-1w-EVB-V1.21:*"
+
+[quirk]
+# A command to execute for the quirk. The command to launch must have its
+# executable bit set (and the correct shebang specified, if it is a script).
+command = "/usr/share/deploykit-backend/quirks/loongson-xa61200/quirk.bash"
+
+# Skip one or multiple stages, useful for platforms that may not be capable
+# of runnning certain installation procedures.
+#
+# Refer to deploykit-backend, specifically the `enum InstallationStage' in
+# install/src/lib.rs for a list of installation stages.
+#
+# Optional. The following example skips GRUB installation and SSH keygen.
+skip_stages = ["InstallGrub", "GenerateSshKey"]
+
+```
+
+# File Placement
+
+Quirks should be placed under `/usr/share/deploykit-backend/quirks` and organised by a single-level subdirectory:
+
+```
+- /usr/share/deploykit-backend/quirks
+    - ./loongson-xa61200                    # Model
+        - ./quirk.toml                      # Quirk Configuration
+```

content/developer/deploykit-quirks.zh.md

@@ -0,0 +1,66 @@
++++
+title = "DeployKit 机型规避数据格式"
+description = ""
++++
+
+# 格式说明
+
+规避配置使用 TOML 格式编写，内容如下：
+
+```toml
+[model]
+# 两种匹配方式：
+#
+# - dmi：使用 DMI 信息进行匹配，此处指的是 modalias - 机型别名，一般足够判定
+#        机型级别的规避
+# - path：使用系统路径特征，尤其是 sysfs 虚拟文件系统中的文件特征进行判断
+type = [dmi|path]
+
+# 下列 path_pattern/dmi_pattern 不可同时指定
+
+# 匹配某个路径是否存在（一般为 sysfs 下的虚拟文件），可使用通配符
+#
+# 下例匹配 LEFI 设备
+#
+# 如指定 type = path 则此项必填
+path_pattern = "/sys/firmware/lefi"
+
+# 匹配 DMI 信息，使用 /sys/class/dmi/id/modalias 内容，可使用通配符
+#
+# 例如 Loongson XA61200 的 modalias 内容为：
+#
+#   dmi:bvnLoongson:bvrLoongson-UDK2018-V4.0.05756-prestable202405:bd05/23/24145323:svnLoongson:pnLoongson-3A6000-HV-7A2000-1w-V0.1-EVB:pvrToBeFilledByO.E.M:rvnToBeFilledByO.E.M:rnLoongson-3A6000-HV-7A2000-1w-EVB-V1.21:rvrToBeFilledByO.E.M:cvnLoongson:ct3:cvrToBeFilledByO.E.M:skuToBeFilledByO.E.M:
+#
+# 此处可匹配板型：
+#
+#   dmi:*svnLoongson:*pnLoongson-3A6000-HV-7A2000-1w-V0.1-EVB:*
+#
+# 抑或具体的主板版本
+#
+#   dmi:*svnLoongson:*rnLoongson-3A6000-HV-7A2000-1w-EVB-V1.21:*
+#
+# 如指定 type = dmi 则此项必填
+dmi_pattern = "dmi:*svnLoongson:*rnLoongson-3A6000-HV-7A2000-1w-EVB-V1.21:*"
+
+[quirk]
+# 执行规避命令，预期命令已设置有执行位（如命令为脚本则须正确定义 shebang）
+command = "/usr/share/deploykit-backend/quirks/loongson-xa61200/quirk.bash"
+
+# 跳过某个或多个步骤，用于处理已知无法完成的步骤（数组形式）
+#
+# 查阅 deploykit-backend: install/src/lib.rs 中的 enum InstallationStage 即可
+# 获取步骤列表
+#
+# 此项选填；下例为跳过 GRUB 安装及 SSH 密钥生成
+skip_stages = ["InstallGrub", "GenerateSshKey"]
+```
+
+# 文件摆放
+
+规避配置应放置在 `/usr/share/deploykit-backend/quirks` 路径下，并以单级子目录进行分类：
+
+```
+- /usr/share/deploykit-backend/quirks
+    - ./loongson-xa61200                    # 机型
+        - ./quirk.toml                      # 规避配置
+```