From 85deb7f69ca4467cf5cf75545b253f9414908222 Mon Sep 17 00:00:00 2001 From: Tom Rini Date: Mon, 26 Aug 2024 10:39:17 -0600 Subject: doc/develop/sending_patches.rst: Clarify when to use which branch The previous wording on the paragraph about what branch to use when submitting patches did not reflect how / when the next branch is currently used. Reword this to note that master should be used for bug and regression fixes, always, and that next should be used once it opens, with -rc2. Reported-by: Jerome Forissier Signed-off-by: Tom Rini Reviewed-by: Quentin Schulz Acked-by: Jerome Forissier Reviewed-by: Heinrich Schuchardt --- doc/develop/sending_patches.rst | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) (limited to 'doc/develop') diff --git a/doc/develop/sending_patches.rst b/doc/develop/sending_patches.rst index 3f25b1d0466..9308f428bbd 100644 --- a/doc/develop/sending_patches.rst +++ b/doc/develop/sending_patches.rst @@ -73,12 +73,14 @@ General Patch Submission Rules cover letter why they are ignored is desired. * Send your patches as plain text messages: no HTML, no MIME, no links, no - compression, no attachments. Just plain text. The best way the generate - patches is by using the ``git format-patch`` command. Please use the - ``master`` branch of the mainline U-Boot git repository - (``https://source.denx.de/u-boot/u-boot.git``) as reference, unless (usually - late in a release cycle) there has been an announcement to use the ``next`` - branch of this repository instead. + compression, no attachments. Just plain text. The best way to generate + patches is by using the ``git format-patch`` command. For a patch that is + fixing a bug or regression of some sort, please use the ``master`` branch of + the mainline U-Boot git repository + (``https://source.denx.de/u-boot/u-boot.git``) as reference. For new + features, if the ``next`` branch has been opened (which happens with the + release of ``-rc2``) that branch should be used, otherwise ``master`` is + acceptable. * Make sure that your mailer does not mangle the patch by automatic changes like wrapping of longer lines etc. -- cgit v1.2.3 From 8002b1c07c2146afd907f2cad6a0c053c5d061c8 Mon Sep 17 00:00:00 2001 From: Tom Rini Date: Mon, 26 Aug 2024 10:49:54 -0600 Subject: doc: Update rST to not reference the old wiki 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 --- doc/develop/process.rst | 5 ++--- doc/develop/version.rst | 2 +- 2 files changed, 3 insertions(+), 4 deletions(-) (limited to 'doc/develop') diff --git a/doc/develop/process.rst b/doc/develop/process.rst index 0542b3fc124..0c6fb31e87b 100644 --- a/doc/develop/process.rst +++ b/doc/develop/process.rst @@ -23,9 +23,8 @@ Management Summary Phases of the Development Process --------------------------------- -U-Boot development takes place in `Release Cycles -`_. A Release Cycle lasts -normally for three months. +U-Boot development takes place in a :doc:`release_cycle`. A Release Cycle +lasts normally for three months. The first three weeks of each Release Cycle are called *Merge Window*. diff --git a/doc/develop/version.rst b/doc/develop/version.rst index 5c9046aa17a..de11836af45 100644 --- a/doc/develop/version.rst +++ b/doc/develop/version.rst @@ -9,7 +9,7 @@ release that came out in October 2020. Release candidates are tagged every few weeks as the project heads to the next release. So 2020.10-rc1 was the first release candidate (RC), tagged soon after 2020.07 was released. -See https://www.denx.de/wiki/view/U-Boot/ReleaseCycle for full details. +See :doc:`release_cycle` for full details. Within the build system, various Makefile variables are created, making use of VERSION, PATCHLEVEL and EXTRAVERSION defined at the top of 'Makefile'. There is -- cgit v1.2.3 From 640582c72bec7c6336b8be1147a76aa9ac7a0078 Mon Sep 17 00:00:00 2001 From: Tom Rini Date: Mon, 26 Aug 2024 11:01:40 -0600 Subject: doc/develop/sending_patches.rst: Reword where our git tree is slightly We shouldn't have had the link to our git tree be contained within "``" as that meant that it did not work as a link, so remove those. And rather than make this a link plus text, keep this as a link within the text for overall clarity. Suggested-by: Quentin Schulz Reviewed-by: Neil Armstrong Reviewed-by: Quentin Schulz Signed-off-by: Tom Rini --- doc/develop/sending_patches.rst | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) (limited to 'doc/develop') diff --git a/doc/develop/sending_patches.rst b/doc/develop/sending_patches.rst index 9308f428bbd..e22b5e3e244 100644 --- a/doc/develop/sending_patches.rst +++ b/doc/develop/sending_patches.rst @@ -76,11 +76,10 @@ General Patch Submission Rules compression, no attachments. Just plain text. The best way to generate patches is by using the ``git format-patch`` command. For a patch that is fixing a bug or regression of some sort, please use the ``master`` branch of - the mainline U-Boot git repository - (``https://source.denx.de/u-boot/u-boot.git``) as reference. For new - features, if the ``next`` branch has been opened (which happens with the - release of ``-rc2``) that branch should be used, otherwise ``master`` is - acceptable. + the mainline U-Boot git repository located at + https://source.denx.de/u-boot/u-boot.git as reference. For new features, if + the ``next`` branch has been opened (which happens with the release of + ``-rc2``) that branch should be used, otherwise ``master`` is acceptable. * Make sure that your mailer does not mangle the patch by automatic changes like wrapping of longer lines etc. -- cgit v1.2.3