Commit graph

72 commits

Author SHA1 Message Date
Stefan Hansson
b586a6d949
docs: specify path to deviceinfo reference when generating it
Closes https://gitlab.postmarketos.org/postmarketOS/pmaports/-/issues/4333

Signed-off-by: Stefan Hansson <newbyte@postmarketos.org>
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/8011>
2026-02-14 20:05:28 +00:00
Stefan Hansson
d6834e89f3
docs: raise exception if dint reports an error
Currently, even if dint fails for some reason, the documentation
generation continues on. This is not good as it hides problems until
someone manually discovers them. Fix this by checking the exit code of
dint and raising an exception if it isn't zero.

To facilitate this, also replace call() with run() since it's a more
modern and more flexible API.

Signed-off-by: Stefan Hansson <newbyte@postmarketos.org>
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/7982>
2026-02-11 01:01:45 +00:00
Clayton Craft
382cd1dee1
docs: kernel-cmdline: clarify handling of config for multiple kernels
Signed-off-by: Clayton Craft <craftyguy@postmarketos.org>
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/7830>
2026-01-27 12:33:05 -08:00
Aelin
8f5f696de5
docs: Add documentation on generic kernels
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/7842>
2026-01-26 10:58:25 +01:00
Clayton Craft
a80206516e
docs/kernel-cmdline: add docs for new kernel cmdline system
Signed-off-by: Clayton Craft <craftyguy@postmarketos.org>
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/7708>
2026-01-23 15:06:19 -08:00
Stefan Hansson
ffbce2d731
docs: Mark [ci:ignore-count] as removed
Keeping it in the docs under a new section to reduce the risk of
confusion about its disappearance. It's also still relevant if you
target older branches where it hasn't been removed.

Signed-off-by: Stefan Hansson <newbyte@postmarketos.org>
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/7822>
2026-01-23 13:47:00 +00:00
Stefan Hansson
ee18cf6b9c
docs: cover some more edge cases in the approval rules
Closes https://gitlab.postmarketos.org/postmarketOS/pmaports/-/issues/4228

Signed-off-by: Stefan Hansson <newbyte@postmarketos.org>
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/7766>
2026-01-19 14:29:14 +00:00
Aelin
c9c88060f2
docs: Document kconfigcheck and process for changing requirements
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/7382>
2026-01-13 18:00:57 +00:00
Pablo Correa Gómez
4e23818b18
docs: allow TCs to backport to stable releases
Relates https://gitlab.postmarketos.org/postmarketOS/postmarketos/-/issues/131

Signed-off-by: Pablo Correa Gómez <pabloyoyoista@postmarketos.org>
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/7625>
2025-12-25 23:32:43 +00:00
Jens Reidel
93885e9498
docs: approval-rules: Allow merging without maintainer approval after 2 weeks
Signed-off-by: Jens Reidel <adrian@postmarketos.org>
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/7526>
2025-12-08 22:19:33 +00:00
Pablo Correa Gómez
6d879111b1
docs: add auto-generated deviceinfo reference
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/7414>
2025-11-23 20:26:30 +00:00
Pablo Correa Gómez
05efd122f2
docs: remove unused addition to path
This was copied from pmbootstrap, here we're not using anything
outside the "docs" folder.

Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/7414>
2025-11-23 20:26:30 +00:00
Jens Reidel
5c7301af2f
docs: Clarify process for demoting devices
Signed-off-by: Jens Reidel <adrian@postmarketos.org>
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/7327>
2025-11-12 21:34:26 +00:00
Pablo Correa Gómez
9b02cdac75
docs: add section on ci tags available in pmaports
Fixes https://gitlab.postmarketos.org/postmarketOS/docs.postmarketos.org/-/issues/13

Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/7336>
2025-11-12 19:13:25 +00:00
Jens Reidel
fad7a5050d
docs: Add kernel version packaging recommendations
Signed-off-by: Jens Reidel <adrian@postmarketos.org>
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/7295>
2025-11-05 11:21:33 +00:00
Jens Reidel
35eb5c61cb
docs: Replace Antora with Sphinx
See https://gitlab.postmarketos.org/postmarketOS/docs.postmarketos.org/-/issues/4

Signed-off-by: Jens Reidel <adrian@postmarketos.org>
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/7295>
2025-11-05 11:21:33 +00:00
Jens Reidel
0dc41491eb
docs/device-categorization: add kernel upgrading requirement
As per
https://gitlab.postmarketos.org/postmarketOS/postmarketos/-/issues/119,
we want to require kernel packages used by community devices to be
upgraded regularly, so add the proposed requirement in our
categorization requirements.

Signed-off-by: Jens Reidel <adrian@postmarketos.org>
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/7104>
2025-10-07 22:33:21 +00:00
Pablo Correa Gómez
3c19b268c2
docs/merging-rules: update backporting information
We haven't released service packs in years, so there's no point to
document them as a process.

Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/7077>
2025-09-25 19:55:33 +00:00
Pablo Correa Gómez
f332f1b306
docs: add review and merging guidelines specific to pmaports
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/7077>
2025-09-25 19:55:33 +00:00
Pablo Correa Gómez
8a9814ddc3
docs/device-categorization: avoid nesting and repetions
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/7077>
2025-09-25 19:55:30 +00:00
Pablo Correa Gómez
6adc515825
docs/device-categorization: remove subjective image-building requirement
This is not something we can measure or reason about, since "obscure"
is very subjective. An alternative of using "multiple users" has also
been discarded, since we don't have a way to measure that either for
now.

Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/7077>
2025-09-25 19:55:23 +00:00
Pablo Correa Gómez
b4283dcbc9
docs: initial documentation for pmaports
Part-of: https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/7065
2025-09-24 12:37:31 +02:00