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

git-filter-branch.txt: wrap "maths" notation in backticks

Browse Source 
In this paragraph, we have a few instances of the '^' character, which
we give as "\^". This renders well with AsciiDoc ("^"), but Asciidoctor
renders it literally as "\^". Dropping the backslashes renders fine
with Asciidoctor, but not AsciiDoc...

An earlier version of this patch used "{caret}" instead of "^", which
avoided these escaping problems. The rendering was still so-so, though
-- these expressions end up set as normal text, similarly to when one
provides, e.g., computer code in the middle of running text, without
properly marking it with `backticks` to be monospaced.

As noted by Jeff King, this suggests actually wrapping these
expressions in backticks, setting them in monospace.

The lone "5" could be left as is or wrapped as `5`. Spell it out as
"five" instead -- this generally looks better anyway for small numbers
in the middle of text like this.

Suggested-by: Jeff King <peff@peff.net>
Signed-off-by: Martin Ågren <martin.agren@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Martin Ågren 2020-02-03 21:36:50 +01:00 committed by Junio C Hamano
parent 0ad7144999
commit e469afe158
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Documentation/git-filter-branch.txt
View File

@ -467,9 +467,9 @@ impossible for a backward-compatible implementation to ever be fast:
* In editing files, git-filter-branch by design checks out each and * In editing files, git-filter-branch by design checks out each and
every commit as it existed in the original repo. If your repo has every commit as it existed in the original repo. If your repo has
10\^5 files and 10\^5 commits, but each commit only modifies 5 `10^5` files and `10^5` commits, but each commit only modifies five
files, then git-filter-branch will make you do 10\^10 modifications, files, then git-filter-branch will make you do `10^10` modifications,
despite only having (at most) 5*10^5 unique blobs. despite only having (at most) `5*10^5` unique blobs.
* If you try and cheat and try to make git-filter-branch only work on * If you try and cheat and try to make git-filter-branch only work on
files modified in a commit, then two things happen files modified in a commit, then two things happen