git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH v2] docs: link generating patch sections

From
John Cai via GitGitGadget <gitgitgadget@gmail.com>
Date
Jan 13, 2023, 16:15 UTC
Message-ID
<pull.1392.v2.git.git.1673626524221.gitgitgadget@gmail.com>
In-Reply-To
<pull.1392.git.git.1670614892380.gitgitgadget@gmail.com>
From: John Cai <johncai86@gmail.com>

Currently, in the git-log documentation, the reference to generating patches does not match the section title. This can make the section "Generating patch text with -p" hard to find, since typically readers of the documentation will copy and paste to search the page.

Let's make this more convenient for readers by linking it directly to the section.

Since git-log pulls in diff-generate-patch.txt, we can provide a direct link to the section. Otherwise, change the verbiage to match exactly what the section title is, to at least make searching for it an easier task.

Signed-off-by: John Cai <johncai86@gmail.com>
---
    docs: link generating patch sections
    
    Currently, in the git-log documentation, the reference to generating
    patches does not match the section title. This can make the section
    "Generating patch text with -p" hard to find, since typically readers of
    the documentation will copy and paste to search the page.
    
    Let's make this more convenient for readers by linking it directly to
    the section.
    
    Since v1:
    
     * added explicit anchor for generating patch text section
     * adjusted verbiage to include quotations
    
    Signed-off-by: John Cai johncai86@gmail.com
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1392%2Fjohn-cai%2Fjc%2Fdoc-generate-patch-v2
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1392/john-cai/jc/doc-generate-patch-v2
Pull-Request: https://github.com/git/git/pull/1392
Range-diff vs v1:
 1:  88e7e52fbc6 ! 1:  087f9b8d63a docs: link generating patch sections
     @@ Commit message
      
          Signed-off-by: John Cai <johncai86@gmail.com>
      
     + ## Documentation/diff-generate-patch.txt ##
     +@@
     ++[[generate_patch_text_with_p]]
     + Generating patch text with -p
     + -----------------------------
     + 
     +
       ## Documentation/diff-options.txt ##
      @@ Documentation/diff-options.txt: ifndef::git-format-patch[]
       -p::
       -u::
       --patch::
      -	Generate patch (see section on generating patches).
     -+	Generate patch (see section on
     ++	Generate patch (see section titled
      +ifdef::git-log[]
     -+<<_generating_patch_text_with_p, generating patches>>).
     ++<<generate_patch_text_with_p, "Generating patch text with -p">>).
      +endif::git-log[]
      +ifndef::git-log[]
     -+Generate patch text with -p).
     ++"Generating patch text with -p").
      +endif::git-log[]
       ifdef::git-diff[]
       	This is the default.
 Documentation/diff-generate-patch.txt | 1 +
 Documentation/diff-options.txt        | 8 +++++++-
 2 files changed, 8 insertions(+), 1 deletion(-)
diff --git a/Documentation/diff-generate-patch.txt b/Documentation/diff-generate-patch.txt
index c78063d4f74..546adf79e5a 100644
--- a/Documentation/diff-generate-patch.txt
+++ b/Documentation/diff-generate-patch.txt
@@ -1,3 +1,4 @@
+[[generate_patch_text_with_p]]
 Generating patch text with -p
 -----------------------------
 
diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt
index 3674ac48e92..7d73e976d99 100644
--- a/Documentation/diff-options.txt
+++ b/Documentation/diff-options.txt
@@ -22,7 +22,13 @@ ifndef::git-format-patch[]
 -p::
 -u::
 --patch::
-	Generate patch (see section on generating patches).
+	Generate patch (see section titled
+ifdef::git-log[]
+<<generate_patch_text_with_p, "Generating patch text with -p">>).
+endif::git-log[]
+ifndef::git-log[]
+"Generating patch text with -p").
+endif::git-log[]
 ifdef::git-diff[]
 	This is the default.
 endif::git-diff[]

base-commit: a38d39a4c50d1275833aba54c4dbdfce9e2e9ca1
-- 
gitgitgadget
Previous: John Cai
Message 4 of 4 in “docs: link generating patch sections”
  1. docs: link generating patch sectionsJohn Cai via GitGitGadget, Dec 9, 2022
  2. Junio C HamanoDec 10, 2022
  3. John CaiJan 13, 2023
  4. docs: link generating patch sectionsJohn Cai via GitGitGadget, Jan 13, 2023

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.