Skip to content

Commit e469afe

Browse files
Martin Ågrengitster
authored andcommitted
git-filter-branch.txt: wrap "maths" notation in backticks
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 <[email protected]> Signed-off-by: Martin Ågren <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 0ad7144 commit e469afe

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

Documentation/git-filter-branch.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -467,9 +467,9 @@ impossible for a backward-compatible implementation to ever be fast:
467467

468468
* In editing files, git-filter-branch by design checks out each and
469469
every commit as it existed in the original repo. If your repo has
470-
10\^5 files and 10\^5 commits, but each commit only modifies 5
471-
files, then git-filter-branch will make you do 10\^10 modifications,
472-
despite only having (at most) 5*10^5 unique blobs.
470+
`10^5` files and `10^5` commits, but each commit only modifies five
471+
files, then git-filter-branch will make you do `10^10` modifications,
472+
despite only having (at most) `5*10^5` unique blobs.
473473

474474
* If you try and cheat and try to make git-filter-branch only work on
475475
files modified in a commit, then two things happen

0 commit comments

Comments
 (0)