summaryrefslogtreecommitdiffstats
path: root/Documentation/process/stable-kernel-rules.rst (follow)
Commit message (Collapse)AuthorAgeFilesLines
* Documentation: stable: clarify patch series prerequisitesHugo Villeneuve2023-10-051-0/+13
| | | | | | | | | | | Add some clarifications for patches that have dependencies within the patch series. Signed-off-by: Hugo Villeneuve <hvilleneuve@dimonoff.com> Rule: add Link: https://lore.kernel.org/stable/20230911203628.20068-1-hugo%40hugovil.com Link: https://lore.kernel.org/r/20230911203628.20068-1-hugo@hugovil.com Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
* docs: stable-kernel-rules: mention that regressions must be preventedThorsten Leemhuis2023-08-121-2/+8
| | | | | | | | | | | | | Document that changes intended for a specific stable series have to be in all newer series still maintained, as otherwise users would run into regressions. CC: Greg KH <gregkh@linuxfoundation.org> CC: Sasha Levin <sashal@kernel.org> CC: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Thorsten Leemhuis <linux@leemhuis.info> Link: https://lore.kernel.org/r/ddb5cb0d6b7aa4ef31642cd9657a0fb53d79cddb.1691219455.git.linux@leemhuis.info Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
* docs: stable-kernel-rules: fine-tune various detailsThorsten Leemhuis2023-08-121-32/+40
| | | | | | | | | | | | | | | | | | | * various fine tuning to the text that cleans up rough edges the three previous preparatory patches left behind to keep the diffs simpler * s/Linus' tree/mainline/g, as that's the term more commonly used and known * create a short intro for the three submission options and streamline the explanation when to use which of them * fix a >= vs <= thinko in an example to make it more straight forward * there were two blank lines before some sub-headings and just one before others; use the former style everywhere CC: Greg KH <gregkh@linuxfoundation.org> CC: Sasha Levin <sashal@kernel.org> CC: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Thorsten Leemhuis <linux@leemhuis.info> Link: https://lore.kernel.org/r/e1960a70acae2c2f18b838aee9f8bf6055fae89b.1691219455.git.linux@leemhuis.info Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
* docs: stable-kernel-rules: make the examples for option 1 a proper listThorsten Leemhuis2023-08-121-23/+25
| | | | | | | | | | | | | | Separate the description for option 1 and the examples how to use it by making the latter an indented unordered list. No text changes. CC: Greg KH <gregkh@linuxfoundation.org> CC: Sasha Levin <sashal@kernel.org> CC: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Thorsten Leemhuis <linux@leemhuis.info> Link: https://lore.kernel.org/r/59deaabfabf0629d7cf2a52b196cec19d1f9ec47.1691219455.git.linux@leemhuis.info Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
* docs: stable-kernel-rules: move text around to improve flowThorsten Leemhuis2023-08-121-44/+44
| | | | | | | | | | | | | | | | | | Move the short description about when to use which of the submission options to the top of the section, as it currently sits somewhat odd in the middle between option 3 and examples of option 1. Also move the examples of Option 1 into the section describing it (which in the diff looks like option 2 and 3 are moving down). No text changes, just moving it around. CC: Greg KH <gregkh@linuxfoundation.org> CC: Sasha Levin <sashal@kernel.org> CC: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Thorsten Leemhuis <linux@leemhuis.info> Link: https://lore.kernel.org/r/16f2377ee40dd7dfa146727fcbe7d1ebccf5b5be.1691219455.git.linux@leemhuis.info Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
* docs: stable-kernel-rules: improve structure by changing headlinesThorsten Leemhuis2023-08-121-8/+9
| | | | | | | | | | | | | * replace a needless sub-heading with a short intro sentence * make "Following the submission" a proper sub-section with a headline without changing the text of the section CC: Greg KH <gregkh@linuxfoundation.org> CC: Sasha Levin <sashal@kernel.org> CC: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Thorsten Leemhuis <linux@leemhuis.info> Link: https://lore.kernel.org/r/0737676f951050b2ec39e1662ffea37d77ef0bec.1691219455.git.linux@leemhuis.info Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
* docs: stable-kernel-rules: make rule section more straight forwardThorsten Leemhuis2023-08-051-20/+18
| | | | | | | | | | | | | | | | | | | | | | | | | | | Tweak some of the rule text to make things more straight forward, with the goal to stick closely to the intend of the old text: * put the "it or equivalent fix must be upstream" rule at the top, as it's one of the most important ones that at the same time often seems to be missed by developers. * "It must fix only one thing" was dropped, as that is almost always a thing that needs to be handled earlier when the change is mainlined. Furthermore, this is already indirectly covered by the "Separate your changes" section in Documentation/process/submitting-patches.rst which the rules already point to. * six other rules are in the end one rule with clarifications; structure the text accordingly to make it a lot easier to follow and understand the intend. * drop the 'In short, something critical' from one of those notes: it contradicts the "real bug that bothers people" aspect somewhat and does not really add anything CC: Greg KH <gregkh@linuxfoundation.org> CC: Sasha Levin <sashal@kernel.org> CC: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Thorsten Leemhuis <linux@leemhuis.info> Link: https://lore.kernel.org/r/f83e812879caa978a51a1a7cae7c359f29fc093c.1689056247.git.linux@leemhuis.info Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
* docs: stable-kernel-rules: mention other usages for stable tag commentsThorsten Leemhuis2023-08-051-3/+19
| | | | | | | | | | | | Document how to delay backporting or send a note to the stable team using shell-style inline comments attached to stable tags. CC: Greg KH <gregkh@linuxfoundation.org> CC: Sasha Levin <sashal@kernel.org> CC: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Thorsten Leemhuis <linux@leemhuis.info> Link: https://lore.kernel.org/r/bf1489b40ff358b7cb4f7d8cc73d5c7c3c143471.1689056247.git.linux@leemhuis.info Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
* Documentation/security-bugs: move from admin-guide/ to process/Vegard Nossum2023-03-121-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Jiri Kosina, Jonathan Corbet, and Willy Tarreau all expressed a desire to move this document under process/. Create a new section for security issues in the index and group it with embargoed-hardware-issues. I'm doing this at the start of the series to make all the subsequent changes show up in 'git blame'. Existing references were updated using: git grep -l security-bugs ':!Documentation/translations/' | xargs sed -i 's|admin-guide/security-bugs|process/security-bugs|g' git grep -l security-bugs Documentation/translations/ | xargs sed -i 's|Documentation/admin-guide/security-bugs|Documentation/process/security-bugs|g' git grep -l security-bugs Documentation/translations/ | xargs sed -i '/Original:/s|\.\./admin-guide/security-bugs|\.\./process/security-bugs|g' Notably, the page is not moved in the translations (due to my lack of knowledge of these languages), but the translations have been updated to point to the new location of the original document where these references exist. Link: https://lore.kernel.org/all/nycvar.YFH.7.76.2206062326230.10851@cbobk.fhfr.pm/ Suggested-by: Jiri Kosina <jikos@kernel.org> Cc: Alex Shi <alexs@kernel.org> Cc: Yanteng Si <siyanteng@loongson.cn> Cc: Hu Haowen <src.res@email.cn> Cc: Federico Vaga <federico.vaga@vaga.pv.it> Cc: Tsugikazu Shibata <tshibata@ab.jp.nec.com> Cc: Minchan Kim <minchan@kernel.org> Cc: Jeimi Lee <jamee.lee@samsung.com> Cc: Carlos Bilbao <carlos.bilbao@amd.com> Cc: Akira Yokosawa <akiyks@gmail.com> Signed-off-by: Vegard Nossum <vegard.nossum@oracle.com> Acked-by: Carlos Bilbao <carlos.bilbao@amd.com> Reviewed-by: Yanteng Si <siyanteng@loongson.cn> Reviewed-by: Akira Yokosawa <akiyks@gmail.com> Acked-by: Federico Vaga <federico.vaga@vaga.pv.it> Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com> Link: https://lore.kernel.org/r/20230305220010.20895-2-vegard.nossum@oracle.com Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
* Documentation: stable: Document alternative for referring upstream commit hashSalvatore Bonaccorso2022-09-271-0/+6
| | | | | | | | | | Additionally to the "commit <sha1> upstream." variant, "[ Upstream commit <sha1> ]" is used as well as alternative to refer to the upstream commit hash. Signed-off-by: Salvatore Bonaccorso <carnil@debian.org> Link: https://lore.kernel.org/r/20220901184328.4075701-1-carnil@debian.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: update stable review cycle documentationBagas Sanjaya2022-03-181-4/+13
| | | | | | | | | | | | | | | | | | In recent times, the review cycle for stable releases have been changed. In particular, there is release candidate phase between ACKing patches and new stable release. Also, in case of failed submissions (fail to apply to stable tree), manual backport (Option 3) have to be submitted instead. Update the release cycle documentation on stable-kernel-rules.rst to reflect the above. Cc: Sasha Levin <sashal@kernel.org> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-kernel@vger.kernel.org Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> Link: https://lore.kernel.org/r/20220314113329.485372-4-bagasdotme@gmail.com Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
* Documentation: update stable tree linkBagas Sanjaya2022-03-181-1/+1
| | | | | | | | | | | | | | | The link to stable tree is redirected to https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git. Update accordingly. Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Cc: Sasha Levin <sashal@kernel.org> Cc: Jonathan Corbet <corbet@lwn.net> Cc: stable@vger.kernel.org Cc: linux-kernel@vger.kernel.org Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> Link: https://lore.kernel.org/r/20220314113329.485372-6-bagasdotme@gmail.com Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
* Documentation: add link to stable release candidate treeBagas Sanjaya2022-03-181-0/+9
| | | | | | | | | | | | | | There is also stable release candidate tree. Mention it, however with a warning that the tree is for testing purposes. Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Cc: Sasha Levin <sashal@kernel.org> Cc: Jonathan Corbet <corbet@lwn.net> Cc: stable@vger.kernel.org Cc: linux-kernel@vger.kernel.org Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> Link: https://lore.kernel.org/r/20220314113329.485372-5-bagasdotme@gmail.com Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
* Documentation: add note block surrounding security patch noteBagas Sanjaya2022-03-181-1/+3
| | | | | | | | | | | | | | Security patches have different handling than rest of patches for review. Enclose note paragraph about such patches in `.. note::` block. Cc: Sasha Levin <sashal@kernel.org> Cc: Jonathan Corbet <corbet@lwn.net> Cc: linux-kernel@vger.kernel.org Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> Link: https://lore.kernel.org/r/20220314113329.485372-2-bagasdotme@gmail.com Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
* docs: networking: drop special stable handlingJakub Kicinski2021-03-031-6/+0
| | | | | | | Leave it to Greg. Signed-off-by: Jakub Kicinski <kuba@kernel.org> Signed-off-by: David S. Miller <davem@davemloft.net>
* net: switch to the kernel.org patchwork instanceJakub Kicinski2020-11-121-1/+1
| | | | | | | | | Move to the kernel.org patchwork instance, it has significantly lower latency for accessing from Europe and the US. Other quirks include the reply bot. Link: https://lore.kernel.org/r/20201110035120.642746-1-kuba@kernel.org Signed-off-by: Jakub Kicinski <kuba@kernel.org>
* stable-kernel-rules.rst: add link to networking patch queueGreg Kroah-Hartman2019-02-021-0/+3
| | | | | | | | | | | The networking maintainer keeps a public list of the patches being queued up for the next round of stable releases. Be sure to check there before asking for a patch to be applied so that you do not waste people's time. Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Acked-by: David S. Miller <davem@davemloft.net> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* doc:process: add missing internal link in stable-kernel-rulesFederico Vaga2019-01-211-3/+3
| | | | | | | | Keep consistent the document. In the document, option references are always linked, except for the one I fixed with this patch Signed-off-by: Federico Vaga <federico.vaga@vaga.pv.it> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: Update references to netdev-FAQTobin C. Harding2018-07-271-1/+1
| | | | | | | | | | File 'Documentation/networking/netdev-FAQ.txt' has been converted to RST format. We should update all links/references to point to the new file. Update references to netdev-FAQ Signed-off-by: Tobin C. Harding <me@tobin.cc> Signed-off-by: David S. Miller <davem@davemloft.net>
* Documentation: stable-kernel-rules: fix broken git urlsAndrii Bordunov2017-08-241-2/+2
| | | | | | | | | | git.kernel.org links don't work (fatal: repository ... not found). Update them with the current style from https://git.kernel.org There is no HTTP option, so also switch HTTP -> HTTPS. Signed-off-by: Andrii Bordunov <andrew.bordunov@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: stable-kernel-rules: fix stable-tag formatJohan Hovold2017-04-081-1/+1
| | | | | | | | | | | | | | A patch documenting how to specify which kernels a particular fix should be backported to (seemingly) inadvertently added a minus sign after the kernel version. This particular stable-tag format had never been used prior to this patch, and was neither present when the patch in question was first submitted (it was added in v2 without any comment). Drop the minus sign to avoid any confusion. Fixes: fdc81b7910ad ("stable_kernel_rules: Add clause about specification of kernel versions to patch.") Signed-off-by: Johan Hovold <johan@kernel.org> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
* docs: fix locations of several documents that got movedMauro Carvalho Chehab2016-10-241-2/+2
| | | | | | | | The previous patch renamed several files that are cross-referenced along the Kernel documentation. Adjust the links to point to the right places. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* docs-rst: add documents to development-processMauro Carvalho Chehab2016-10-241-0/+181
Add several documents to the development-process ReST book. As we don't want renames, use symlinks instead, keeping those documents on their original place. Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>