Commit graph

60 commits

Author SHA1 Message Date
Oliver Smith
9b29c2bc2c
docs: stable-branches: backports may wait
Let's note that maintainers can choose to delay backports to give them
more testing time.

Signed-off-by: Oliver Smith <ollieparanoid@postmarketos.org>
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/8850>
2026-06-17 19:45:54 +02:00
Oliver Smith
2f121a4d14
docs: integrate COMMITSTYLE
Make a symlink at docs/merge-requests/commitstyle.md that points at the
COMMITSTYLE.md file, so it is part of the documentation at
https://docs.postmarketos.org/pmaports/.

Tweak the headline and link to Alpine's COMMITSTYLE.md so it looks
better in the version rendered at docs.postmarketos.org.

Signed-off-by: Oliver Smith <ollieparanoid@postmarketos.org>
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/8829>
2026-06-16 13:40:21 +00:00
Oliver Smith
4084d06f7b
docs: approval-rules: simplify for stable branches
Don't describe how MRs to stable branches are done here, link to the
other page instead. Otherwise the approval rules should be the same as
for stable branches from now on.

Signed-off-by: Oliver Smith <ollieparanoid@postmarketos.org>
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/8812>
2026-06-16 13:30:02 +02:00
Oliver Smith
8d534ae3d6
docs: update merge-requests/stable-branches
* Describe relevant changes, especially that we may make non-backport
  changes if there is a patch release for a package that meanwhile has a
  higher version in main already (e.g. a kernel in main is on linux
  7.x.y while stable is on 6.18.z).

* Directly pushing to a stable branch should only be done during initial
  branch bringup, otherwise we shall always make MRs that go through CI.

* Update formatting and title of the page.

Signed-off-by: Oliver Smith <ollieparanoid@postmarketos.org>
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/8812>
2026-06-16 13:30:01 +02:00
Oliver Smith
d13bed7d56
docs: make headlines more consistent
Signed-off-by: Oliver Smith <ollieparanoid@postmarketos.org>
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/8812>
2026-06-16 13:27:58 +02:00
Oliver Smith
5b69893122
docs: structure: move packaging related pages
Bring more structure into the docs by moving packaging related subpages
as well.

Signed-off-by: Oliver Smith <ollieparanoid@postmarketos.org>
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/8812>
2026-06-16 13:27:25 +02:00
Oliver Smith
ac931d4507
docs: structure: move merge-requests related pages
Add a new "merge requests" page and move all related pages under that
page to give the docs more structure.

Signed-off-by: Oliver Smith <ollieparanoid@postmarketos.org>
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/8812>
2026-06-16 13:27:22 +02:00
Oliver Smith
ae07d28bfb
docs: structure: move CI related pages
Signed-off-by: Oliver Smith <ollieparanoid@postmarketos.org>
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/8812>
2026-06-16 13:24:21 +02:00
Oliver Smith
ad05a1b83b
docs/releases/timeline: add numbers before phases
Adjust the timeline docs and release infrastructure template to have
numbers before the phases. This makes clearer where the next phase
begins in the long infrastructure issue template.

Signed-off-by: Oliver Smith <ollieparanoid@postmarketos.org>
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/8815>
2026-06-15 19:23:56 +00:00
Aster Boese
fb74aa230e
docs: document how to create a UI package
Updates and replaces https://wiki.postmarketos.org/wiki/UI_specific_package,
being a bit more specific as to what is expected out of a UI package and
how exactly to create one.

Signed-off-by: Aster Boese <asterboese@mailbox.org>
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/8720>
2026-06-10 07:26:39 +00:00
bluebunny
9a8530c89b
docs: make package versioning more detailed
The old wiki page "Packaging" [1] had more information on when to bump packages,
but it was omitted when migrating to docs.postmarketos.org. Revive the section
and reword the sentences a bit, so that there will be no confusion that the
version of a package should always be bumped.

[1]: https://wiki.postmarketos.org/index.php?title=Packaging&oldid=68927#When_should_pkgver/pkgrel_get_increased?

Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/8739>
2026-06-09 05:29:54 +00:00
Oliver Smith
1a6c9dda36
docs: fix typo: maintainance -> maintenance
Signed-off-by: Oliver Smith <ollieparanoid@postmarketos.org>
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/8738>
2026-06-07 13:12:35 +02:00
Oliver Smith
734884e864
CI: apkbuild-lint: add a skip-apkbuild-lint tag
As we are now moving to a newer, stricter version, we might want to skip
fixing APKBUILDs in some MRs. And this is in general useful to have.

