@matheusbsbs / matheus-bagliano / commits / 2fd02c92db

Fork 0

manpages: italicize nongit command names (if they are in teletype font)

Some manual pages use teletype font to set command names. We change them to use italics, instead. This creates a visual distinction between names of commands and command lines that can be typed at the command line. It is also more consistent with other man pages outside Git. In this patch, the commands named are non-git commands like bash. Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Jonathan Nieder committed Jul 3, 2008 at 00:55 UTC 2fd02c92dbb6e575b7e62ea9dfa85ef45ebe58b6

12 files changed +24 -24

Documentation/git-apply.txt

+1 -1

@@ -121,7 +121,7 @@ discouraged.

121 --no-add::

122 When applying a patch, ignore additions made by the

123 patch. This can be used to extract the common part between

124 - two files by first running `diff` on them and applying

124 + two files by first running 'diff' on them and applying

125 the result with this option, which would apply the

126 deletion part but not addition part.

127

Documentation/git-cvsserver.txt

+2 -2

@@ -115,7 +115,7 @@ This has the advantage that it will be saved in your 'CVS/Root' files and

115 you don't need to worry about always setting the correct environment

116 variable. SSH users restricted to 'git-shell' don't need to override the default

117 with CVS_SERVER (and shouldn't) as 'git-shell' understands `cvs` to mean

118 -'git-cvsserver' and pretends that the other end runs the real `cvs` better.

118 +'git-cvsserver' and pretends that the other end runs the real 'cvs' better.

119 --

120 2. For each repo that you want accessible from CVS you need to edit config in

121 the repo and add the following section.

@@ -328,7 +328,7 @@ is left blank. But if `gitcvs.allbinary` is set to "guess", then

328 the correct '-k' mode will be guessed based on the contents of

329 the file.

330

331 -For best consistency with `cvs`, it is probably best to override the

331 +For best consistency with 'cvs', it is probably best to override the

332 defaults by setting `gitcvs.usecrlfattr` to true,

333 and `gitcvs.allbinary` to "guess".

334

Documentation/git-fsck.txt

+1 -1

@@ -87,7 +87,7 @@ sorted properly etc), but on the whole if 'git-fsck' is happy, you

87 do have a valid tree.

89 Any corrupt objects you will have to find in backups or other archives

