diff --git a/.gitignore b/.gitignore index 02032c2ca..f8d7ba399 100644 --- a/.gitignore +++ b/.gitignore @@ -67,7 +67,7 @@ instance/ # Documentation public -docs/deviceinfo-reference.md +docs/packaging/device-packages/deviceinfo-reference.md # PyBuilder target/ diff --git a/docs/conf.py b/docs/conf.py index 656374a33..d2061e3fd 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -31,14 +31,25 @@ html_title = "postmarketOS Packaging" redirects = { "approval-rules": "merge-requests/approval-rules.html", "ci-tags": "ci/ci-tags.html", + "device-categorization": "packaging/device-categorization.html", + "deviceinfo-reference": "packaging/device-packages/deviceinfo-reference.html", + "firmware": "packaging/firmware-packages.html", + "generic-device-packages": "packaging/device-packages/generic-device-packages.html", + "generic-kernels": "packaging/kernel-packages/generic-kernel-packages.html", "hardware-ci": "ci/hardware-ci.html", + "kconfig-fragments": "packaging/kernel-packages/kconfig-fragments.html", + "kconfigcheck": "packaging/kernel-packages/kconfigcheck.html", + "kernel-cmdline": "packaging/kernel-packages/kernel-cmdline.html", + "kernel-versions": "packaging/kernel-packages/kernel-versions.html", + "packaging-guidelines": "packaging.html", "releases/backporting": "merge-requests/stable-branches.html", + "ui-packages": "packaging/ui-packages.html", } def run_dint_doc(app): docs_dir = Path(__file__).parent - with docs_dir.joinpath("deviceinfo-reference.md").open("w") as f: + with docs_dir.joinpath("packaging/device-packages/deviceinfo-reference.md").open("w") as f: schema_path = docs_dir.parent / "deviceinfo_schema.toml" subprocess.run(["dint", "doc"], stdout=f, check=True, env={"DINT_SCHEMA_PATH": schema_path}) diff --git a/docs/index.md b/docs/index.md index d096a4f77..60c043486 100644 --- a/docs/index.md +++ b/docs/index.md @@ -15,16 +15,6 @@ in pmaports and the processes around device categorization. releases merge-requests - device-categorization - deviceinfo-reference ci - firmware - generic-device-packages - generic-kernels - kconfig-fragments - kconfigcheck - kernel-cmdline - kernel-versions - packaging-guidelines - ui-packages + packaging ``` diff --git a/docs/merge-requests/approval-rules.md b/docs/merge-requests/approval-rules.md index 227d75070..4ff704752 100644 --- a/docs/merge-requests/approval-rules.md +++ b/docs/merge-requests/approval-rules.md @@ -33,12 +33,12 @@ The following flowchart describes the process: ## Move device from category Moving devices from category is a special operation, see -[device categorization](../device-categorization). +[device categorization](../packaging/device-categorization). ## Changing kconfigcheck requirements Changes to `kconfigcheck.toml` are a special operation, see -[kconfigcheck](../kconfigcheck). +[kconfigcheck](../packaging/kernel-packages/kconfigcheck). ## Testing requirements diff --git a/docs/packaging-guidelines.md b/docs/packaging.md similarity index 98% rename from docs/packaging-guidelines.md rename to docs/packaging.md index 54574c12d..ff2bb72c4 100644 --- a/docs/packaging-guidelines.md +++ b/docs/packaging.md @@ -315,3 +315,16 @@ only in some specific circumstances? In those situations we have to: versioned provider to disambiguate (e.g: `provides="audio-conf=$pkgver-r$pkgrel"`), or to force the forked packages to provide a lower version than the other package. + +```{eval-rst} +.. toctree:: + :hidden: + + packaging/device-categorization + + packaging/device-packages + packaging/kernel-packages + + packaging/firmware-packages + packaging/ui-packages +``` diff --git a/docs/device-categorization.md b/docs/packaging/device-categorization.md similarity index 99% rename from docs/device-categorization.md rename to docs/packaging/device-categorization.md index 3070331f0..dca746ee7 100644 --- a/docs/device-categorization.md +++ b/docs/packaging/device-categorization.md @@ -224,7 +224,7 @@ requested time pass and the device still does not meet the criteria, a merge request to move them to the now appropriate category should be opened. Merge requests moving a device to a lower category are subject to the standard -[pmaports approval rules](./merge-requests/approval-rules). +[pmaports approval rules](../merge-requests/approval-rules). ## See also diff --git a/docs/packaging/device-packages.md b/docs/packaging/device-packages.md new file mode 100644 index 000000000..994d62ec4 --- /dev/null +++ b/docs/packaging/device-packages.md @@ -0,0 +1,12 @@ +# Device Packages + +Device packges in pmaports start with `device-`. + +```{eval-rst} +.. toctree:: + :hidden: + + device-packages/generic-device-packages + device-packages/deviceinfo-reference +``` + diff --git a/docs/generic-device-packages.md b/docs/packaging/device-packages/generic-device-packages.md similarity index 100% rename from docs/generic-device-packages.md rename to docs/packaging/device-packages/generic-device-packages.md diff --git a/docs/firmware.md b/docs/packaging/firmware-packages.md similarity index 100% rename from docs/firmware.md rename to docs/packaging/firmware-packages.md diff --git a/docs/packaging/kernel-packages.md b/docs/packaging/kernel-packages.md new file mode 100644 index 000000000..5a9b5b030 --- /dev/null +++ b/docs/packaging/kernel-packages.md @@ -0,0 +1,14 @@ +# Kernel Packages + +Kernel packages in pmaports start with `linux-`. + +```{eval-rst} +.. toctree:: + :hidden: + + kernel-packages/generic-kernel-packages + kernel-packages/kconfig-fragments + kernel-packages/kconfigcheck + kernel-packages/kernel-cmdline + kernel-packages/kernel-versions +``` diff --git a/docs/generic-kernels.md b/docs/packaging/kernel-packages/generic-kernel-packages.md similarity index 100% rename from docs/generic-kernels.md rename to docs/packaging/kernel-packages/generic-kernel-packages.md diff --git a/docs/kconfig-fragments.md b/docs/packaging/kernel-packages/kconfig-fragments.md similarity index 100% rename from docs/kconfig-fragments.md rename to docs/packaging/kernel-packages/kconfig-fragments.md diff --git a/docs/kconfigcheck.md b/docs/packaging/kernel-packages/kconfigcheck.md similarity index 96% rename from docs/kconfigcheck.md rename to docs/packaging/kernel-packages/kconfigcheck.md index 0a8e438f7..c9a8dc3d9 100644 --- a/docs/kconfigcheck.md +++ b/docs/packaging/kernel-packages/kconfigcheck.md @@ -47,7 +47,7 @@ This would opt into the `community` category checks. The checks can be performed by running `pmbootstrap kconfig check [kernel-package-name]`. The `community` category checks are mandatory for devices in the community and main categories, see the -[device categorization requirements](./device-categorization) for more +[device categorization requirements](../device-categorization) for more information. ## Version baselines @@ -79,7 +79,7 @@ package maintainers, who must make sure their kernel complies with the changed requirements in the next update to their kernel packages. When making unrelated changes to a kernel package that does not meet the current requirements, one can use the `[ci:skip-kconfigcheck]` CI tag to bypass the checks if -[the situation allows for it](ci/ci-tags). +[the situation allows for it](../../ci/ci-tags). Merge requests that change the `kconfigcheck.toml` require approval from members of the kconfigcheck team in GitLab. The team can be pinged on merge diff --git a/docs/kernel-cmdline.md b/docs/packaging/kernel-packages/kernel-cmdline.md similarity index 100% rename from docs/kernel-cmdline.md rename to docs/packaging/kernel-packages/kernel-cmdline.md diff --git a/docs/kernel-versions.md b/docs/packaging/kernel-packages/kernel-versions.md similarity index 94% rename from docs/kernel-versions.md rename to docs/packaging/kernel-packages/kernel-versions.md index b1cffed80..73da0d347 100644 --- a/docs/kernel-versions.md +++ b/docs/packaging/kernel-packages/kernel-versions.md @@ -9,7 +9,7 @@ additional guidelines for which kernel version to package for a device. Devices with a close-to-mainline kernel usually reside in `testing` and can be moved to `community` or `main` later if they meet the necessary -[requirements](./device-categorization.md). Devices using a downstream (i.e. +[requirements](../device-categorization.md). Devices using a downstream (i.e. vendor-provided) kernel are packaged in the `downstream` or `archived` categories. diff --git a/docs/ui-packages.md b/docs/packaging/ui-packages.md similarity index 100% rename from docs/ui-packages.md rename to docs/packaging/ui-packages.md