|
| 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 | +``` |
0 commit comments