Documentation: avoid stray backslashes in core tutorial
While at it: - remove some single-quotes that were being rendered as ’\n\'; - do not escape ellipses (...) when they do not represent the literal three characters "...". We may want to ensure the manpages render these as three ASCII periods to make the manual pages easier to search, but that would be a global output generation setting, not a context-specific thing; Reported-by: Frédéric Brière <fbriere@fbriere.net> Signed-off-by: Jonathan Nieder <jrnieder@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Jonathan Nieder committed
Aug 20, 2010 at 05:37 UTC
70676e69a58025ff6e224bd6f0ed80ae1b158388
1 file changed
+9
-9
Documentation/gitcore-tutorial.txt
+9
-9
@@ -110,7 +110,7 @@ An 'object' is identified by its 160-bit SHA1 hash, aka 'object name',
110
and a reference to an object is always the 40-byte hex
111
representation of that SHA1 name. The files in the `refs`
112
subdirectory are expected to contain these hex references
113
-(usually with a final `\'\n\'` at the end), and you should thus
113
+(usually with a final `\n` at the end), and you should thus
114
expect to see a number of 41-byte files containing these
115
references in these `refs` subdirectories when you actually start
116
populating your tree.
@@ -310,7 +310,7 @@ and this will just output the name of the resulting tree, in this case
310
----------------
311
312
which is another incomprehensible object name. Again, if you want to,
313
-you can use `git cat-file -t 8988d\...` to see that this time the object
313
+you can use `git cat-file -t 8988d...` to see that this time the object
314
is not a "blob" object, but a "tree" object (you can also use
315
`git cat-file` to actually output the raw object contents, but you'll see
316
mainly a binary mess, so that's less interesting).
@@ -436,8 +436,8 @@ $ git update-index hello
436
(note how we didn't need the `\--add` flag this time, since git knew
437
about the file already).
438
439
-Note what happens to the different 'git diff-\*' versions here. After
440
-we've updated `hello` in the index, `git diff-files -p` now shows no
439
+Note what happens to the different 'git diff-{asterisk}' versions here.
440
+After we've updated `hello` in the index, `git diff-files -p` now shows no
441
differences, but `git diff-index -p HEAD` still *does* show that the
442
current state is different from the state we committed. In fact, now
443
'git diff-index' shows the same difference whether we use the `--cached`
@@ -494,7 +494,7 @@ and it will show what the last commit (in `HEAD`) actually changed.
494
[NOTE]
495
============
496
Here is an ASCII art by Jon Loeliger that illustrates how
497
-various diff-\* commands compare things.
497
+various 'diff-{asterisk}' commands compare things.
498
499
diff-tree
500
+----+
@@ -958,11 +958,11 @@ $ git show-branch --topo-order --more=1 master mybranch
958
The first two lines indicate that it is showing the two branches
959
and the first line of the commit log message from their
960
top-of-the-tree commits, you are currently on `master` branch
961
-(notice the asterisk `\*` character), and the first column for
961
+(notice the asterisk `{asterisk}` character), and the first column for
962
the later output lines is used to show commits contained in the
963
`master` branch, and the second column for the `mybranch`
964
branch. Three commits are shown along with their log messages.
965
-All of them have non blank characters in the first column (`*`
965
+All of them have non blank characters in the first column (`{asterisk}`
966
shows an ordinary commit on the current branch, `-` is a merge commit), which
967
means they are now part of the `master` branch. Only the "Some
968
work" commit has the plus `+` character in the second column,
@@ -1092,7 +1092,7 @@ Downloader from http and https URL
1092
first obtains the topmost commit object name from the remote site
1093
by looking at the specified refname under `repo.git/refs/` directory,
1094
and then tries to obtain the
1095
-commit object by downloading from `repo.git/objects/xx/xxx\...`
1095
+commit object by downloading from `repo.git/objects/xx/xxx...`
1096
using the object name of that commit object. Then it reads the
1097
commit object to find out its parent commits and the associate
1098
tree object; it repeats this process until it gets all the
@@ -1420,7 +1420,7 @@ packed, and stores the packed file in `.git/objects/pack`
1420
directory.
1421
1422
[NOTE]
1423
-You will see two files, `pack-\*.pack` and `pack-\*.idx`,
1423
+You will see two files, `pack-{asterisk}.pack` and `pack-{asterisk}.idx`,
1424
in `.git/objects/pack` directory. They are closely related to
1425
each other, and if you ever copy them by hand to a different
1426
repository for whatever reason, you should make sure you copy