Skip to content

Commit 58836a6

Browse files
committed
feat(package-styling-manual): add notes about API/developer documentation
1 parent 5cde61b commit 58836a6

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,7 @@ When packaging for AOSC OS, please work in accordance to our [distribution featu
175175
| Splitting packages | Packages are to be remained intact, unless package comes in multiple flavours, or otherwise agreed upon by the developer majority. |
176176
| Telemetry | All telemetry functionalities must be stripped or disabled by default (opt-in), packages that do not function without such feature should only be accepted on a case-by-case basis (rejected by default). |
177177
| Update checking | All update checking (notification, downloading, etc.) functionalities must be stripped, packages that do not function without such feature should only be accepted on a case-by-case basis (rejected by default). |
178+
| API and development documentation | Unless needed by an application's integrated feature (e.g., Qt Creator), gtk-doc, API (HTML, PDF, etc.), and Doxygen documentation should not be installed. |
178179

179180
# Scripting
180181

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,8 @@ SUBDIR=.
172172
| 功能与特性 | 启用所有功能,除非某个功能未被维护,或违反了此表中的任何其他注意事项 |
173173
| 语言包 | 语言包必须与主要的可执行文件放置在同一个软件包中 |
174174
| 分包 | 除非某个软件有多个派生,或者得到大多数开发者的同意,否则不能拆分软件包 |
175-
| 遥测 | 默认情况下,必须删除或禁用所有遥测功能,非特殊情况不接受无法删除或禁用遥测功能的软件包
175+
| 遥测 | 默认情况下,必须删除或禁用所有遥测功能,非特殊情况不接受无法删除或禁用遥测功能的软件包 |
176+
| API 及开发者文档 | 除有具体软件内置功能需要(如 Qt Creator),原则上不默认安装 gtk-doc、API(HTML, PDF 等)、Doxygen 文档 |
176177

177178
# 脚本编写
178179

0 commit comments

Comments
 (0)