[PATCH] docs: submitting-patches: suggest adding previous version links

[PATCH] docs: submitting-patches: suggest adding previous version links

[SeongJae Park]

For review of patches that revisioned multiple times, patch changelogs
are very useful.  Adding actual links to the previous versions can
further help the review.  Using such links, reviewers can double check
the changelog by themselves, and find previous discussions.  Nowadays
having such links (e.g., lore.kernel.org archive links) is easy and
reliable.  Suggest adding such links if available.

Signed-off-by: SeongJae Park <sj@kernel.org>
---
 Documentation/process/submitting-patches.rst | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/Documentation/process/submitting-patches.rst b/Documentation/process/submitting-patches.rst
index 9a509f1a6873..e69d19ad658f 100644
--- a/Documentation/process/submitting-patches.rst
+++ b/Documentation/process/submitting-patches.rst
@@ -805,7 +805,8 @@ not part of the changelog which gets committed to the git tree. It is
 additional information for the reviewers. If it's placed above the
 commit tags, it needs manual interaction to remove it. If it is below
 the separator line, it gets automatically stripped off when applying the
-patch::
+patch.  If available, adding links to previous versions of the patch (e.g.,
+lore.kernel.org archive link) is recommended to help reviewers::
 
   <commit message>
   ...
@@ -814,6 +815,9 @@ patch::
   V2 -> V3: Removed redundant helper function
   V1 -> V2: Cleaned up coding style and addressed review comments
 
+  v2: https://lore.kernel.org/bar
+  v1: https://lore.kernel.org/foo
+
   path/to/file | 5+++--
   ...
 

base-commit: 7f3c3a0a9103dc92c823f27db3284ac2914e7558
-- 
2.47.3