Skip to content

Commit 51f9d1b

Browse files
committed
feat(packaging): add component marking guidelines
1 parent ccc213b commit 51f9d1b

File tree

2 files changed

+82
-0
lines changed

2 files changed

+82
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
AOSC OS Component Marking Guidelines
2+
===
3+
4+
The Feature Marking Guidelines is designed to mark key system components that
5+
are not considered `Essential` per dpkg, but could be used as referenced for
6+
management frontends such as oma to inform users of the risks of removing
7+
certain packages (those that might impeded system functions and features, more
8+
below).
9+
10+
With this set of guidelines, users may be better informed about the differences
11+
between system components and applications. This set of guidelines, by
12+
principle, only applies to pre-installed software.
13+
14+
Metadata
15+
---
16+
17+
- Repository- and toolchain-side: Add `X-AOSC-Features` markers to select
18+
packages to indicate the relevant system features (recorded in `control` in
19+
the package and `Packages` in the APT repository).
20+
- Introduce `aosc-os-feature-data` to record names and descriptions of the
21+
system features.
22+
23+
### Example: control and Packages
24+
25+
`X-AOSC-Features` may contain multiple items, separated with space; the name
26+
of the feature items shall only contain letters a-z, numbers and dashes (-):
27+
28+
```
29+
Package: plasma-workspace
30+
...
31+
X-AOSC-Features: kde-graphical-environment multimedia-playback
32+
```
33+
34+
### Example: aosc-os-feature-data
35+
36+
The `Functionality` field may be localised with the `-$LANG` suffix, those
37+
without a suffix will be used as the fallback (C/en_US) for systems set with
38+
languages without the necessary translations:
39+
40+
```
41+
Feature: kde-graphical-environment
42+
Functionality: KDE graphical environment
43+
Functionality-zh_CN: KDE 图形界面
44+
45+
Feature: multimedia-playback
46+
Functionality: Multimedia playback support
47+
Functionality-zh_CN: 多媒体播放
48+
```
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
安同 OS 系统组件标记规范
2+
===
3+
4+
本规范用于标记 Essential 级别以下的关键系统组件,并允许 oma 等前端程序充分告知用户移除相关软件包的风险(即可能影响到的系统功能及特性,详见下文)。实现该功能是为了更直观地让用户了解系统组件及额外应用程序之间的差异,本规范原则上只涉及安同 OS 预装的软件。
5+
6+
元数据更改
7+
---
8+
9+
- 工具链及软件源侧:在 `Packages` 加入 `X-AOSC-Features`,列出相关的系统功能
10+
- 引入 `aosc-os-feature-data` 数据,用于记录系统功能名称及简介
11+
12+
### 样例:control 及 Packages 元数据
13+
14+
`X-AOSC-Features` 可包含多个子项(使用空格分割),名称只允许 a-z、数字及 -:
15+
16+
```
17+
Package: plasma-workspace
18+
...
19+
X-AOSC-Features: kde-graphical-environment multimedia-playback
20+
```
21+
22+
### 样例:aosc-os-feature-data
23+
24+
`Functionality` 条目可本地化,无后缀则匹配 C/en_US(或匹配无对应翻译的系统);后缀以 locale 语言格式(不带编码后缀)为准:
25+
26+
```
27+
Feature: kde-graphical-environment
28+
Functionality: KDE graphical environment
29+
Functionality-zh_CN: KDE 图形界面
30+
31+
Feature: multimedia-playback
32+
Functionality: Multimedia playback support
33+
Functionality-zh_CN: 多媒体播放
34+
```

0 commit comments

Comments
 (0)