summaryrefslogtreecommitdiff
path: root/doc/develop/process.rst
AgeCommit message (Collapse)Author
2026-02-06doc: develop/process: Clarify name usage in the Signed-off-by lineTom Rini
Long ago we took the Linux Kernel documentation about adding a Signed-off-by line and adjusted it slightly for how we organized things. In 2003 Linus clarified the intent and then re-worded what the name portion of the Signed-off-by line can be. Mirror that change here. Link: https://git.kernel.org/torvalds/c/d4563201f33a Signed-off-by: Tom Rini <[email protected]> Reviewed-by: Quentin Schulz <[email protected]>
2026-01-28doc: develop: process: Document using b4 and patchwork for custodiansTom Rini
- We already have good custodian documentation for patchwork, add a reference and then link to it here. - Add a reference to the existing b4 documentation, and reference it here. - Note and link to patchwork integration, am/shazam and ty features of b4 as these are the most likely useful portions. Be specific about keeping the default ${summary} as that includes important information. Signed-off-by: Tom Rini <[email protected]> Reviewed-by: Mattijs Korpershoek <[email protected]> Reviewed-by: Quentin Schulz <[email protected]>
2026-01-28doc: develop: process: Make "Work flow of a Custodian" a subsectionTom Rini
Make the "Work flow of a Custodian" section be a subsection of the Custodians section. Signed-off-by: Tom Rini <[email protected]> Reviewed-by: Quentin Schulz <[email protected]> Reviewed-by: Michael Trimarchi <[email protected]>
2026-01-28doc: develop: process: Move Custodians sectionTom Rini
Move the "Custodians" section to be after the "Review Process, Git Tags" section, in preparation for more re-organization. Signed-off-by: Tom Rini <[email protected]> Reviewed-by: Quentin Schulz <[email protected]>
2026-01-28doc: develop: process: Explain when/how Custodians may edit patchesTom Rini
As seen with commit d503633a3676 ("Revert "doc: board: starfive: update jh7110 common description""), it has not always been clear what is and isn't allowed by custodians, and what the expectations are. To prevent further unintentional conflicts, document the limited cases where custodians are allowed to modify patches directly, and how to do that. Signed-off-by: Tom Rini <[email protected]> Reviewed-by: Quentin Schulz <[email protected]>
2026-01-28doc: develop: process: Rework the custodian feedback sectionTom Rini
Now that we have two items here, rework this slightly to be using bullet points, and so easier to expand on. Signed-off-by: Tom Rini <[email protected]> Reviewed-by: Quentin Schulz <[email protected]>
2026-01-28doc: develop: process: Move the existing block about patch applicationTom Rini
We have a long block about the expectations and feedback about a patch applying, or not, as part of the Custodian workflow. Move this to the Custodians section from the Workflow of a custodian section. Signed-off-by: Tom Rini <[email protected]> Reviewed-by: Quentin Schulz <[email protected]>
2025-09-27doc: develop: process: Add note about asking for feedbackTom Rini
It can be unclear to contributors what to do if they haven't gotten any feedback on patches they have submitted. Add a sentence saying that if they feel it's been too long without any comment, it's OK to reply again. Signed-off-by: Tom Rini <[email protected]>
2024-09-12doc: Update rST to not reference the old wikiTom Rini
In two places we had references to the old wiki pages instead of links to the relevant part of our documentation. Update (and slightly reword) these spots. Signed-off-by: Tom Rini <[email protected]>
2024-06-06doc: process.rst: Document device tree resync rulesTom Rini
Document the logic of when we do a full resync of the device trees used by OF_UPSTREAM as well as that cherry-picking is allowed as needed. Signed-off-by: Tom Rini <[email protected]> Reviewed-by: Quentin Schulz <[email protected]>
2024-06-06doc: process.rst: Use subsubheading for "Phases of the Development Process"Tom Rini
These sections which talk about the different phases of the development process should be using the subsubheading identifier. Signed-off-by: Tom Rini <[email protected]> Reviewed-by: Quentin Schulz <[email protected]>
2022-12-17doc: fix typosMaxim Cournoyer
Fix a few typos spot during a first read of the contribution process. Signed-off-by: Maxim Cournoyer <[email protected]> Reviewed-by: Heinrich Schuchardt <[email protected]> Signed-off-by: Heinrich Schuchardt <[email protected]>
2022-09-01doc: process, sending_patches: Update and correct the old "Patches" contentTom Rini
- Use gender-neutral language to refer to the user, consistently. - Reference the checkpatch document. - Move the section on commit message tags to the process document and reference this in sending_patches.rst. - Reword the custodian workflow process section to refer to this new section, integrate some of the wording from there in this new section. - Update the comment about GPLv2 applying to August 2022, to be clear this still is correct. - Reword the section about MAKEALL to talk about local build testing and link to the CI document. - Reference the system_configuration document for the note about modifying existing code. - Reword the patchwork flow section. Cc: Heinrich Schuchardt <[email protected]> Signed-off-by: Tom Rini <[email protected]>
2022-09-01doc: sending_patches.rst: Incorporate the old "Patches" wiki contentTom Rini
Import as-is much of the old "Patches" wiki page to the current sending_patches.rst file. This means we need to move patman to being included in the higher level ToC and add a reference for "Custodians" in the process document. A very minimal amount of content changing and rewording is done here as part of the import, in order to make the conversion easier. Cc: Heinrich Schuchardt <[email protected]> Signed-off-by: Tom Rini <[email protected]> Reviewed-by: Simon Glass <[email protected]>
2022-08-13doc: develop: Add a note about importing code from other projectsTom Rini
We talk about importing code from other projects in two places. The first place is in the coding style section, where we explain when to or not to deviate in terms of white space, etc. In the process documentation we now add a note about saying where the code was imported from and to ensure that you do not copy Signed-off-by or other tags. Signed-off-by: Tom Rini <[email protected]> Acked-by: Sudeep Holla <[email protected]> Reviewed-by: Heinrich Schuchardt <[email protected]> Signed-off-by: Heinrich Schuchardt <[email protected]>
2022-07-14doc: process: Correct and expand slightly on the Merge Window conceptTom Rini
For quite a long time we've been using a 3 week, rather than 2 week, merge window as it was only 2 weeks during the timeframe where we did 2 month rather than 3 month releases. This corrects the places that still had 2 weeks and tries to make things a bit clearer overall. Cc: Heinrich Schuchardt <[email protected]> Signed-off-by: Tom Rini <[email protected]>
2022-07-14process.rst: Modernize the "Workflow of a Custodian" sectionTom Rini
The "Workflow of a Custodian" section on the wiki had not been changed in quite some time to reflect how the process has been functioning for some time. First, update some links to point to modern and current sources of information. Second, and more overarching, reword much of the section. This expands on the expectations of both custodians and developers when it comes to rebasing patches. Rework the final points to be clearer that Custodians are expected to do their best to test the changes and ask for help when needed, as well as that pull requests are expected in a timely manner. Cc: Claudius Heine <[email protected]> Cc: Martin Bonner <[email protected]> Cc: Heinrich Schuchardt <[email protected]> Signed-off-by: Tom Rini <[email protected]>
2022-07-14process.rst: Perform minor cleanupsTom Rini
- Use gender-neutral language to refer to the user, consistently. - Reword a few places so that they read more naturally. - Make the long standing practice around "Twilight Time" more clear, hopefully. - Replace a reference to MAKEALL with a reference to CI testing as that's the current requirement. Cc: Claudius Heine <[email protected]> Cc: Martin Bonner <[email protected]> Cc: Heinrich Schuchardt <[email protected]> Signed-off-by: Tom Rini <[email protected]>
2022-07-14doc: Migrate Process wiki page to SphinxTom Rini
Move the current Process wiki page to doc/develop/process.rst. The changes here are for formatting or slight rewording so that it reads well when linking to other Sphinx documents. Cc: Heinrich Schuchardt <[email protected]> Signed-off-by: Tom Rini <[email protected]>