Signed-off-by: Oliver Smith <ollieparanoid@postmarketos.org>
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/8735>
2026-06-07 10:09:20 +00:00
Aelin
f948899cb0
docs: Add approval rules flowchart
Apparently our rules are complicated enough that this is necessary. I am
*not* an expert at Inkscape, so bear with me. This is also my
interpretation of the rules, if I got anything wrong, please correct me.

Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/8719>
2026-06-05 13:07:15 +00:00
Oliver Smith
879b7a6dbc
docs: update release timeline
Move the test week by one week, the package repository isn't ready just
yet.

Signed-off-by: Oliver Smith <ollieparanoid@postmarketos.org>
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/8713>
2026-06-02 15:34:17 +02:00
Aelin
2dcfeceda0
docs: device-categorization: Don't special-case CC approvals
As far as I can tell, this was overlooked so far when going over things
where we still differentiate between CCs and TCs.

Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/8705>
2026-06-01 17:02:50 +00:00
Aster Boese
1a482a2b17
docs: add skip-grep
Signed-off-by: Aster Boese <asterboese@mailbox.org>
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/8652>
2026-05-27 15:29:19 +02:00
Aster Boese
5e7cac3f31
docs: document requirement for mainline kernels to be built with LLVM
Signed-off-by: Aster Boese <asterboese@mailbox.org>
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/8546>
2026-05-18 20:48:08 +00:00
Aster Boese
aacb35f760
docs: document version cutoff for mainline kernels
Signed-off-by: Aster Boese <asterboese@mailbox.org>
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/8546>
2026-05-18 20:48:08 +00:00
Pablo Correa Gómez
6112038d86
docs: remove requirement for maintainer from community devices
This is a general packaging guideline.

Signed-off-by: Pablo Correa Gómez <pabloyoyoista@postmarketos.org>
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/8508>
2026-05-08 21:49:46 +00:00
Pablo Correa Gómez
e3f06aba45
docs: add section about maintainership to packaging guidelines
Signed-off-by: Pablo Correa Gómez <pabloyoyoista@postmarketos.org>
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/8508>
2026-05-08 21:49:46 +00:00
Pablo Correa Gómez
b293a8e354
docs: place the provides section of the packaging guidelines at the end
It is quite massive, and therefore let's put the simpler things
first. If things keep growing, at some point it would make sense to
move it out to a subpage.

Signed-off-by: Pablo Correa Gómez <pabloyoyoista@postmarketos.org>
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/8508>
2026-05-08 21:49:43 +00:00
Pablo Correa Gómez
0b505f0189
docs: cleanup wording of device-categorization.
"2021-11" is completely unnecessary at this point, and adding that the
kernel must be upgraded regularly is redundant with the requirement of
3 kernel releases and a lot less objective. So keep the objective
wording and remove the one very up for interpretation.

Signed-off-by: Pablo Correa Gómez <pabloyoyoista@postmarketos.org>
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/8505>
2026-05-07 16:44:53 +00:00
Pablo Correa Gómez
5e180a8f0b
docs: fix heading level of archived category
Signed-off-by: Pablo Correa Gómez <pabloyoyoista@postmarketos.org>
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/8505>
2026-05-07 16:44:53 +00:00
Oliver Smith
c52e7b1556
docs: add release documentation
Move and update release documentation from these wiki pages to pmaports
docs:
* https://wiki.postmarketos.org/wiki/Releases
* https://wiki.postmarketos.org/wiki/Creating_a_release_branch#Timeline

Signed-off-by: Oliver Smith <ollieparanoid@postmarketos.org>
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/8486>
2026-05-05 12:48:41 +00:00
Aelin
6d11555054
docs/kconfigcheck: Clarify version baselines
It is extremely tedious to keep track of what the name of a particular
option was for every kernel release and when they were added. To keep
kconfigcheck maintainable, let's ease the burden on people adding new
options for community categories or other categories only required by
close-to-mainline kernel packages and only have them look back a
reasonable number of kernel versions.

Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/8407>
2026-04-22 16:12:29 +00:00
Achill Gilgenast
e38532b7f7
ci: relax pkgrel changes for packages that don’t have remote sources
Motivation is to avoid unnecessary overhead for MR authors & no reason to
actually use pkgrel for meta-packages.

So instead, recommend pkgver-bumps & pkgrel=0 for metapackages, but don't
block MRs when they bumped the "wrong" one. Just make everyone's life easier.

