Skip to content

Commit b803ae4

Browse files
Patrick Steinhardtgitster
authored andcommitted
docs/diffcore: unquote "Complete Rewrites" in headers
The gitdiffcore documentation quotes the term "Complete Rewrites" in headers for no real gain. This would make sense if the term could be easily confused if not properly grouped together. But actually, the term is quite obvious and thus does not really need any quoting, especially regarding that it is not used anywhere else. But more importanly, this brings up a bug when rendering man pages: when trying to render quotes inside of a section header, we end up with quotes which have been misaligned to the end of line. E.g. diffcore-break: For Splitting Up Complete Rewrites -------------------------------------------------- renders as DIFFCORE-BREAK: FOR SPLITTING UP COMPLETE REWRITES"" , which is obviously wrong. While this is fixable for the man pages by using double-quotes (e.g. ""COMPLETE REWRITES""), this again breaks it for our generated HTML pages. So fix the issue by simply dropping quotes inside of section headers, which is currently only done for the term "Complete Rewrites". Signed-off-by: Patrick Steinhardt <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 1aa3819 commit b803ae4

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

Documentation/gitdiffcore.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -84,8 +84,8 @@ format sections of the manual for 'git diff-{asterisk}' commands) or
8484
diff-patch format.
8585

8686

87-
diffcore-break: For Splitting Up "Complete Rewrites"
88-
----------------------------------------------------
87+
diffcore-break: For Splitting Up Complete Rewrites
88+
--------------------------------------------------
8989

9090
The second transformation in the chain is diffcore-break, and is
9191
controlled by the -B option to the 'git diff-{asterisk}' commands. This is
@@ -177,8 +177,8 @@ the expense of making it slower. Without `--find-copies-harder`,
177177
copied happened to have been modified in the same changeset.
178178

179179

180-
diffcore-merge-broken: For Putting "Complete Rewrites" Back Together
181-
--------------------------------------------------------------------
180+
diffcore-merge-broken: For Putting Complete Rewrites Back Together
181+
------------------------------------------------------------------
182182

183183
This transformation is used to merge filepairs broken by
184184
diffcore-break, and not transformed into rename/copy by

0 commit comments

Comments
 (0)