undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: link generating patch sections

Browse Source 
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>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
John Cai 2023-01-13 16:15:24 +00:00 committed by Junio C Hamano
parent c48035d29b
commit ebdc46c242
2 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Documentation/diff-generate-patch.txt
View File

@ -1,3 +1,4 @@
[[generate_patch_text_with_p]]
Generating patch text with -p
-----------------------------

8
Documentation/diff-options.txt
View File

@ -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[]