Discussed at <https://docs.postmarketos.org/policies-and-processes/governance/team-meetings/meeting-notes.html> (2026-03-16)

Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/8302>
2026-04-10 12:08:26 +00:00
Oliver Smith
a82d50bb51
docs: device-categorization: new main requirements
Featuring a minor wording tweak as suggested by Newbyte.

Related: https://docs.postmarketos.org/pmcr/main/0009-new-main-device-category.html
Signed-off-by: Oliver Smith <ollieparanoid@postmarketos.org>
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/8237>
2026-03-29 16:47:50 +02:00
Aster Boese
7d8b935704
treewide: change pmaports-specific master strings to main
Signed-off-by: Aster Boese <asterboese@mailbox.org>
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/7566>
2026-03-15 13:54:37 +00:00
Pablo Correa Gómez
2e12f24b15
docs: add documentation on how hw-ci integration works in this repo
[ci:skip-vercheck] gitlab-ci.yml.j2 files changed

Signed-off-by: Pablo Correa Gómez <pabloyoyoista@postmarketos.org>
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/7881>
2026-03-12 19:17:36 +00:00
Aelin
0e41c1bcbd
docs: Add documentation on firmware packaging
Add firmware packaging guidelines to the documentation. The goal behind
this was to make it so that it is very clear which packaging method is
preferred for which cases to avoid fragmentation and inconsistency in
pmaports packaging.

Co-authored-by: Pablo Correa Gómez <pabloyoyoista@postmarketos.org>
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/8161>
2026-03-12 18:42:59 +00:00
Aelin
cbad33f921
docs: generic-kernels: Allow cherry-picking patches to fix compilation
In the case that the compilation is broken, it is not possible to wait
until a patch is merged upstream to fix it. We want to be able to patch
the kernels temporarily while also ensuring the fixes make it upstream.

Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/8072>
2026-03-12 17:37:30 +00:00
Clayton Craft
3df5cc176b
docs: document kconfig fragment usage for kernel maintainers
Signed-off-by: Clayton Craft <craftyguy@postmarketos.org>
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/7606>
2026-03-11 17:27:20 -07:00
Oliver Smith
12e42c192f
docs/generic-device-packages: new page
Start the documentation for generic device packages and document how to
handle device-specific services. This is a question that came up in the
review of PMCR-0009 (new main device category).

Signed-off-by: Oliver Smith <ollieparanoid@postmarketos.org>
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/8122>
2026-03-08 16:40:45 +00:00
Achill Gilgenast
24681624eb
docs: mention to open issues when a merge happend without maintainer response
See the meeting notes from the 2026-01-19:
(https://docs.postmarketos.org/policies-and-processes/governance/team-meetings/meeting-notes.html)

> Discussed pmaports!7770, possibly limiting the wait period for maintainer
> approval from 2 weeks to 1 week.
>
> We discussed to keep 2 weeks and make an issue template for “had to merge
> without maintainer review”, the new process will then be that the template
> gets filled out if a MR has to be merged without maintainer review after
> two weeks. The maintainer can then either say that they plan to review
> future merge requests, or indicate that they don’t want to maintain the
> thing anymore, or just not respond (which implies that they don’t want
> to maintain anymore). That way we should be able to get the listed
> maintainers to reflect reality better.
>
> Everyone reading this, please make sure you are not listed as maintainer
> for packages that you don’t plan to do reviews for anymore :)

Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/7770>
2026-03-08 11:07:53 +01:00
Pablo Correa Gómez
cd934c19be
docs: add initial packaging guidelines to explain providers
Relates https://gitlab.postmarketos.org/postmarketOS/docs.postmarketos.org/-/issues/18

Signed-off-by: Pablo Correa Gómez <pabloyoyoista@postmarketos.org>
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/7875>
2026-03-04 16:26:14 +00:00
Aelin
b7cb738a62
docs/generic-kernels: Add device package template
This is currently hidden away in a GitLab issue comment. For broader
visibility, let's just put this in the documentation to encourage people
to follow it.

Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/8108>
2026-03-01 16:33:58 +01:00
Oliver Smith
76a9161063
docs/generic-kernels: add policy for patches
Aelin proposed this policy for patches in today's meeting and I think
this makes a lot of sense.

Signed-off-by: Oliver Smith <ollieparanoid@postmarketos.org>
Part-of: <https://gitlab.postmarketos.org/postmarketOS/pmaports/-/merge_requests/8022>
2026-02-16 21:50:28 +00:00
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