]> git.ipfire.org Git - thirdparty/man-pages.git/commitdiff
CONTRIBUTING.d/patches/range-diff: Add file documenting the range-diff between patch...
authorAlejandro Colomar <alx@kernel.org>
Wed, 6 Nov 2024 21:20:15 +0000 (22:20 +0100)
committerAlejandro Colomar <alx@kernel.org>
Wed, 6 Nov 2024 22:40:19 +0000 (23:40 +0100)
Signed-off-by: Alejandro Colomar <alx@kernel.org>
CONTRIBUTING.d/patches/patches
CONTRIBUTING.d/patches/range-diff [new file with mode: 0644]

index 85f9f5a445c1ffd04a964992da0b2fb6020152c1..27957aee9c8f3f5b4399317a6287b627fb8b53ba 100644 (file)
@@ -27,36 +27,6 @@ Description
        -  Make patches against the latest version of the manual page.
           Use git(1) for getting the latest version.
 
-   Prepare the patches for email submission
-       We recommend using git-format-patch(1) to prepare the patches.
-       Please use --range-diff to document the differences between
-       revisions of the patch set, even in the first revision.
-
-       To prepare a branch to be sent as a patch set (v1):
-
-           $ git format-patch -o ./patches master..HEAD \
-                   --range-diff=master -v1 --cover-letter;
-
-       The range diff will be included in the cover letter (or in a
-       single patch, if there is only one):
-
-           $ tail -n7 ./patches/v1-0000-cover-letter.patch;
-           Range-diff against v0:
-           -:  --------- > 1:  7ec952012 foo.3: tfix
-           -:  --------- > 2:  d80376b08 bar.3: ffix
-           -:  --------- > 3:  892a12470 foo.3: wfix
-           --
-           2.43.0
-
-       To send a v2 after some feedback:
-
-           $ git format-patch -o ./patches master..HEAD \
-                   --range-diff=old_master..old_HEAD -v2 --cover-letter;
-
-       The values for 'old_master' and 'old_HEAD' can be consulted in
-       the previous cover letter.  In this example, it would be
-       '--range-diff=7ec952012^..892a12470'.
-
    Send the patches
        We recommend using git-send-email(1) to send the patches to the
        mailing list.  For instructions on how to configure and use it,
@@ -92,6 +62,5 @@ See also
        CONTRIBUTING.d/*
 
        <https://www.kernel.org/doc/Documentation/process/submitting-patches.rst>
-       <https://inbox.sourceware.org/gcc/ZiV5unTogyI7rPJA@debian/>
        <https://git-send-email.io/>
        <https://neomutt.org/feature/cli-crypto>
diff --git a/CONTRIBUTING.d/patches/range-diff b/CONTRIBUTING.d/patches/range-diff
new file mode 100644 (file)
index 0000000..362a3ae
--- /dev/null
@@ -0,0 +1,37 @@
+Name
+       patches/range-diff - instructions for producing a range-diff
+
+Description
+       We recommend using git-format-patch(1) to prepare the patches.
+       Please use --range-diff to document the differences between
+       revisions of the patch set, even in the first revision.
+
+       To prepare a git(1) branch to be sent as a patch set (v1):
+
+               $ git format-patch -o ./patches master..HEAD \
+                       --range-diff=master -v1 \
+                       --cover-letter;
+
+       The range diff will be included in the cover letter (or in a
+       single patch, if there is only one):
+
+               $ tail -n7 ./patches/v1-0000-cover-letter.patch;
+               Range-diff against v0:
+               -:  --------- > 1:  7ec952012 foo.3: tfix
+               -:  --------- > 2:  d80376b08 bar.3: ffix
+               -:  --------- > 3:  892a12470 foo.3: wfix
+               --
+               2.43.0
+
+       To send a v2 after some feedback:
+
+               $ git format-patch -o ./patches master..HEAD \
+                       --range-diff=old_master..old_HEAD -v2 \
+                       --cover-letter;
+
+       The values for 'old_master' and 'old_HEAD' can be consulted in
+       the previous cover letter.  In this example, it would be
+       '--range-diff=7ec952012^..892a12470'.
+
+See also
+       <https://inbox.sourceware.org/gcc/ZiV5unTogyI7rPJA@debian/>