diff mbox series

Documentation: maintainer-tip: Rectify link to "Describe your changes" section of submitting-patches.rst

Message ID 20230320124327.174881-1-bagasdotme@gmail.com
State New
Headers
Series Documentation: maintainer-tip: Rectify link to "Describe your changes" section of submitting-patches.rst |

Commit Message

Bagas Sanjaya March 20, 2023, 12:43 p.m. UTC 
  The general changelog rules for the tip tree refers to "Describe your
changes" section of submitting patches guide. However, the internal link
reference targets to non-existent "submittingpatches" label, which
brings reader to the top of the linked doc.

Correct the target. No changes to submitting-patches.rst since the
required label is already there.

Fixes: 31c9d7c8297558 ("Documentation/process: Add tip tree handbook")
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 This patch is based on core/urgent branch of tip tree.

 Documentation/process/maintainer-tip.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)


base-commit: 3e2619c4ebba2cab8414c55b131b7a28f628de3b

Comments

Thomas Gleixner March 22, 2023, 10:14 a.m. UTC | #1 
On Mon, Mar 20 2023 at 19:43, Bagas Sanjaya wrote:
> The general changelog rules for the tip tree refers to "Describe your
> changes" section of submitting patches guide. However, the internal link
> reference targets to non-existent "submittingpatches" label, which
> brings reader to the top of the linked doc.
>
> Correct the target. No changes to submitting-patches.rst since the
> required label is already there.
>
> Fixes: 31c9d7c8297558 ("Documentation/process: Add tip tree handbook")
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>

In cass Jonathan is picking this up:

Reviewed-by: Thomas Gleixner <tglx@linutronix.de>

> ---
>  This patch is based on core/urgent branch of tip tree.

Why? Picking a random branch to base patches on is not really
helpful. It has zero dependencies on that branch.

Thanks,

        tglx
Jonathan Corbet March 23, 2023, 5:26 p.m. UTC | #2 
Thomas Gleixner <tglx@linutronix.de> writes:

> On Mon, Mar 20 2023 at 19:43, Bagas Sanjaya wrote:
>> The general changelog rules for the tip tree refers to "Describe your
>> changes" section of submitting patches guide. However, the internal link
>> reference targets to non-existent "submittingpatches" label, which
>> brings reader to the top of the linked doc.
>>
>> Correct the target. No changes to submitting-patches.rst since the
>> required label is already there.
>>
>> Fixes: 31c9d7c8297558 ("Documentation/process: Add tip tree handbook")
>> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
>
> In cass Jonathan is picking this up:
>
> Reviewed-by: Thomas Gleixner <tglx@linutronix.de>

I've applied it, thanks.

jon
diff mbox series

Patch

diff --git a/Documentation/process/maintainer-tip.rst b/Documentation/process/maintainer-tip.rst
index 572a3289c9cbf3..178c95fd17dcad 100644
--- a/Documentation/process/maintainer-tip.rst
+++ b/Documentation/process/maintainer-tip.rst
@@ -128,8 +128,8 @@  uppercase letter and should be written in imperative tone.
 Changelog
 ^^^^^^^^^
 
-The general rules about changelogs in the process documentation, see
-:ref:`Documentation/process/ <submittingpatches>`, apply.
+The general rules about changelogs in the :ref:`Submitting patches guide
+<describe_changes>`, apply.
 
 The tip tree maintainers set value on following these rules, especially on
 the request to write changelogs in imperative mood and not impersonating