90 -(i.e., you can just remove them and do an `rsync` with some other site in

90 +(i.e., you can just remove them and do an 'rsync' with some other site in

91 the hopes that somebody else has the object you have corrupted).

93 Of course, "valid tree" doesn't mean that it wasn't generated by some

Documentation/git-merge-file.txt

+2 -2

@@ -39,8 +39,8 @@ the alternatives.

39 The exit value of this program is negative on error, and the number of

40 conflicts otherwise. If the merge was clean, the exit value is 0.

42 -'git-merge-file' is designed to be a minimal clone of RCS `merge`; that is, it

43 -implements all of RCS merge's functionality which is needed by

42 +'git-merge-file' is designed to be a minimal clone of RCS 'merge'; that is, it

43 +implements all of RCS 'merge''s functionality which is needed by

44 linkgit:git[1].

Documentation/git-merge-index.txt

+2 -2

@@ -47,9 +47,9 @@ A sample script called 'git-merge-one-file' is included in the

47 distribution.

49 ALERT ALERT ALERT! The git "merge object order" is different from the

50 -RCS `merge` program merge object order. In the above ordering, the

50 +RCS 'merge' program merge object order. In the above ordering, the

51 original is first. But the argument order to the 3-way merge program

52 -`merge` is to have the original in the middle. Don't ask me why.

52 +'merge' is to have the original in the middle. Don't ask me why.

54 Examples:

Documentation/git-rerere.txt

+1 -1

@@ -45,7 +45,7 @@ will automatically invoke this command.

45 This displays diffs for the current state of the resolution. It is

46 useful for tracking what has changed while the user is resolving

47 conflicts. Additional arguments are passed directly to the system

48 -`diff` command installed in PATH.

48 +'diff' command installed in PATH.

50 'status'::

Documentation/git-svn.txt

+1 -1

@@ -565,7 +565,7 @@ branch.

565

566 'git-clone' does not clone branches under the refs/remotes/ hierarchy or

567 any 'git-svn' metadata, or config. So repositories created and managed with

568 -using 'git-svn' should use `rsync` for cloning, if cloning is to be done

568 +using 'git-svn' should use 'rsync' for cloning, if cloning is to be done

569 at all.

570

571 Since 'dcommit' uses rebase internally, any git branches you 'git-push' to

Documentation/git.txt

+1 -1

@@ -486,7 +486,7 @@ other

486 'GIT_SSH'::

487 If this environment variable is set then 'git-fetch'

488 and 'git-push' will use this command instead

489 - of `ssh` when they need to connect to a remote system.

489 + of 'ssh' when they need to connect to a remote system.

490 The '$GIT_SSH' command will be given exactly two arguments:

491 the 'username@host' (or just 'host') from the URL and the

492 shell command to execute on that remote system.

Documentation/gitattributes.txt

+3 -3

@@ -278,7 +278,7 @@ is prefixed with a line of the form:

278

279 The text is called 'hunk header', and by default a line that

280 begins with an alphabet, an underscore or a dollar sign is used,

281 -which matches what GNU `diff -p` output uses. This default

281 +which matches what GNU 'diff -p' output uses. This default

282 selection however is not suited for some contents, and you can

283 use customized pattern to make a selection.

284

@@ -322,7 +322,7 @@ and other programs such as `git revert` and `git cherry-pick`.

322 Set::

323

324 Built-in 3-way merge driver is used to merge the

325 - contents in a way similar to `merge` command of `RCS`

325 + contents in a way similar to 'merge' command of `RCS`

326 suite. This is suitable for ordinary text files.

327

328 Unset::

@@ -426,7 +426,7 @@ Checking whitespace errors

426 ^^^^^^^^^^^^

427

428 The `core.whitespace` configuration variable allows you to define what

429 -`diff` and `apply` should consider whitespace errors for all paths in

429 +'diff' and 'apply' should consider whitespace errors for all paths in

430 the project (See linkgit:git-config[1]). This attribute gives you finer

431 control per path.

432

Documentation/gitcore-tutorial.txt

+7 -7

@@ -61,7 +61,7 @@ Initialized empty Git repository in .git/

61 which is just git's way of saying that you haven't been doing anything

62 strange, and that it will have created a local `.git` directory setup for

63 your new project. You will now have a `.git` directory, and you can

64 -inspect that with `ls`. For your new empty project, it should show you

64 +inspect that with 'ls'. For your new empty project, it should show you

65 three entries, among other things:

67 - a file called `HEAD`, that has `ref: refs/heads/master` in it.

@@ -660,7 +660,7 @@ in the new repository to make sure that the index file is up-to-date.

660

661 Note that the second point is true even across machines. You can

662 duplicate a remote git repository with *any* regular copy mechanism, be it

663 -`scp`, `rsync` or `wget`.

663 +'scp', 'rsync' or 'wget'.

664

665 When copying a remote repository, you'll want to at a minimum update the

666 index cache when you do this, and especially with other peoples'

@@ -1066,9 +1066,9 @@ most efficient way to exchange git objects between repositories.

1066 Local directory::

1067 `/path/to/repo.git/`

1068 +

1069 -This transport is the same as SSH transport but uses `sh` to run

1069 +This transport is the same as SSH transport but uses 'sh' to run

1070 both ends on the local machine instead of running other end on

1071 -the remote machine via `ssh`.

1071 +the remote machine via 'ssh'.

1072

1073 git Native::

1074 `git://remote.machine/path/to/repo.git/`

@@ -1275,8 +1275,8 @@ fatal: merge program failed

1275 describe those three versions, and is responsible to leave the

1276 merge results in the working tree.

1277 It is a fairly straightforward shell script, and

1278 -eventually calls `merge` program from RCS suite to perform a

1279 -file-level 3-way merge. In this case, `merge` detects

1278 +eventually calls 'merge' program from RCS suite to perform a

1279 +file-level 3-way merge. In this case, 'merge' detects

1280 conflicts, and the merge result with conflict marks is left in

1281 the working tree.. This can be seen if you run `ls-files

1282 --stage` again at this point:

@@ -1360,7 +1360,7 @@ program on the `$PATH`.

1360 [NOTE]

1361 Many installations of sshd do not invoke your shell as the login

1362 shell when you directly run programs; what this means is that if

1363 -your login shell is `bash`, only `.bashrc` is read and not

1363 +your login shell is 'bash', only `.bashrc` is read and not

1364 `.bash_profile`. As a workaround, make sure `.bashrc` sets up

1365 `$PATH` so that you can run 'git-receive-pack' program.

1366

Documentation/gitcvs-migration.txt

+2 -2

@@ -34,7 +34,7 @@ $ git clone foo.com:/pub/repo.git/ my-project

34 $ cd my-project

35 ------------------------------------------------

37 -and hack away. The equivalent of `cvs update` is

37 +and hack away. The equivalent of 'cvs update' is

39 ------------------------------------------------

40 $ git pull origin

@@ -60,7 +60,7 @@ $ git push origin master

60 ------------------------------------------------

62 to "push" those commits to the shared repository. If someone else has

63 -updated the repository more recently, 'git-push', like `cvs commit`, will

63 +updated the repository more recently, 'git-push', like 'cvs commit', will

64 complain, in which case you must pull any changes before attempting the

65 push again.

Documentation/gitdiffcore.txt

+1 -1

@@ -14,7 +14,7 @@ DESCRIPTION

15 The diff commands 'git-diff-index', 'git-diff-files', and 'git-diff-tree'

16 can be told to manipulate differences they find in

17 -unconventional ways before showing `diff` output. The manipulation

17 +unconventional ways before showing 'diff' output. The manipulation

18 is collectively called "diffcore transformation". This short note

19 describes what they are and how to use them to produce 'diff' output

20 that is easier to understand than the conventional kind.