diff options
author | Jonathan Nieder <jrnieder@uchicago.edu> | 2008-07-03 00:41:41 -0500 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2008-07-05 11:24:40 -0700 |
commit | ba020ef5eb5fca3d757bd580ff117adaf81ca079 (patch) | |
tree | 974c4e60c9bc212d0ce939b31e8fbb61b5fb1f07 /Documentation/git-commit.txt | |
parent | 0979c106498f21838140313b485f90faf06f454f (diff) | |
download | git-ba020ef5eb5fca3d757bd580ff117adaf81ca079.tar.gz |
manpages: italicize git command names (which were in teletype font)
The names of git commands are not meant to be entered at the
commandline; they are just names. So we render them in italics,
as is usual for command names in manpages.
Using
doit () {
perl -e 'for (<>) { s/\`(git-[^\`.]*)\`/'\''\1'\''/g; print }'
}
for i in git*.txt config.txt diff*.txt blame*.txt fetch*.txt i18n.txt \
merge*.txt pretty*.txt pull*.txt rev*.txt urls*.txt
do
doit <"$i" >"$i+" && mv "$i+" "$i"
done
git diff
.
Signed-off-by: Jonathan Nieder <jrnieder@uchicago.edu>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-commit.txt')
-rw-r--r-- | Documentation/git-commit.txt | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index 03205a4077..01bd2d6b77 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt @@ -20,11 +20,11 @@ with a log message from the user describing the changes. The content to be added can be specified in several ways: -1. by using `git-add` to incrementally "add" changes to the +1. by using 'git-add' to incrementally "add" changes to the index before using the 'commit' command (Note: even modified files must be "added"); -2. by using `git-rm` to remove files from the working tree +2. by using 'git-rm' to remove files from the working tree and the index, again before using the 'commit' command; 3. by listing files as arguments to the 'commit' command, in which @@ -39,15 +39,15 @@ The content to be added can be specified in several ways: 5. by using the --interactive switch with the 'commit' command to decide one by one which files should be part of the commit, before finalizing the - operation. Currently, this is done by invoking `git-add --interactive`. + operation. Currently, this is done by invoking 'git-add --interactive'. -The `git-status` command can be used to obtain a +The 'git-status' command can be used to obtain a summary of what is included by any of the above for the next commit by giving the same set of parameters you would give to this command. If you make a commit and then find a mistake immediately after -that, you can recover from it with `git-reset`. +that, you can recover from it with 'git-reset'. OPTIONS @@ -205,10 +205,10 @@ EXAMPLES -------- When recording your own work, the contents of modified files in your working tree are temporarily stored to a staging area -called the "index" with `git-add`. A file can be +called the "index" with 'git-add'. A file can be reverted back, only in the index but not in the working tree, to that of the last commit with `git reset HEAD -- <file>`, -which effectively reverts `git-add` and prevents the changes to +which effectively reverts 'git-add' and prevents the changes to this file from participating in the next commit. After building the state to be committed incrementally with these commands, `git commit` (without any pathname parameter) is used to record what @@ -264,13 +264,13 @@ $ git commit this second commit would record the changes to `hello.c` and `hello.h` as expected. -After a merge (initiated by `git-merge` or `git-pull`) stops +After a merge (initiated by 'git-merge' or 'git-pull') stops because of conflicts, cleanly merged paths are already staged to be committed for you, and paths that conflicted are left in unmerged state. You would have to first -check which paths are conflicting with `git-status` +check which paths are conflicting with 'git-status' and after fixing them manually in your working tree, you would -stage the result as usual with `git-add`: +stage the result as usual with 'git-add': ------------ $ git status | grep unmerged |