From ba020ef5eb5fca3d757bd580ff117adaf81ca079 Mon Sep 17 00:00:00 2001 From: Jonathan Nieder Date: Thu, 3 Jul 2008 00:41:41 -0500 Subject: [PATCH] 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 Signed-off-by: Junio C Hamano --- Documentation/config.txt | 54 ++++---- Documentation/fetch-options.txt | 8 +- Documentation/git-am.txt | 14 +- Documentation/git-apply.txt | 10 +- Documentation/git-archimport.txt | 12 +- Documentation/git-archive.txt | 6 +- Documentation/git-bisect.txt | 6 +- Documentation/git-blame.txt | 8 +- Documentation/git-branch.txt | 8 +- Documentation/git-bundle.txt | 26 ++-- Documentation/git-check-ref-format.txt | 2 +- Documentation/git-checkout-index.txt | 8 +- Documentation/git-checkout.txt | 4 +- Documentation/git-cherry-pick.txt | 2 +- Documentation/git-cherry.txt | 6 +- Documentation/git-citool.txt | 4 +- Documentation/git-clean.txt | 4 +- Documentation/git-clone.txt | 6 +- Documentation/git-commit-tree.txt | 2 +- Documentation/git-commit.txt | 20 +-- Documentation/git-config.txt | 12 +- Documentation/git-cvsexportcommit.txt | 2 +- Documentation/git-cvsimport.txt | 18 +-- Documentation/git-cvsserver.txt | 38 +++--- Documentation/git-daemon.txt | 40 +++--- Documentation/git-describe.txt | 6 +- Documentation/git-diff-files.txt | 2 +- Documentation/git-diff-index.txt | 20 +-- Documentation/git-diff-tree.txt | 10 +- Documentation/git-fast-export.txt | 8 +- Documentation/git-fast-import.txt | 20 +-- Documentation/git-fetch-pack.txt | 14 +- Documentation/git-fetch.txt | 2 +- Documentation/git-filter-branch.txt | 14 +- Documentation/git-fmt-merge-msg.txt | 4 +- Documentation/git-for-each-ref.txt | 2 +- Documentation/git-format-patch.txt | 6 +- Documentation/git-fsck.txt | 4 +- Documentation/git-gc.txt | 20 +-- Documentation/git-get-tar-commit-id.txt | 6 +- Documentation/git-grep.txt | 2 +- Documentation/git-gui.txt | 20 +-- Documentation/git-hash-object.txt | 2 +- Documentation/git-help.txt | 6 +- Documentation/git-http-fetch.txt | 2 +- Documentation/git-imap-send.txt | 2 +- Documentation/git-index-pack.txt | 8 +- Documentation/git-init.txt | 6 +- Documentation/git-instaweb.txt | 2 +- Documentation/git-log.txt | 4 +- Documentation/git-ls-files.txt | 6 +- Documentation/git-ls-remote.txt | 2 +- Documentation/git-mailinfo.txt | 4 +- Documentation/git-merge-base.txt | 4 +- Documentation/git-merge-file.txt | 10 +- Documentation/git-merge-index.txt | 8 +- Documentation/git-merge-one-file.txt | 4 +- Documentation/git-merge.txt | 16 +-- Documentation/git-mergetool.txt | 16 +-- Documentation/git-name-rev.txt | 6 +- Documentation/git-pack-objects.txt | 6 +- Documentation/git-pack-redundant.txt | 2 +- Documentation/git-parse-remote.txt | 2 +- Documentation/git-patch-id.txt | 2 +- Documentation/git-peek-remote.txt | 6 +- Documentation/git-prune.txt | 14 +- Documentation/git-pull.txt | 10 +- Documentation/git-push.txt | 4 +- Documentation/git-read-tree.txt | 42 +++--- Documentation/git-rebase.txt | 26 ++-- Documentation/git-receive-pack.txt | 12 +- Documentation/git-repack.txt | 14 +- Documentation/git-rerere.txt | 28 ++-- Documentation/git-reset.txt | 2 +- Documentation/git-rev-list.txt | 6 +- Documentation/git-rev-parse.txt | 24 ++-- Documentation/git-revert.txt | 4 +- Documentation/git-rm.txt | 4 +- Documentation/git-send-pack.txt | 10 +- Documentation/git-sh-setup.txt | 2 +- Documentation/git-shell.txt | 2 +- Documentation/git-shortlog.txt | 2 +- Documentation/git-show-branch.txt | 2 +- Documentation/git-show-index.txt | 4 +- Documentation/git-show-ref.txt | 4 +- Documentation/git-show.txt | 6 +- Documentation/git-stash.txt | 6 +- Documentation/git-status.txt | 6 +- Documentation/git-submodule.txt | 4 +- Documentation/git-svn.txt | 106 ++++++++-------- Documentation/git-symbolic-ref.txt | 2 +- Documentation/git-tag.txt | 8 +- Documentation/git-tar-tree.txt | 6 +- Documentation/git-update-index.txt | 22 ++-- Documentation/git-upload-archive.txt | 2 +- Documentation/git-upload-pack.txt | 6 +- Documentation/git-var.txt | 2 +- Documentation/git-verify-pack.txt | 2 +- Documentation/git-verify-tag.txt | 2 +- Documentation/git-web--browse.txt | 6 +- Documentation/git-whatchanged.txt | 4 +- Documentation/git-write-tree.txt | 8 +- Documentation/git.txt | 8 +- Documentation/gitattributes.txt | 16 +-- Documentation/gitcore-tutorial.txt | 162 ++++++++++++------------ Documentation/gitcvs-migration.txt | 12 +- Documentation/gitdiffcore.txt | 30 ++--- Documentation/githooks.txt | 74 +++++------ Documentation/gitignore.txt | 4 +- Documentation/gitk.txt | 2 +- Documentation/gitrepository-layout.txt | 18 +-- Documentation/gittutorial-2.txt | 16 +-- Documentation/gittutorial.txt | 42 +++--- Documentation/i18n.txt | 4 +- Documentation/merge-options.txt | 4 +- Documentation/pull-fetch-param.txt | 8 +- Documentation/urls-remotes.txt | 4 +- 117 files changed, 712 insertions(+), 712 deletions(-) diff --git a/Documentation/config.txt b/Documentation/config.txt index 93a6a83b9..f7a54f65b 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -63,7 +63,7 @@ The values following the equals sign in variable assign are all either a string, an integer, or a boolean. Boolean values may be given as yes/no, 0/1 or true/false. Case is not significant in boolean values, when converting value to the canonical form using '--bool' type specifier; -`git-config` will ensure that the output is "true" or "false". +'git-config' will ensure that the output is "true" or "false". String values may be entirely or partially enclosed in double quotes. You need to enclose variable value in double quotes if you want to @@ -356,8 +356,8 @@ core.pager:: core.whitespace:: A comma separated list of common whitespace problems to - notice. `git-diff` will use `color.diff.whitespace` to - highlight them, and `git-apply --whitespace=error` will + notice. 'git-diff' will use `color.diff.whitespace` to + highlight them, and 'git-apply --whitespace=error' will consider them as errors: + * `trailing-space` treats trailing whitespaces at the end of the line @@ -396,11 +396,11 @@ it will be treated as a shell command. For example, defining "gitk --all --not ORIG_HEAD". apply.whitespace:: - Tells `git-apply` how to handle whitespaces, in the same way + Tells 'git-apply' how to handle whitespaces, in the same way as the '--whitespace' option. See linkgit:git-apply[1]. branch.autosetupmerge:: - Tells `git-branch` and `git-checkout` to setup new branches + Tells 'git-branch' and 'git-checkout' to setup new branches so that linkgit:git-pull[1] will appropriately merge from the starting point branch. Note that even if this option is not set, this behavior can be chosen per-branch using the `--track` @@ -411,7 +411,7 @@ branch.autosetupmerge:: branch. This option defaults to true. branch.autosetuprebase:: - When a new branch is created with `git-branch` or `git-checkout` + When a new branch is created with 'git-branch' or 'git-checkout' that tracks another branch, this variable tells git to set up pull to rebase instead of merge (see "branch..rebase"). When `never`, rebase is never automatically set to true. @@ -426,20 +426,20 @@ branch.autosetuprebase:: This option defaults to never. branch..remote:: - When in branch , it tells `git-fetch` which remote to fetch. - If this option is not given, `git-fetch` defaults to remote "origin". + When in branch , it tells 'git-fetch' which remote to fetch. + If this option is not given, 'git-fetch' defaults to remote "origin". branch..merge:: - When in branch , it tells `git-fetch` the default + When in branch , it tells 'git-fetch' the default refspec to be marked for merging in FETCH_HEAD. The value is handled like the remote part of a refspec, and must match a ref which is fetched from the remote given by "branch..remote". - The merge information is used by `git-pull` (which at first calls - `git-fetch`) to lookup the default branch for merging. Without - this option, `git-pull` defaults to merge the first refspec fetched. + The merge information is used by 'git-pull' (which at first calls + 'git-fetch') to lookup the default branch for merging. Without + this option, 'git-pull' defaults to merge the first refspec fetched. Specify multiple values to get an octopus merge. - If you wish to setup `git-pull` so that it merges into from + If you wish to setup 'git-pull' so that it merges into from another branch in the local repository, you can point branch..merge to the desired branch, and use the special setting `.` (a period) for branch..remote. @@ -513,7 +513,7 @@ color.interactive:: colors only when the output is to the terminal. Defaults to false. color.interactive.:: - Use customized color for `git-add --interactive` + Use customized color for 'git-add --interactive' output. `` may be `prompt`, `header`, or `help`, for three distinct types of normal output from interactive programs. The values of these variables may be specified as @@ -550,14 +550,14 @@ color.ui:: take precedence over this setting. Defaults to false. diff.autorefreshindex:: - When using `git-diff` to compare with work tree + When using 'git-diff' to compare with work tree files, do not consider stat-only change as changed. Instead, silently run `git update-index --refresh` to update the cached stat information for paths whose contents in the work tree match the contents in the index. This option defaults to true. Note that this - affects only `git-diff` Porcelain, and not lower level - `diff` commands, such as `git-diff-files`. + affects only 'git-diff' Porcelain, and not lower level + `diff` commands, such as 'git-diff-files'. diff.external:: If this config variable is set, diff generation is not @@ -625,37 +625,37 @@ gc.autopacklimit:: default value is 50. Setting this to 0 disables it. gc.packrefs:: - `git-gc` does not run `git pack-refs` in a bare repository by + 'git-gc' does not run `git pack-refs` in a bare repository by default so that older dumb-transport clients can still fetch - from the repository. Setting this to `true` lets `git-gc` + from the repository. Setting this to `true` lets 'git-gc' to run `git pack-refs`. Setting this to `false` tells - `git-gc` never to run `git pack-refs`. The default setting is + 'git-gc' never to run `git pack-refs`. The default setting is `notbare`. Enable it only when you know you do not have to support such clients. The default setting will change to `true` at some stage, and setting this to `false` will continue to - prevent `git pack-refs` from being run from `git-gc`. + prevent `git pack-refs` from being run from 'git-gc'. gc.pruneexpire:: - When `git-gc` is run, it will call `prune --expire 2.weeks.ago`. + When 'git-gc' is run, it will call `prune --expire 2.weeks.ago`. Override the grace period with this config variable. gc.reflogexpire:: - `git-reflog expire` removes reflog entries older than + 'git-reflog expire' removes reflog entries older than this time; defaults to 90 days. gc.reflogexpireunreachable:: - `git-reflog expire` removes reflog entries older than + 'git-reflog expire' removes reflog entries older than this time and are not reachable from the current tip; defaults to 30 days. gc.rerereresolved:: Records of conflicted merge you resolved earlier are - kept for this many days when `git-rerere gc` is run. + kept for this many days when 'git-rerere gc' is run. The default is 60 days. See linkgit:git-rerere[1]. gc.rerereunresolved:: Records of conflicted merge you have not resolved are - kept for this many days when `git-rerere gc` is run. + kept for this many days when 'git-rerere gc' is run. The default is 15 days. See linkgit:git-rerere[1]. rerere.enabled:: @@ -821,7 +821,7 @@ i18n.commitEncoding:: i18n.logOutputEncoding:: Character encoding the commit messages are converted to when - running `git-log` and friends. + running 'git-log' and friends. instaweb.browser:: Specify the program that will be used to browse your working diff --git a/Documentation/fetch-options.txt b/Documentation/fetch-options.txt index 85c87180d..d313795fd 100644 --- a/Documentation/fetch-options.txt +++ b/Documentation/fetch-options.txt @@ -21,7 +21,7 @@ -f:: --force:: - When `git-fetch` is used with `:` + When 'git-fetch' is used with `:` refspec, it refuses to update the local branch `` unless the remote branch `` it fetches is a descendant of ``. This option @@ -53,10 +53,10 @@ endif::git-pull[] -u:: --update-head-ok:: - By default `git-fetch` refuses to update the head which + By default 'git-fetch' refuses to update the head which corresponds to the current branch. This flag disables the - check. This is purely for the internal use for `git-pull` - to communicate with `git-fetch`, and unless you are + check. This is purely for the internal use for 'git-pull' + to communicate with 'git-fetch', and unless you are implementing your own Porcelain you are not supposed to use it. diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt index 1296b9117..3863eebce 100644 --- a/Documentation/git-am.txt +++ b/Documentation/git-am.txt @@ -35,11 +35,11 @@ OPTIONS -k:: --keep:: - Pass `-k` flag to `git-mailinfo` (see linkgit:git-mailinfo[1]). + Pass `-k` flag to 'git-mailinfo' (see linkgit:git-mailinfo[1]). -u:: --utf8:: - Pass `-u` flag to `git-mailinfo` (see linkgit:git-mailinfo[1]). + Pass `-u` flag to 'git-mailinfo' (see linkgit:git-mailinfo[1]). The proposed commit log message taken from the e-mail is re-coded into UTF-8 encoding (configuration variable `i18n.commitencoding` can be used to specify project's @@ -49,7 +49,7 @@ This was optional in prior versions of git, but now it is the default. You could use `--no-utf8` to override this. --no-utf8:: - Pass `-n` flag to `git-mailinfo` (see + Pass `-n` flag to 'git-mailinfo' (see linkgit:git-mailinfo[1]). -3:: @@ -61,17 +61,17 @@ default. You could use `--no-utf8` to override this. -b:: --binary:: - Pass `--allow-binary-replacement` flag to `git-apply` + Pass `--allow-binary-replacement` flag to 'git-apply' (see linkgit:git-apply[1]). --whitespace=