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 | |
| parent | manpages: italicize command names (diff) | |
| download | tgif-ba020ef5eb5fca3d757bd580ff117adaf81ca079.tar.xz | |
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>
117 files changed, 712 insertions, 712 deletions
diff --git a/Documentation/config.txt b/Documentation/config.txt index 93a6a83b95..f7a54f65b0 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.<name>.rebase"). When `never`, rebase is never automatically set to true. @@ -426,20 +426,20 @@ branch.autosetuprebase:: This option defaults to never. branch.<name>.remote:: - When in branch <name>, it tells `git-fetch` which remote to fetch. - If this option is not given, `git-fetch` defaults to remote "origin". + When in branch <name>, it tells 'git-fetch' which remote to fetch. + If this option is not given, 'git-fetch' defaults to remote "origin". branch.<name>.merge:: - When in branch <name>, it tells `git-fetch` the default + When in branch <name>, 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.<name>.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 <name> from + If you wish to setup 'git-pull' so that it merges into <name> from another branch in the local repository, you can point branch.<name>.merge to the desired branch, and use the special setting `.` (a period) for branch.<name>.remote. @@ -513,7 +513,7 @@ color.interactive:: colors only when the output is to the terminal. Defaults to false. color.interactive.<slot>:: - Use customized color for `git-add --interactive` + Use customized color for 'git-add --interactive' output. `<slot>` 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 85c87180db..d313795fdb 100644 --- a/Documentation/fetch-options.txt +++ b/Documentation/fetch-options.txt @@ -21,7 +21,7 @@ -f:: --force:: - When `git-fetch` is used with `<rbranch>:<lbranch>` + When 'git-fetch' is used with `<rbranch>:<lbranch>` refspec, it refuses to update the local branch `<lbranch>` unless the remote branch `<rbranch>` it fetches is a descendant of `<lbranch>`. 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 1296b91172..3863eebcef 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=<option>:: - This flag is passed to the `git-apply` (see linkgit:git-apply[1]) + This flag is passed to the 'git-apply' (see linkgit:git-apply[1]) program that applies the patch. -C<n>:: -p<n>:: - These flags are passed to the `git-apply` (see linkgit:git-apply[1]) + These flags are passed to the 'git-apply' (see linkgit:git-apply[1]) program that applies the patch. @@ -97,7 +97,7 @@ default. You could use `--no-utf8` to override this. to the screen before exiting. This overrides the standard message informing you to use `--resolved` or `--skip` to handle the failure. This is solely - for internal use between `git-rebase` and `git-am`. + for internal use between 'git-rebase' and 'git-am'. DISCUSSION ---------- diff --git a/Documentation/git-apply.txt b/Documentation/git-apply.txt index b7e51b885c..182305e9a9 100644 --- a/Documentation/git-apply.txt +++ b/Documentation/git-apply.txt @@ -64,7 +64,7 @@ OPTIONS without using the working tree. This implies '--index'. --build-fake-ancestor <file>:: - Newer `git-diff` output has embedded 'index information' + Newer 'git-diff' output has embedded 'index information' for each blob to help identify the original version that the patch applies to. When this flag is given, and if the original versions of the blobs is available locally, @@ -78,7 +78,7 @@ the information is read from the current index instead. Apply the patch in reverse. --reject:: - For atomicity, `git-apply` by default fails the whole patch and + For atomicity, 'git-apply' by default fails the whole patch and does not touch the working tree when some of the hunks do not apply. This option makes it apply the parts of the patch that are applicable, and leave the @@ -102,7 +102,7 @@ the information is read from the current index instead. ever ignored. --unidiff-zero:: - By default, `git-apply` expects that the patch being + By default, 'git-apply' expects that the patch being applied is a unified diff with at least one line of context. This provides good safety measures, but breaks down when applying a diff generated with --unified=0. To bypass these @@ -113,7 +113,7 @@ discouraged. --apply:: If you use any of the options marked "Turns off - 'apply'" above, `git-apply` reads and outputs the + 'apply'" above, 'git-apply' reads and outputs the information you asked without actually applying the patch. Give this flag after those flags to also apply the patch. @@ -191,7 +191,7 @@ apply.whitespace:: Submodules ---------- -If the patch contains any changes to submodules then `git-apply` +If the patch contains any changes to submodules then 'git-apply' treats these changes as follows. If --index is specified (explicitly or implicitly), then the submodule diff --git a/Documentation/git-archimport.txt b/Documentation/git-archimport.txt index f089debaa9..c7a6e3ec05 100644 --- a/Documentation/git-archimport.txt +++ b/Documentation/git-archimport.txt @@ -29,17 +29,17 @@ branches that have different roots, it will refuse to run. In that case, edit your <archive/branch> parameters to define clearly the scope of the import. -`git-archimport` uses `tla` extensively in the background to access the +'git-archimport' uses `tla` extensively in the background to access the Arch repository. Make sure you have a recent version of `tla` available in the path. `tla` must -know about the repositories you pass to `git-archimport`. +know about the repositories you pass to 'git-archimport'. -For the initial import, `git-archimport` expects to find itself in an empty +For the initial import, 'git-archimport' expects to find itself in an empty directory. To follow the development of a project that uses Arch, rerun -`git-archimport` with the same parameters as the initial import to perform +'git-archimport' with the same parameters as the initial import to perform incremental imports. -While `git-archimport` will try to create sensible branch names for the +While 'git-archimport' will try to create sensible branch names for the archives that it imports, it is also possible to specify git branch names manually. To do so, write a git branch name after each <archive/branch> parameter, separated by a colon. This way, you can shorten the Arch @@ -84,7 +84,7 @@ OPTIONS -o:: Use this for compatibility with old-style branch names used by - earlier versions of `git-archimport`. Old-style branch names + earlier versions of 'git-archimport'. Old-style branch names were category--branch, whereas new-style branch names are archive,category--branch--version. In both cases, names given on the command-line will override the automatically-generated diff --git a/Documentation/git-archive.txt b/Documentation/git-archive.txt index dbe9bad2f3..41cbf9c081 100644 --- a/Documentation/git-archive.txt +++ b/Documentation/git-archive.txt @@ -20,13 +20,13 @@ structure for the named tree, and writes it out to the standard output. If <prefix> is specified it is prepended to the filenames in the archive. -`git-archive` behaves differently when given a tree ID versus when +'git-archive' behaves differently when given a tree ID versus when given a commit ID or tag ID. In the first case the current time is used as modification time of each file in the archive. In the latter case the commit time as recorded in the referenced commit object is used instead. Additionally the commit ID is stored in a global extended pax header if the tar format is used; it can be extracted -using `git-get-tar-commit-id`. In ZIP files it is stored as a file +using 'git-get-tar-commit-id'. In ZIP files it is stored as a file comment. OPTIONS @@ -57,7 +57,7 @@ OPTIONS --exec=<git-upload-archive>:: Used with --remote to specify the path to the - `git-upload-archive` on the remote side. + 'git-upload-archive' on the remote side. <tree-ish>:: The tree or commit to produce an archive for. diff --git a/Documentation/git-bisect.txt b/Documentation/git-bisect.txt index a13983fda7..c794914366 100644 --- a/Documentation/git-bisect.txt +++ b/Documentation/git-bisect.txt @@ -26,7 +26,7 @@ on the subcommand: git bisect log git bisect run <cmd>... -This command uses `git-rev-list --bisect` to help drive the +This command uses 'git-rev-list --bisect' to help drive the binary search process to find which change introduced a bug, given an old "good" commit object name and a later "bad" commit object name. @@ -101,7 +101,7 @@ $ git bisect visualize to see the currently remaining suspects in `gitk`. `visualize` is a bit too long to type and `view` is provided as a synonym. -If 'DISPLAY' environment variable is not set, `git-log` is used +If 'DISPLAY' environment variable is not set, 'git-log' is used instead. You can even give command line options such as `-p` and `--stat`. @@ -215,7 +215,7 @@ tweaks (e.g., s/#define DEBUG 0/#define DEBUG 1/ in a header file, or work around other problem this bisection is not interested in") applied to the revision being tested. -To cope with such a situation, after the inner `git-bisect` finds the +To cope with such a situation, after the inner 'git-bisect' finds the next revision to test, with the "run" script, you can apply that tweak before compiling, run the real test, and after the test decides if the revision (possibly with the needed tweaks) passed the test, rewind the diff --git a/Documentation/git-blame.txt b/Documentation/git-blame.txt index 443039fd94..34b24a3cad 100644 --- a/Documentation/git-blame.txt +++ b/Documentation/git-blame.txt @@ -21,7 +21,7 @@ last modified the line. Optionally, start annotating from the given revision. Also it can limit the range of lines annotated. This report doesn't tell you anything about lines which have been deleted or -replaced; you need to use a tool such as `git-diff` or the "pickaxe" +replaced; you need to use a tool such as 'git-diff' or the "pickaxe" interface briefly mentioned in the following paragraph. Apart from supporting file annotation, git also supports searching the @@ -49,7 +49,7 @@ include::blame-options.txt[] file (see `-M`). The first number listed is the score. This is the number of alphanumeric characters detected to be moved between or within files. This must be above - a certain threshold for `git-blame` to consider those lines + a certain threshold for 'git-blame' to consider those lines of code to have been moved. -f:: @@ -100,7 +100,7 @@ header elements later. SPECIFYING RANGES ----------------- -Unlike `git-blame` and `git-annotate` in older git, the extent +Unlike 'git-blame' and 'git-annotate' in older git, the extent of annotation can be limited to both line ranges and revision ranges. When you are interested in finding the origin for ll. 40-60 for file `foo`, you can use `-L` option like these @@ -118,7 +118,7 @@ would limit the annotation to the body of `hello` subroutine. When you are not interested in changes older than the version v2.6.18, or changes older than 3 weeks, you can use revision -range specifiers similar to `git-rev-list`: +range specifiers similar to 'git-rev-list': git blame v2.6.18.. -- foo git blame --since=3.weeks -- foo diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt index 5e78aed7de..b3e62ed011 100644 --- a/Documentation/git-branch.txt +++ b/Documentation/git-branch.txt @@ -37,7 +37,7 @@ working tree to it; use "git checkout <newbranch>" to switch to the new branch. When a local branch is started off a remote branch, git sets up the -branch so that `git-pull` will appropriately merge from +branch so that 'git-pull' will appropriately merge from the remote branch. This behavior may be changed via the global `branch.autosetupmerge` configuration flag. That setting can be overridden by using the `--track` and `--no-track` options. @@ -54,7 +54,7 @@ has a reflog then the reflog will also be deleted. Use -r together with -d to delete remote-tracking branches. Note, that it only makes sense to delete remote-tracking branches if they no longer exist -in remote repository or if `git-fetch` was configured not to fetch +in remote repository or if 'git-fetch' was configured not to fetch them again. See also 'prune' subcommand of linkgit:git-remote[1] for way to clean up all obsolete remote-tracking branches. @@ -107,14 +107,14 @@ OPTIONS Display the full sha1s in output listing rather than abbreviating them. --track:: - When creating a new branch, set up configuration so that `git-pull` + When creating a new branch, set up configuration so that 'git-pull' will automatically retrieve data from the start point, which must be a branch. Use this if you always pull from the same upstream branch into the new branch, and if you don't want to use "git pull <repository> <refspec>" explicitly. This behavior is the default when the start point is a remote branch. Set the branch.autosetupmerge configuration variable to `false` if you want - `git-checkout` and `git-branch` to always behave as if '--no-track' were + 'git-checkout' and 'git-branch' to always behave as if '--no-track' were given. Set it to `always` if you want this behavior when the start-point is either a local or remote branch. diff --git a/Documentation/git-bundle.txt b/Documentation/git-bundle.txt index b729db7d28..1b66ab743c 100644 --- a/Documentation/git-bundle.txt +++ b/Documentation/git-bundle.txt @@ -21,9 +21,9 @@ Some workflows require that one or more branches of development on one machine be replicated on another machine, but the two machines cannot be directly connected so the interactive git protocols (git, ssh, rsync, http) cannot be used. This command provides support for -`git-fetch` and `git-pull` to operate by packaging objects and references +'git-fetch' and 'git-pull' to operate by packaging objects and references in an archive at the originating machine, then importing those into -another repository using `git-fetch` and `git-pull` +another repository using 'git-fetch' and 'git-pull' after moving the archive by some means (i.e., by sneakernet). As no direct connection between repositories exists, the user must specify a basis for the bundle that is held by the destination repository: the @@ -35,14 +35,14 @@ OPTIONS create <file>:: Used to create a bundle named 'file'. This requires the - `git-rev-list` arguments to define the bundle contents. + 'git-rev-list' arguments to define the bundle contents. verify <file>:: Used to check that a bundle file is valid and will apply cleanly to the current repository. This includes checks on the bundle format itself as well as checking that the prerequisite commits exist and are fully linked in the current repository. - `git-bundle` prints a list of missing commits, if any, and exits + 'git-bundle' prints a list of missing commits, if any, and exits with non-zero status. list-heads <file>:: @@ -51,15 +51,15 @@ list-heads <file>:: printed out. unbundle <file>:: - Passes the objects in the bundle to `git-index-pack` + Passes the objects in the bundle to 'git-index-pack' for storage in the repository, then prints the names of all defined references. If a reflist is given, only references matching those in the given list are printed. This command is - really plumbing, intended to be called only by `git-fetch`. + really plumbing, intended to be called only by 'git-fetch'. [git-rev-list-args...]:: - A list of arguments, acceptable to `git-rev-parse` and - `git-rev-list`, that specify the specific objects and references + A list of arguments, acceptable to 'git-rev-parse' and + 'git-rev-list', that specify the specific objects and references to transport. For example, "master~10..master" causes the current master reference to be packaged along with all objects added since its 10th ancestor commit. There is no explicit @@ -69,16 +69,16 @@ unbundle <file>:: [refname...]:: A list of references used to limit the references reported as - available. This is principally of use to `git-fetch`, which + available. This is principally of use to 'git-fetch', which expects to receive only those references asked for and not - necessarily everything in the pack (in this case, `git-bundle` is - acting like `git-fetch-pack`). + necessarily everything in the pack (in this case, 'git-bundle' is + acting like 'git-fetch-pack'). SPECIFYING REFERENCES --------------------- -`git-bundle` will only package references that are shown by -`git-show-ref`: this includes heads, tags, and remote heads. References +'git-bundle' will only package references that are shown by +'git-show-ref': this includes heads, tags, and remote heads. References such as master~1 cannot be packaged, but are perfectly suitable for defining the basis. More than one reference may be packaged, and more than one basis can be specified. The objects packaged are those not diff --git a/Documentation/git-check-ref-format.txt b/Documentation/git-check-ref-format.txt index 429083bb63..034223cc5a 100644 --- a/Documentation/git-check-ref-format.txt +++ b/Documentation/git-check-ref-format.txt @@ -47,7 +47,7 @@ refname expressions (see linkgit:git-rev-parse[1]). Namely: . colon `:` is used as in `srcref:dstref` to mean "use srcref\'s value and store it in dstref" in fetch and push operations. It may also be used to select a specific object such as with - `git-cat-file`: "git cat-file blob v1.3.3:refs.c". + 'git-cat-file': "git cat-file blob v1.3.3:refs.c". GIT diff --git a/Documentation/git-checkout-index.txt b/Documentation/git-checkout-index.txt index a833a4dda8..62d84836b8 100644 --- a/Documentation/git-checkout-index.txt +++ b/Documentation/git-checkout-index.txt @@ -88,7 +88,7 @@ $ find . -name '*.h' -print0 | xargs -0 git checkout-index -f -- which will force all existing `*.h` files to be replaced with their cached copies. If an empty command line implied "all", then this would force-refresh everything in the index, which was not the point. But -since `git-checkout-index` accepts --stdin it would be faster to use: +since 'git-checkout-index' accepts --stdin it would be faster to use: ---------------- $ find . -name '*.h' -print0 | git checkout-index -f -z --stdin @@ -102,7 +102,7 @@ Using `--` is probably a good policy in scripts. Using --temp or --stage=all --------------------------- When `--temp` is used (or implied by `--stage=all`) -`git-checkout-index` will create a temporary file for each index +'git-checkout-index' will create a temporary file for each index entry being checked out. The index will not be updated with stat information. These options can be useful if the caller needs all stages of all unmerged entries so that the unmerged files can be @@ -147,9 +147,9 @@ To update and refresh only the files already checked out:: $ git checkout-index -n -f -a && git update-index --ignore-missing --refresh ---------------- -Using `git-checkout-index` to "export an entire tree":: +Using 'git-checkout-index' to "export an entire tree":: The prefix ability basically makes it trivial to use - `git-checkout-index` as an "export as tree" function. + 'git-checkout-index' as an "export as tree" function. Just read the desired tree into the index, and do: + ---------------- diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt index c0f9c6e88c..2abfbdaadb 100644 --- a/Documentation/git-checkout.txt +++ b/Documentation/git-checkout.txt @@ -49,14 +49,14 @@ OPTIONS -t:: --track:: - When creating a new branch, set up configuration so that `git-pull` + When creating a new branch, set up configuration so that 'git-pull' will automatically retrieve data from the start point, which must be a branch. Use this if you always pull from the same upstream branch into the new branch, and if you don't want to use "git pull <repository> <refspec>" explicitly. This behavior is the default when the start point is a remote branch. Set the branch.autosetupmerge configuration variable to `false` if you want - `git-checkout` and `git-branch` to always behave as if '--no-track' were + 'git-checkout' and 'git-branch' to always behave as if '--no-track' were given. Set it to `always` if you want this behavior when the start-point is either a local or remote branch. diff --git a/Documentation/git-cherry-pick.txt b/Documentation/git-cherry-pick.txt index 1b864dacff..a691173ba1 100644 --- a/Documentation/git-cherry-pick.txt +++ b/Documentation/git-cherry-pick.txt @@ -24,7 +24,7 @@ OPTIONS -e:: --edit:: - With this option, `git-cherry-pick` will let you edit the commit + With this option, 'git-cherry-pick' will let you edit the commit message prior to committing. -x:: diff --git a/Documentation/git-cherry.txt b/Documentation/git-cherry.txt index 9859bc8f2f..d761a73423 100644 --- a/Documentation/git-cherry.txt +++ b/Documentation/git-cherry.txt @@ -14,7 +14,7 @@ DESCRIPTION The changeset (or "diff") of each commit between the fork-point and <head> is compared against each commit between the fork-point and <upstream>. The commits are compared with their 'patch id', obtained from -the `git-patch-id` program. +the 'git-patch-id' program. Every commit that doesn't exist in the <upstream> branch has its id (sha1) reported, prefixed by a symbol. The ones that have @@ -37,8 +37,8 @@ to and including <limit> are not reported: \__*__*__<limit>__-__+__> <head> -Because `git-cherry` compares the changeset rather than the commit id -(sha1), you can use `git-cherry` to find out if a commit you made locally +Because 'git-cherry' compares the changeset rather than the commit id +(sha1), you can use 'git-cherry' to find out if a commit you made locally has been applied <upstream> under a different commit id. For example, this will happen if you're feeding patches <upstream> via email rather than pushing or pulling commits directly. diff --git a/Documentation/git-citool.txt b/Documentation/git-citool.txt index 8e6c7e67cd..670cb02b6c 100644 --- a/Documentation/git-citool.txt +++ b/Documentation/git-citool.txt @@ -14,9 +14,9 @@ DESCRIPTION A Tcl/Tk based graphical interface to review modified files, stage them into the index, enter a commit message and record the new commit onto the current branch. This interface is an alternative -to the less interactive `git-commit` program. +to the less interactive 'git-commit' program. -`git-citool` is actually a standard alias for `git gui citool`. +'git-citool' is actually a standard alias for `git gui citool`. See linkgit:git-gui[1] for more details. Author diff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt index 8168bf3bf4..7dcc1ba58c 100644 --- a/Documentation/git-clean.txt +++ b/Documentation/git-clean.txt @@ -27,7 +27,7 @@ OPTIONS -f:: If the git configuration specifies clean.requireForce as true, - `git-clean` will refuse to run unless given -f or -n. + 'git-clean' will refuse to run unless given -f or -n. -n:: --dry-run:: @@ -41,7 +41,7 @@ OPTIONS -x:: Don't use the ignore rules. This allows removing all untracked files, including build products. This can be used (possibly in - conjunction with `git-reset`) to create a pristine + conjunction with 'git-reset') to create a pristine working directory to test a clean build. -X:: diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt index eef95a404a..91efac920e 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt @@ -68,7 +68,7 @@ it unless you understand what it does. If you clone your repository using this option and then delete branches (or use any other git command that makes any existing commit unreferenced) in the source repository, some objects may become unreferenced (or dangling). -These objects may be removed by normal git operations (such as `git-commit`) +These objects may be removed by normal git operations (such as 'git-commit') which automatically call `git gc --auto`. (See linkgit:git-gc[1].) If these objects are removed and were referenced by the cloned repository, then the cloned repository will become corrupt. @@ -88,7 +88,7 @@ then the cloned repository will become corrupt. --quiet:: -q:: Operate quietly. This flag is passed to "rsync" and - `git-fetch-pack` commands when given. + 'git-fetch-pack' commands when given. --no-checkout:: -n:: @@ -114,7 +114,7 @@ then the cloned repository will become corrupt. --upload-pack <upload-pack>:: -u <upload-pack>:: When given, and the repository to clone from is handled - by `git-fetch-pack`, `--exec=<upload-pack>` is passed to + by 'git-fetch-pack', `--exec=<upload-pack>` is passed to the command to specify non-default path for the command run on the other end. diff --git a/Documentation/git-commit-tree.txt b/Documentation/git-commit-tree.txt index 9cd8d07c8a..feec58400b 100644 --- a/Documentation/git-commit-tree.txt +++ b/Documentation/git-commit-tree.txt @@ -70,7 +70,7 @@ is taken from the configuration items user.name and user.email, or, if not present, system user name and fully qualified hostname. A commit comment is read from stdin. If a changelog -entry is not provided via "<" redirection, `git-commit-tree` will just wait +entry is not provided via "<" redirection, 'git-commit-tree' will just wait for one to be entered and terminated with ^D. 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 diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt index 63ddb2c2f9..df419e21fd 100644 --- a/Documentation/git-config.txt +++ b/Documentation/git-config.txt @@ -37,7 +37,7 @@ you want to handle the lines that do *not* match the regex, just prepend a single exclamation mark in front (see also <<EXAMPLES>>). The type specifier can be either '--int' or '--bool', which will make -`git-config` ensure that the variable(s) are of the given type and +'git-config' ensure that the variable(s) are of the given type and convert the value to the canonical form (simple decimal number for int, a "true" or "false" string for bool). If no type specifier is passed, no checks or transformations are performed on the value. @@ -122,10 +122,10 @@ See also <<FILES>>. List all variables set in config file. --bool:: - `git-config` will ensure that the output is "true" or "false" + 'git-config' will ensure that the output is "true" or "false" --int:: - `git-config` will ensure that the output is a simple + 'git-config' will ensure that the output is a simple decimal number. An optional value suffix of 'k', 'm', or 'g' in the config file will cause the value to be multiplied by 1024, 1048576, or 1073741824 prior to output. @@ -162,7 +162,7 @@ FILES ----- If not set explicitly with '--file', there are three files where -`git-config` will search for configuration options: +'git-config' will search for configuration options: $GIT_DIR/config:: Repository specific configuration file. (The filename is @@ -179,12 +179,12 @@ $(prefix)/etc/gitconfig:: If no further options are given, all reading options will read all of these files that are available. If the global or the system-wide configuration file are not available they will be ignored. If the repository configuration -file is not available or readable, `git-config` will exit with a non-zero +file is not available or readable, 'git-config' will exit with a non-zero error code. However, in neither case will an error message be issued. All writing options will per default write to the repository specific configuration file. Note that this also affects options like '--replace-all' -and '--unset'. *`git-config` will only ever change one file at a time*. +and '--unset'. *'git-config' will only ever change one file at a time*. You can override these rules either by command line options or by environment variables. The '--global' and the '--system' options will limit the file used diff --git a/Documentation/git-cvsexportcommit.txt b/Documentation/git-cvsexportcommit.txt index 2a02ffa7c1..2da8588f4f 100644 --- a/Documentation/git-cvsexportcommit.txt +++ b/Documentation/git-cvsexportcommit.txt @@ -27,7 +27,7 @@ by default. Supports file additions, removals, and commits that affect binary files. -If the commit is a merge commit, you must tell `git-cvsexportcommit` what +If the commit is a merge commit, you must tell 'git-cvsexportcommit' what parent the changeset should be done against. OPTIONS diff --git a/Documentation/git-cvsimport.txt b/Documentation/git-cvsimport.txt index ed79bb8d5b..1614e8df89 100644 --- a/Documentation/git-cvsimport.txt +++ b/Documentation/git-cvsimport.txt @@ -25,9 +25,9 @@ Splitting the CVS log into patch sets is done by 'cvsps'. At least version 2.1 is required. You should *never* do any work of your own on the branches that are -created by `git-cvsimport`. By default initial import will create and populate a +created by 'git-cvsimport'. By default initial import will create and populate a "master" branch from the CVS repository's main branch which you're free -to work with; after that, you need to `git-merge` incremental imports, or +to work with; after that, you need to 'git-merge' incremental imports, or any CVS branches, yourself. It is advisable to specify a named remote via -r to separate and protect the incoming branches. @@ -40,13 +40,13 @@ OPTIONS -d <CVSROOT>:: The root of the CVS archive. May be local (a simple path) or remote; currently, only the :local:, :ext: and :pserver: access methods - are supported. If not given, `git-cvsimport` will try to read it + are supported. If not given, 'git-cvsimport' will try to read it from `CVS/Root`. If no such file exists, it checks for the `CVSROOT` environment variable. <CVS_module>:: The CVS module you want to import. Relative to <CVSROOT>. - If not given, `git-cvsimport` tries to read it from + If not given, 'git-cvsimport' tries to read it from `CVS/Repository`. -C <target-dir>:: @@ -56,14 +56,14 @@ OPTIONS -r <remote>:: The git remote to import this CVS repository into. Moves all CVS branches into remotes/<remote>/<branch> - akin to the `git-clone` "--use-separate-remote" option. + akin to the 'git-clone' "--use-separate-remote" option. -o <branch-for-HEAD>:: When no remote is specified (via -r) the 'HEAD' branch from CVS is imported to the 'origin' branch within the git repository, as 'HEAD' already has a special meaning for git. When a remote is specified the 'HEAD' branch is named - remotes/<remote>/master mirroring `git-clone` behaviour. + remotes/<remote>/master mirroring 'git-clone' behaviour. Use this option if you want to import into a different branch. + @@ -136,17 +136,17 @@ This option can be used several times to provide several detection regexes. --------- + -`git-cvsimport` will make it appear as those authors had +'git-cvsimport' will make it appear as those authors had their GIT_AUTHOR_NAME and GIT_AUTHOR_EMAIL set properly all along. + For convenience, this data is saved to `$GIT_DIR/cvs-authors` each time the '-A' option is provided and read from that same -file each time `git-cvsimport` is run. +file each time 'git-cvsimport' is run. + It is not recommended to use this feature if you intend to export changes back to CVS again later with -`git-cvsexportcommit`. +'git-cvsexportcommit'. -h:: Print a short usage message and exit. diff --git a/Documentation/git-cvsserver.txt b/Documentation/git-cvsserver.txt index e0e35dbbb7..1804701c5c 100644 --- a/Documentation/git-cvsserver.txt +++ b/Documentation/git-cvsserver.txt @@ -77,7 +77,7 @@ over pserver for anonymous CVS access. CVS clients cannot tag, branch or perform GIT merges. -`git-cvsserver` maps GIT branches to CVS modules. This is very different +'git-cvsserver' maps GIT branches to CVS modules. This is very different from what most CVS users would expect since in CVS modules usually represent one or more directories. @@ -103,7 +103,7 @@ looks like ------ No special setup is needed for SSH access, other than having GIT tools in the PATH. If you have clients that do not accept the CVS_SERVER -environment variable, you can rename `git-cvsserver` to `cvs`. +environment variable, you can rename 'git-cvsserver' to `cvs`. Note: Newer CVS versions (>= 1.12.11) also support specifying CVS_SERVER directly in CVSROOT like @@ -113,9 +113,9 @@ cvs -d ":ext;CVS_SERVER=git-cvsserver:user@server/path/repo.git" co <HEAD_name> ------ This has the advantage that it will be saved in your 'CVS/Root' files and you don't need to worry about always setting the correct environment -variable. SSH users restricted to `git-shell` don't need to override the default -with CVS_SERVER (and shouldn't) as `git-shell` understands `cvs` to mean -`git-cvsserver` and pretends that the other end runs the real `cvs` better. +variable. SSH users restricted to 'git-shell' don't need to override the default +with CVS_SERVER (and shouldn't) as 'git-shell' understands `cvs` to mean +'git-cvsserver' and pretends that the other end runs the real `cvs` better. -- 2. For each repo that you want accessible from CVS you need to edit config in the repo and add the following section. @@ -128,7 +128,7 @@ with CVS_SERVER (and shouldn't) as `git-shell` understands `cvs` to mean logfile=/path/to/logfile ------ -Note: you need to ensure each user that is going to invoke `git-cvsserver` has +Note: you need to ensure each user that is going to invoke 'git-cvsserver' has write access to the log file and to the database (see <<dbbackend,Database Backend>>. If you want to offer write access over SSH, the users of course also need write access to the git repository itself. @@ -150,7 +150,7 @@ allowing access over SSH. automatically saving it in your 'CVS/Root' files, then you need to set them explicitly in your environment. CVSROOT should be set as per normal, but the directory should point at the appropriate git repo. As above, for SSH clients - _not_ restricted to `git-shell`, CVS_SERVER should be set to `git-cvsserver`. + _not_ restricted to 'git-shell', CVS_SERVER should be set to 'git-cvsserver'. + -- ------ @@ -178,27 +178,27 @@ allowing access over SSH. Database Backend ---------------- -`git-cvsserver` uses one database per git head (i.e. CVS module) to +'git-cvsserver' uses one database per git head (i.e. CVS module) to store information about the repository for faster access. The database doesn't contain any persistent data and can be completely regenerated from the git repository at any time. The database needs to be updated (i.e. written to) after every commit. If the commit is done directly by using `git` (as opposed to -using `git-cvsserver`) the update will need to happen on the -next repository access by `git-cvsserver`, independent of +using 'git-cvsserver') the update will need to happen on the +next repository access by 'git-cvsserver', independent of access method and requested operation. That means that even if you offer only read access (e.g. by using -the pserver method), `git-cvsserver` should have write access to +the pserver method), 'git-cvsserver' should have write access to the database to work reliably (otherwise you need to make sure -that the database is up-to-date any time `git-cvsserver` is executed). +that the database is up-to-date any time 'git-cvsserver' is executed). By default it uses SQLite databases in the git directory, named `gitcvs.<module_name>.sqlite`. Note that the SQLite backend creates temporary files in the same directory as the database file on write so it might not be enough to grant the users using -`git-cvsserver` write access to the database file without granting +'git-cvsserver' write access to the database file without granting them write access to the directory, too. You can configure the database backend with the following @@ -207,7 +207,7 @@ configuration variables: Configuring database backend ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -`git-cvsserver` uses the Perl DBI module. Please also read +'git-cvsserver' uses the Perl DBI module. Please also read its documentation if changing these variables, especially about `DBI->connect()`. @@ -259,7 +259,7 @@ In `dbdriver` and `dbuser` you can use the following variables: %a:: access method (one of "ext" or "pserver") %u:: - Name of the user running `git-cvsserver`. + Name of the user running 'git-cvsserver'. If no name can be determined, the numeric uid is used. @@ -280,13 +280,13 @@ To get a checkout with the Eclipse CVS client: Protocol notes: If you are using anonymous access via pserver, just select that. Those using SSH access should choose the 'ext' protocol, and configure 'ext' access on the Preferences->Team->CVS->ExtConnection pane. Set CVS_SERVER to -`git-cvsserver`. Note that password support is not good when using 'ext', +'git-cvsserver'. Note that password support is not good when using 'ext', you will definitely want to have SSH keys setup. Alternatively, you can just use the non-standard extssh protocol that Eclipse offer. In that case CVS_SERVER is ignored, and you will have to replace -the cvs utility on the server with `git-cvsserver` or manipulate your `.bashrc` -so that calling 'cvs' effectively calls `git-cvsserver`. +the cvs utility on the server with 'git-cvsserver' or manipulate your `.bashrc` +so that calling 'cvs' effectively calls 'git-cvsserver'. Clients known to work --------------------- @@ -334,7 +334,7 @@ and `gitcvs.allbinary` to "guess". Dependencies ------------ -`git-cvsserver` depends on DBD::SQLite. +'git-cvsserver' depends on DBD::SQLite. Copyright and Authors --------------------- diff --git a/Documentation/git-daemon.txt b/Documentation/git-daemon.txt index 3cf2d3b3d4..4ba4b75c11 100644 --- a/Documentation/git-daemon.txt +++ b/Documentation/git-daemon.txt @@ -27,36 +27,36 @@ that service if it is enabled. It verifies that the directory has the magic file "git-daemon-export-ok", and it will refuse to export any git directory that hasn't explicitly been marked for export this way (unless the '--export-all' parameter is specified). If you -pass some directory paths as `git-daemon` arguments, you can further restrict +pass some directory paths as 'git-daemon' arguments, you can further restrict the offers to a whitelist comprising of those. By default, only `upload-pack` service is enabled, which serves -`git-fetch-pack` and `git-ls-remote` clients, which are invoked -from `git-fetch`, `git-pull`, and `git-clone`. +'git-fetch-pack' and 'git-ls-remote' clients, which are invoked +from 'git-fetch', 'git-pull', and 'git-clone'. This is ideally suited for read-only updates, i.e., pulling from git repositories. -An `upload-archive` also exists to serve `git-archive`. +An `upload-archive` also exists to serve 'git-archive'. OPTIONS ------- --strict-paths:: Match paths exactly (i.e. don't allow "/foo/repo" when the real path is "/foo/repo.git" or "/foo/repo/.git") and don't do user-relative paths. - `git-daemon` will refuse to start when this option is enabled and no + 'git-daemon' will refuse to start when this option is enabled and no whitelist is specified. --base-path:: Remap all the path requests as relative to the given path. - This is sort of "GIT root" - if you run `git-daemon` with + This is sort of "GIT root" - if you run 'git-daemon' with '--base-path=/srv/git' on example.com, then if you later try to pull - 'git://example.com/hello.git', `git-daemon` will interpret the path + 'git://example.com/hello.git', 'git-daemon' will interpret the path as '/srv/git/hello.git'. --base-path-relaxed:: If --base-path is enabled and repo lookup fails, with this option - `git-daemon` will attempt to lookup without prefixing the base path. + 'git-daemon' will attempt to lookup without prefixing the base path. This is useful for switching to --base-path usage, while still allowing the old paths. @@ -138,7 +138,7 @@ OPTIONS + Giving these options is an error when used with `--inetd`; use the facility of inet daemon to achieve the same before spawning -`git-daemon` if needed. +'git-daemon' if needed. --enable=service:: --disable=service:: @@ -164,24 +164,24 @@ SERVICES These services can be globally enabled/disabled using the command line options of this command. If a finer-grained -control is desired (e.g. to allow `git-archive` to be run +control is desired (e.g. to allow 'git-archive' to be run against only in a few selected repositories the daemon serves), the per-repository configuration file can be used to enable or disable them. upload-pack:: - This serves `git-fetch-pack` and `git-ls-remote` + This serves 'git-fetch-pack' and 'git-ls-remote' clients. It is enabled by default, but a repository can disable it by setting `daemon.uploadpack` configuration item to `false`. upload-archive:: - This serves `git-archive --remote`. It is disabled by + This serves 'git-archive --remote'. It is disabled by default, but a repository can enable it by setting `daemon.uploadarch` configuration item to `true`. receive-pack:: - This serves `git-send-pack` clients, allowing anonymous + This serves 'git-send-pack' clients, allowing anonymous push. It is disabled by default, as there is _no_ authentication in the protocol (in other words, anybody can push anything into the repository, including removal @@ -199,8 +199,8 @@ $ grep 9418 /etc/services git 9418/tcp # Git Version Control System ------------ -`git-daemon` as inetd server:: - To set up `git-daemon` as an inetd service that handles any +'git-daemon' as inetd server:: + To set up 'git-daemon' as an inetd service that handles any repository under the whitelisted set of directories, /pub/foo and /pub/bar, place an entry like the following into /etc/inetd all on one line: @@ -212,8 +212,8 @@ git 9418/tcp # Git Version Control System ------------------------------------------------ -`git-daemon` as inetd server for virtual hosts:: - To set up `git-daemon` as an inetd service that handles +'git-daemon' as inetd server for virtual hosts:: + To set up 'git-daemon' as an inetd service that handles repositories for different virtual hosts, `www.example.com` and `www.example.org`, place an entry like the following into `/etc/inetd` all on one line: @@ -235,8 +235,8 @@ clients, a symlink from `/software` into the appropriate default repository could be made as well. -`git-daemon` as regular daemon for virtual hosts:: - To set up `git-daemon` as a regular, non-inetd service that +'git-daemon' as regular daemon for virtual hosts:: + To set up 'git-daemon' as a regular, non-inetd service that handles repositories for multiple virtual hosts based on their IP addresses, start the daemon like this: + @@ -253,7 +253,7 @@ Repositories can still be accessed by hostname though, assuming they correspond to these IP addresses. selectively enable/disable services per repository:: - To enable `git-archive --remote` and disable `git-fetch` against + To enable 'git-archive --remote' and disable 'git-fetch' against a repository, have the following in the configuration file in the repository (that is the file 'config' next to 'HEAD', 'refs' and 'objects'). diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt index 51a0cc044f..44b166888a 100644 --- a/Documentation/git-describe.txt +++ b/Documentation/git-describe.txt @@ -92,7 +92,7 @@ of commits which would be displayed by "git log v1.0.4..parent". The hash suffix is "-g" + 7-char abbreviation for the tip commit of parent (which was `2414721b194453f058079d897d13c4e377f92dc6`). -Doing a `git-describe` on a tag-name will just show the tag name: +Doing a 'git-describe' on a tag-name will just show the tag name: [torvalds@g5 git]$ git describe v1.0.4 v1.0.4 @@ -115,13 +115,13 @@ closest tagname without any suffix: SEARCH STRATEGY --------------- -For each committish supplied, `git-describe` will first look for +For each committish supplied, 'git-describe' will first look for a tag which tags exactly that commit. Annotated tags will always be preferred over lightweight tags, and tags with newer dates will always be preferred over tags with older dates. If an exact match is found, its name will be output and searching will stop. -If an exact match was not found, `git-describe` will walk back +If an exact match was not found, 'git-describe' will walk back through the commit history to locate an ancestor commit which has been tagged. The ancestor's tag will be output along with an abbreviation of the input committish's SHA1. diff --git a/Documentation/git-diff-files.txt b/Documentation/git-diff-files.txt index 6c65757eae..5c8c1d95a8 100644 --- a/Documentation/git-diff-files.txt +++ b/Documentation/git-diff-files.txt @@ -15,7 +15,7 @@ DESCRIPTION Compares the files in the working tree and the index. When paths are specified, compares only those named paths. Otherwise all entries in the index are compared. The output format is the -same as for `git-diff-index` and `git-diff-tree`. +same as for 'git-diff-index' and 'git-diff-tree'. OPTIONS ------- diff --git a/Documentation/git-diff-index.txt b/Documentation/git-diff-index.txt index 784bbf3b0d..26920d4f63 100644 --- a/Documentation/git-diff-index.txt +++ b/Documentation/git-diff-index.txt @@ -31,7 +31,7 @@ include::diff-options.txt[] -m:: By default, files recorded in the index but not checked out are reported as deleted. This flag makes - `git-diff-index` say that all non-checked-out files are up + 'git-diff-index' say that all non-checked-out files are up to date. Output format @@ -50,7 +50,7 @@ Cached Mode If '--cached' is specified, it allows you to ask: show me the differences between HEAD and the current index - contents (the ones I'd write using `git-write-tree`) + contents (the ones I'd write using 'git-write-tree') For example, let's say that you have worked on your working directory, updated some files in the index and are ready to commit. You want to see exactly @@ -62,7 +62,7 @@ object and compare it that way, and to do that, you just do Example: let's say I had renamed `commit.c` to `git-commit.c`, and I had done an `update-index` to make that effective in the index file. `git diff-files` wouldn't show anything at all, since the index file -matches my working directory. But doing a `git-diff-index` does: +matches my working directory. But doing a 'git-diff-index' does: torvalds@ppc970:~/git> git diff-index --cached HEAD -100644 blob 4161aecc6700a2eb579e842af0b7f22b98443f74 commit.c @@ -71,10 +71,10 @@ matches my working directory. But doing a `git-diff-index` does: You can see easily that the above is a rename. In fact, `git diff-index --cached` *should* always be entirely equivalent to -actually doing a `git-write-tree` and comparing that. Except this one is much +actually doing a 'git-write-tree' and comparing that. Except this one is much nicer for the case where you just want to check where you are. -So doing a `git-diff-index --cached` is basically very useful when you are +So doing a 'git-diff-index --cached' is basically very useful when you are asking yourself "what have I already marked for being committed, and what's the difference to a previous tree". @@ -82,20 +82,20 @@ Non-cached Mode --------------- The "non-cached" mode takes a different approach, and is potentially the more useful of the two in that what it does can't be emulated with -a `git-write-tree` + `git-diff-tree`. Thus that's the default mode. +a 'git-write-tree' + 'git-diff-tree'. Thus that's the default mode. The non-cached version asks the question: show me the differences between HEAD and the currently checked out tree - index contents _and_ files that aren't up-to-date which is obviously a very useful question too, since that tells you what -you *could* commit. Again, the output matches the `git-diff-tree -r` +you *could* commit. Again, the output matches the 'git-diff-tree -r' output to a tee, but with a twist. The twist is that if some file doesn't match the index, we don't have a backing store thing for it, and we use the magic "all-zero" sha1 to show that. So let's say that you have edited `kernel/sched.c`, but -have not actually done a `git-update-index` on it yet - there is no +have not actually done a 'git-update-index' on it yet - there is no "object" associated with the new state, and you get: torvalds@ppc970:~/v2.6/linux> git diff-index HEAD @@ -106,11 +106,11 @@ not up-to-date and may contain new stuff. The all-zero sha1 means that to get the real diff, you need to look at the object in the working directory directly rather than do an object-to-object diff. -NOTE: As with other commands of this type, `git-diff-index` does not +NOTE: As with other commands of this type, 'git-diff-index' does not actually look at the contents of the file at all. So maybe `kernel/sched.c` hasn't actually changed, and it's just that you touched it. In either case, it's a note that you need to -`git-update-index` it to make the index be in sync. +'git-update-index' it to make the index be in sync. NOTE: You can have a mixture of files show up as "has been updated" and "is still dirty in the working directory" together. You can always diff --git a/Documentation/git-diff-tree.txt b/Documentation/git-diff-tree.txt index 68feb08172..0e45b58d83 100644 --- a/Documentation/git-diff-tree.txt +++ b/Documentation/git-diff-tree.txt @@ -20,7 +20,7 @@ Compares the content and mode of the blobs found via two tree objects. If there is only one <tree-ish> given, the commit is compared with its parents (see --stdin below). -Note that `git-diff-tree` can use the tree encapsulated in a commit object. +Note that 'git-diff-tree' can use the tree encapsulated in a commit object. OPTIONS ------- @@ -58,25 +58,25 @@ behavior. This does not apply to the case where two <tree-ish> separated with a single space are given. -m:: - By default, `git-diff-tree --stdin` does not show + By default, 'git-diff-tree --stdin' does not show differences for merge commits. With this flag, it shows differences to that commit from all of its parents. See also '-c'. -s:: - By default, `git-diff-tree --stdin` shows differences, + By default, 'git-diff-tree --stdin' shows differences, either in machine-readable form (without '-p') or in patch form (with '-p'). This output can be suppressed. It is only useful with '-v' flag. -v:: - This flag causes `git-diff-tree --stdin` to also show + This flag causes 'git-diff-tree --stdin' to also show the commit message before the differences. include::pretty-options.txt[] --no-commit-id:: - `git-diff-tree` outputs a line with the commit ID when + 'git-diff-tree' outputs a line with the commit ID when applicable. This flag suppressed the commit ID output. -c:: diff --git a/Documentation/git-fast-export.txt b/Documentation/git-fast-export.txt index dbc2b190ed..4956964d85 100644 --- a/Documentation/git-fast-export.txt +++ b/Documentation/git-fast-export.txt @@ -13,18 +13,18 @@ SYNOPSIS DESCRIPTION ----------- This program dumps the given revisions in a form suitable to be piped -into `git-fast-import`. +into 'git-fast-import'. You can use it as a human readable bundle replacement (see linkgit:git-bundle[1]), or as a kind of an interactive -`git-filter-branch`. +'git-filter-branch'. OPTIONS ------- --progress=<n>:: Insert 'progress' statements every <n> objects, to be shown by - `git-fast-import` during import. + 'git-fast-import' during import. --signed-tags=(verbatim|warn|strip|abort):: Specify how to handle signed tags. Since any transformation @@ -85,7 +85,7 @@ referenced by that revision range contains the string Limitations ----------- -Since `git-fast-import` cannot tag trees, you will not be +Since 'git-fast-import' cannot tag trees, you will not be able to export the linux-2.6.git repository completely, as it contains a tag referencing a tree instead of a commit. diff --git a/Documentation/git-fast-import.txt b/Documentation/git-fast-import.txt index 960276423b..2d01d0d100 100644 --- a/Documentation/git-fast-import.txt +++ b/Documentation/git-fast-import.txt @@ -15,7 +15,7 @@ DESCRIPTION This program is usually not what the end user wants to run directly. Most end users want to use one of the existing frontend programs, which parses a specific type of foreign source and feeds the contents -stored there to `git-fast-import`. +stored there to 'git-fast-import'. fast-import reads a mixed command/data stream from standard input and writes one or more packfiles directly into the current repository. @@ -24,7 +24,7 @@ updated branch and tag refs, fully updating the current repository with the newly imported data. The fast-import backend itself can import into an empty repository (one that -has already been initialized by `git-init`) or incrementally +has already been initialized by 'git-init') or incrementally update an existing populated repository. Whether or not incremental imports are supported from a particular foreign source depends on the frontend program in use. @@ -82,7 +82,7 @@ OPTIONS This information may be useful after importing projects whose total object set exceeds the 4 GiB packfile limit, as these commits can be used as edge points during calls - to `git-pack-objects`. + to 'git-pack-objects'. --quiet:: Disable all non-fatal output, making fast-import silent when it @@ -124,9 +124,9 @@ an ideal situation, given that most conversion tools are throw-away Parallel Operation ------------------ -Like `git-push` or `git-fetch`, imports handled by fast-import are safe to +Like 'git-push' or 'git-fetch', imports handled by fast-import are safe to run alongside parallel `git repack -a -d` or `git gc` invocations, -or any other Git operation (including `git-prune`, as loose objects +or any other Git operation (including 'git-prune', as loose objects are never used by fast-import). fast-import does not lock the branch or tag refs it is actively importing. @@ -220,7 +220,7 @@ variation in formatting will cause fast-import to reject the value. + An example value is ``Tue Feb 6 11:22:18 2007 -0500''. The Git parser is accurate, but a little on the lenient side. It is the -same parser used by `git-am` when applying patches +same parser used by 'git-am' when applying patches received from email. + Some malformed strings may be accepted as valid dates. In some of @@ -256,7 +256,7 @@ timezone. This particular format is supplied as its short to implement and may be useful to a process that wants to create a new commit right now, without needing to use a working directory or -`git-update-index`. +'git-update-index'. + If separate `author` and `committer` commands are used in a `commit` the timestamps may not match, as the system clock will be polled @@ -654,7 +654,7 @@ recommended, as the frontend does not (easily) have access to the complete set of bytes which normally goes into such a signature. If signing is required, create lightweight tags from within fast-import with `reset`, then create the annotated versions of those tags offline -with the standard `git-tag` process. +with the standard 'git-tag' process. `reset` ~~~~~~~ @@ -955,7 +955,7 @@ is not `refs/heads/TAG_FIXUP`). When committing fixups, consider using `merge` to connect the commit(s) which are supplying file revisions to the fixup branch. -Doing so will allow tools such as `git-blame` to track +Doing so will allow tools such as 'git-blame' to track through the real commit history and properly annotate the source files. @@ -984,7 +984,7 @@ Repacking Historical Data ~~~~~~~~~~~~~~~~~~~~~~~~~ If you are repacking very old imported data (e.g. older than the last year), consider expending some extra CPU time and supplying -\--window=50 (or higher) when you run `git-repack`. +\--window=50 (or higher) when you run 'git-repack'. This will take longer, but will also produce a smaller packfile. You only need to expend the effort once, and everyone using your project will benefit from the smaller repository. diff --git a/Documentation/git-fetch-pack.txt b/Documentation/git-fetch-pack.txt index a069f8d9a9..47448da22e 100644 --- a/Documentation/git-fetch-pack.txt +++ b/Documentation/git-fetch-pack.txt @@ -12,14 +12,14 @@ SYNOPSIS DESCRIPTION ----------- -Usually you would want to use `git-fetch`, which is a +Usually you would want to use 'git-fetch', which is a higher level wrapper of this command, instead. -Invokes `git-upload-pack` on a possibly remote repository +Invokes 'git-upload-pack' on a possibly remote repository and asks it to send objects missing from this repository, to update the named heads. The list of commits available locally is found out by scanning local $GIT_DIR/refs/ and sent to -`git-upload-pack` running on the other end. +'git-upload-pack' running on the other end. This command degenerates to download everything to complete the asked refs from the remote side when the local side does not @@ -33,12 +33,12 @@ OPTIONS -q:: --quiet:: - Pass '-q' flag to `git-unpack-objects`; this makes the + Pass '-q' flag to 'git-unpack-objects'; this makes the cloning process less verbose. -k:: --keep:: - Do not invoke `git-unpack-objects` on received data, but + Do not invoke 'git-unpack-objects' on received data, but create a single packfile out of it instead, and store it in the object database. If provided twice then the pack is locked against repacking. @@ -54,7 +54,7 @@ OPTIONS otherwise determine the tags this option made available. --upload-pack=<git-upload-pack>:: - Use this to specify the path to `git-upload-pack` on the + Use this to specify the path to 'git-upload-pack' on the remote side, if is not found on your $PATH. Installations of sshd ignores the user's environment setup scripts for login shells (e.g. .bash_profile) and @@ -79,7 +79,7 @@ OPTIONS <host>:: A remote host that houses the repository. When this - part is specified, `git-upload-pack` is invoked via + part is specified, 'git-upload-pack' is invoked via ssh. <directory>:: diff --git a/Documentation/git-fetch.txt b/Documentation/git-fetch.txt index b225566414..9e048a8a28 100644 --- a/Documentation/git-fetch.txt +++ b/Documentation/git-fetch.txt @@ -18,7 +18,7 @@ the objects necessary to complete them. The ref names and their object names of fetched refs are stored in `.git/FETCH_HEAD`. This information is left for a later merge -operation done by `git-merge`. +operation done by 'git-merge'. When <refspec> stores the fetched result in tracking branches, the tags that point at these branches are automatically diff --git a/Documentation/git-filter-branch.txt b/Documentation/git-filter-branch.txt index 4262309b09..a3edc00246 100644 --- a/Documentation/git-filter-branch.txt +++ b/Documentation/git-filter-branch.txt @@ -108,7 +108,7 @@ OPTIONS --commit-filter <command>:: This is the filter for performing the commit. If this filter is specified, it will be called instead of the - `git-commit-tree` command, with arguments of the form + 'git-commit-tree' command, with arguments of the form "<TREE_ID> [-p <PARENT_COMMIT_ID>]..." and the log message on stdin. The commit id is expected on stdout. + @@ -119,7 +119,7 @@ have all of them as parents. You can use the 'map' convenience function in this filter, and other convenience functions, too. For example, calling 'skip_commit "$@"' will leave out the current commit (but not its changes! If you want -that, use `git-rebase` instead). +that, use 'git-rebase' instead). --tag-name-filter <command>:: This is the filter for rewriting tag names. When passed, @@ -163,13 +163,13 @@ to other tags will be rewritten to point to the underlying commit. -f:: --force:: - `git-filter-branch` refuses to start with an existing temporary + 'git-filter-branch' refuses to start with an existing temporary directory or when there are already refs starting with 'refs/original/', unless forced. <rev-list-options>:: When options are given after the new branch name, they will - be passed to `git-rev-list`. Only commits in the resulting + be passed to 'git-rev-list'. Only commits in the resulting output will be filtered, although the filtered commits can still reference parents which are outside of that set. @@ -255,7 +255,7 @@ and all children of the merge will become merge commits with P1,P2 as their parents instead of the merge commit. You can rewrite the commit log messages using `--msg-filter`. For -example, `git-svn-id` strings in a repository created by `git-svn` can +example, 'git-svn-id' strings in a repository created by 'git-svn' can be removed this way: ------------------------------------------------------- @@ -266,13 +266,13 @@ git filter-branch --msg-filter ' To restrict rewriting to only part of the history, specify a revision range in addition to the new branch name. The new branch name will -point to the top-most revision that a `git-rev-list` of this range +point to the top-most revision that a 'git-rev-list' of this range will print. *NOTE* the changes introduced by the commits, and which are not reverted by subsequent commits, will still be in the rewritten branch. If you want to throw out _changes_ together with the commits, you should use the -interactive mode of `git-rebase`. +interactive mode of 'git-rebase'. Consider this history: diff --git a/Documentation/git-fmt-merge-msg.txt b/Documentation/git-fmt-merge-msg.txt index ddb89f8d60..885edf005a 100644 --- a/Documentation/git-fmt-merge-msg.txt +++ b/Documentation/git-fmt-merge-msg.txt @@ -16,10 +16,10 @@ DESCRIPTION ----------- Takes the list of merged objects on stdin and produces a suitable commit message to be used for the merge commit, usually to be -passed as the '<merge-message>' argument of `git-merge`. +passed as the '<merge-message>' argument of 'git-merge'. This script is intended mostly for internal use by scripts -automatically invoking `git-merge`. +automatically invoking 'git-merge'. OPTIONS ------- diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt index 29c29f8830..727d84e673 100644 --- a/Documentation/git-for-each-ref.txt +++ b/Documentation/git-for-each-ref.txt @@ -79,7 +79,7 @@ objecttype:: The type of the object (`blob`, `tree`, `commit`, `tag`). objectsize:: - The size of the object (the same as `git-cat-file -s` reports). + The size of the object (the same as 'git-cat-file -s' reports). objectname:: The object name (aka SHA-1). diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt index 41e487ae1d..7c2ff3eb2d 100644 --- a/Documentation/git-format-patch.txt +++ b/Documentation/git-format-patch.txt @@ -27,7 +27,7 @@ DESCRIPTION Prepare each commit with its patch in one file per commit, formatted to resemble UNIX mailbox format. The output of this command is convenient for e-mail submission or -for use with `git-am`. +for use with 'git-am'. There are two ways to specify which commits to operate on. @@ -61,7 +61,7 @@ they are created in the current working directory. If -n is specified, instead of "[PATCH] Subject", the first line is formatted as "[PATCH n/m] Subject". -If given --thread, `git-format-patch` will generate In-Reply-To and +If given --thread, 'git-format-patch' will generate In-Reply-To and References headers to make the second and subsequent patch mails appear as replies to the first mail; this also generates a Message-Id header to reference. @@ -187,7 +187,7 @@ EXAMPLES -------- * Extract commits between revisions R1 and R2, and apply them on top of -the current branch using `git-am` to cherry-pick them: +the current branch using 'git-am' to cherry-pick them: + ------------ $ git format-patch -k --stdout R1..R2 | git am -3 -k diff --git a/Documentation/git-fsck.txt b/Documentation/git-fsck.txt index ef4ceb3dfd..524e0b1c6f 100644 --- a/Documentation/git-fsck.txt +++ b/Documentation/git-fsck.txt @@ -21,7 +21,7 @@ OPTIONS <object>:: An object to treat as the head of an unreachability trace. + -If no objects are given, `git-fsck` defaults to using the +If no objects are given, 'git-fsck' defaults to using the index file, all SHA1 references in .git/refs/*, and all reflogs (unless --no-reflogs is given) as heads. @@ -83,7 +83,7 @@ So for example will do quite a _lot_ of verification on the tree. There are a few extra validity tests to be added (make sure that tree objects are -sorted properly etc), but on the whole if `git-fsck` is happy, you +sorted properly etc), but on the whole if 'git-fsck' is happy, you do have a valid tree. Any corrupt objects you will have to find in backups or other archives diff --git a/Documentation/git-gc.txt b/Documentation/git-gc.txt index 0cce3894cb..7086eea74a 100644 --- a/Documentation/git-gc.txt +++ b/Documentation/git-gc.txt @@ -15,13 +15,13 @@ DESCRIPTION Runs a number of housekeeping tasks within the current repository, such as compressing file revisions (to reduce disk space and increase performance) and removing unreachable objects which may have been -created from prior invocations of `git-add`. +created from prior invocations of 'git-add'. Users are encouraged to run this task on a regular basis within each repository to maintain good disk space utilization and good operating performance. -Some git commands may automatically run `git-gc`; see the `--auto` flag +Some git commands may automatically run 'git-gc'; see the `--auto` flag below for details. If you know what you're doing and all you want is to disable this behavior permanently without further considerations, just do: @@ -33,15 +33,15 @@ OPTIONS ------- --aggressive:: - Usually `git-gc` runs very quickly while providing good disk + Usually 'git-gc' runs very quickly while providing good disk space utilization and performance. This option will cause - `git-gc` to more aggressively optimize the repository at the expense + 'git-gc' to more aggressively optimize the repository at the expense of taking much more time. The effects of this optimization are persistent, so this option only needs to be used occasionally; every few hundred changesets or so. --auto:: - With this option, `git-gc` checks whether any housekeeping is + With this option, 'git-gc' checks whether any housekeeping is required; if not, it exits without performing any work. Some git commands run `git gc --auto` after performing operations that could create many loose objects. @@ -50,13 +50,13 @@ Housekeeping is required if there are too many loose objects or too many packs in the repository. If the number of loose objects exceeds the value of the `gc.auto` configuration variable, then all loose objects are combined into a single pack using -`git-repack -d -l`. Setting the value of `gc.auto` to 0 +'git-repack -d -l'. Setting the value of `gc.auto` to 0 disables automatic packing of loose objects. + If the number of packs exceeds the value of `gc.autopacklimit`, then existing packs (except those marked with a `.keep` file) are consolidated into a single pack by using the `-A` option of -`git-repack`. Setting `gc.autopacklimit` to 0 disables +'git-repack'. Setting `gc.autopacklimit` to 0 disables automatic consolidation of packs. --quiet:: @@ -89,7 +89,7 @@ how long records of conflicted merge you have not resolved are kept. This defaults to 15 days. The optional configuration variable 'gc.packrefs' determines if -`git-gc` runs `git-pack-refs`. This can be set to "nobare" to enable +'git-gc' runs 'git-pack-refs'. This can be set to "nobare" to enable it within all non-bare repos or it can be set to a boolean value. This defaults to true. @@ -108,10 +108,10 @@ default is "2 weeks ago". Notes ----- -`git-gc` tries very hard to be safe about the garbage it collects. In +'git-gc' tries very hard to be safe about the garbage it collects. In particular, it will keep not only objects referenced by your current set of branches and tags, but also objects referenced by the index, remote -tracking branches, refs saved by `git-filter-branch` in +tracking branches, refs saved by 'git-filter-branch' in refs/original/, or reflogs (which may references commits in branches that were later amended or rewound). diff --git a/Documentation/git-get-tar-commit-id.txt b/Documentation/git-get-tar-commit-id.txt index 50dfdfa19b..84f23ee525 100644 --- a/Documentation/git-get-tar-commit-id.txt +++ b/Documentation/git-get-tar-commit-id.txt @@ -14,12 +14,12 @@ SYNOPSIS DESCRIPTION ----------- Acts as a filter, extracting the commit ID stored in archives created by -`git-archive`. It reads only the first 1024 bytes of input, thus its +'git-archive'. It reads only the first 1024 bytes of input, thus its runtime is not influenced by the size of <tarfile> very much. -If no commit ID is found, `git-get-tar-commit-id` quietly exists with a +If no commit ID is found, 'git-get-tar-commit-id' quietly exists with a return code of 1. This can happen if <tarfile> had not been created -using `git-archive` or if the first parameter of `git-archive` had been +using 'git-archive' or if the first parameter of 'git-archive' had been a tree ID instead of a commit ID or tag. diff --git a/Documentation/git-grep.txt b/Documentation/git-grep.txt index 25cb64957c..fa4d133c1b 100644 --- a/Documentation/git-grep.txt +++ b/Documentation/git-grep.txt @@ -91,7 +91,7 @@ OPTIONS --files-without-match:: Instead of showing every matched line, show only the names of files that contain (or do not contain) matches. - For better compatibility with `git-diff`, --name-only is a + For better compatibility with 'git-diff', --name-only is a synonym for --files-with-matches. -c:: diff --git a/Documentation/git-gui.txt b/Documentation/git-gui.txt index ea1e4ce624..f067772baa 100644 --- a/Documentation/git-gui.txt +++ b/Documentation/git-gui.txt @@ -11,19 +11,19 @@ SYNOPSIS DESCRIPTION ----------- -A Tcl/Tk based graphical user interface to Git. `git-gui` focuses +A Tcl/Tk based graphical user interface to Git. 'git-gui' focuses on allowing users to make changes to their repository by making new commits, amending existing ones, creating branches, performing local merges, and fetching/pushing to remote repositories. -Unlike `gitk`, `git-gui` focuses on commit generation +Unlike `gitk`, 'git-gui' focuses on commit generation and single file annotation and does not show project history. It does however supply menu actions to start a `gitk` session from -within `git-gui`. +within 'git-gui'. -`git-gui` is known to work on all popular UNIX systems, Mac OS X, +'git-gui' is known to work on all popular UNIX systems, Mac OS X, and Windows (under both Cygwin and MSYS). To the extent possible -OS specific user interface guidelines are followed, making `git-gui` +OS specific user interface guidelines are followed, making 'git-gui' a fairly native interface for users. COMMANDS @@ -38,13 +38,13 @@ browser:: browser are opened in the blame viewer. citool:: - Start `git-gui` and arrange to make exactly one commit before + Start 'git-gui' and arrange to make exactly one commit before exiting and returning to the shell. The interface is limited to only commit actions, slightly reducing the application's startup time and simplifying the menubar. version:: - Display the currently running version of `git-gui`. + Display the currently running version of 'git-gui'. Examples @@ -84,15 +84,15 @@ SEE ALSO linkgit:gitk[1]:: The git repository browser. Shows branches, commit history and file differences. gitk is the utility started by - `git-gui`'s Repository Visualize actions. + 'git-gui''s Repository Visualize actions. Other ----- -`git-gui` is actually maintained as an independent project, but stable +'git-gui' is actually maintained as an independent project, but stable versions are distributed as part of the Git suite for the convenience of end users. -A `git-gui` development repository can be obtained from: +A 'git-gui' development repository can be obtained from: git clone git://repo.or.cz/git-gui.git diff --git a/Documentation/git-hash-object.txt b/Documentation/git-hash-object.txt index 05550c5ac7..9e654fc41c 100644 --- a/Documentation/git-hash-object.txt +++ b/Documentation/git-hash-object.txt @@ -16,7 +16,7 @@ Computes the object ID value for an object with specified type with the contents of the named file (which can be outside of the work tree), and optionally writes the resulting object into the object database. Reports its object ID to its standard output. -This is used by `git-cvsimport` to update the index +This is used by 'git-cvsimport' to update the index without modifying files in the work tree. When <type> is not specified, it defaults to "blob". diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt index 73ec7ad9eb..d5b20f88f4 100644 --- a/Documentation/git-help.txt +++ b/Documentation/git-help.txt @@ -55,8 +55,8 @@ other display programs (see below). + The web browser can be specified using the configuration variable 'help.browser', or 'web.browser' if the former is not set. If none of -these config variables is set, the `git-web--browse` helper script -(called by `git-help`) will pick a suitable default. See +these config variables is set, the 'git-web--browse' helper script +(called by 'git-help') will pick a suitable default. See linkgit:git-web--browse[1] for more information about this. CONFIGURATION VARIABLES @@ -67,7 +67,7 @@ help.format If no command line option is passed, the 'help.format' configuration variable will be checked. The following values are supported for this -variable; they make `git-help` behave as their corresponding command +variable; they make 'git-help' behave as their corresponding command line option: * "man" corresponds to '-m|--man', diff --git a/Documentation/git-http-fetch.txt b/Documentation/git-http-fetch.txt index cfc5989b95..e7c796155f 100644 --- a/Documentation/git-http-fetch.txt +++ b/Documentation/git-http-fetch.txt @@ -35,7 +35,7 @@ commit-id:: --stdin:: Instead of a commit id on the command line (which is not expected in this - case), `git-http-fetch` expects lines on stdin in the format + case), 'git-http-fetch' expects lines on stdin in the format <commit-id>['\t'<filename-as-in--w>] diff --git a/Documentation/git-imap-send.txt b/Documentation/git-imap-send.txt index 776aa254da..b3d8da33ee 100644 --- a/Documentation/git-imap-send.txt +++ b/Documentation/git-imap-send.txt @@ -26,7 +26,7 @@ git format-patch --signoff --stdout --attach origin | git imap-send CONFIGURATION ------------- -`git-imap-send` requires the following values in the repository +'git-imap-send' requires the following values in the repository configuration file (shown with examples): .......................... diff --git a/Documentation/git-index-pack.txt b/Documentation/git-index-pack.txt index 1940237741..4b5c743c1e 100644 --- a/Documentation/git-index-pack.txt +++ b/Documentation/git-index-pack.txt @@ -43,10 +43,10 @@ OPTIONS a default name determined from the pack content. If <pack-file> is not specified consider using --keep to prevent a race condition between this process and - `git-repack`. + 'git-repack'. --fix-thin:: - It is possible for `git-pack-objects` to build + It is possible for 'git-pack-objects' to build "thin" pack, which records objects in deltified form based on objects not included in the pack to reduce network traffic. Those objects are expected to be present on the receiving end @@ -59,7 +59,7 @@ OPTIONS Before moving the index into its final destination create an empty .keep file for the associated pack file. This option is usually necessary with --stdin to prevent a - simultaneous `git-repack` process from deleting + simultaneous 'git-repack' process from deleting the newly constructed pack and index before refs can be updated to use objects contained in the pack. @@ -86,7 +86,7 @@ Once the index has been created, the list of object names is sorted and the SHA1 hash of that list is printed to stdout. If --stdin was also used then this is prefixed by either "pack\t", or "keep\t" if a new .keep file was successfully created. This is useful to remove a -.keep file used as a lock to prevent the race with `git-repack` +.keep file used as a lock to prevent the race with 'git-repack' mentioned above. diff --git a/Documentation/git-init.txt b/Documentation/git-init.txt index 45244737fd..71749c09d3 100644 --- a/Documentation/git-init.txt +++ b/Documentation/git-init.txt @@ -86,11 +86,11 @@ If the object storage directory is specified via the `$GIT_OBJECT_DIRECTORY` environment variable then the sha1 directories are created underneath - otherwise the default `$GIT_DIR/objects` directory is used. -Running `git-init` in an existing repository is safe. It will not overwrite -things that are already there. The primary reason for rerunning `git-init` +Running 'git-init' in an existing repository is safe. It will not overwrite +things that are already there. The primary reason for rerunning 'git-init' is to pick up newly added templates. -Note that `git-init` is the same as `git-init-db`. The command +Note that 'git-init' is the same as 'git-init-db'. The command was primarily meant to initialize the object database, but over time it has become responsible for setting up the other aspects of the repository, such as installing the default hooks and diff --git a/Documentation/git-instaweb.txt b/Documentation/git-instaweb.txt index e7ca537e37..22da21a54f 100644 --- a/Documentation/git-instaweb.txt +++ b/Documentation/git-instaweb.txt @@ -44,7 +44,7 @@ OPTIONS -b:: --browser:: The web browser that should be used to view the gitweb - page. This will be passed to the `git-web--browse` helper + page. This will be passed to the 'git-web--browse' helper script along with the URL of the gitweb instance. See linkgit:git-web--browse[1] for more information about this. If the script fails, the URL will be printed to stdout. diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt index 3373c2636a..5a58d5b03d 100644 --- a/Documentation/git-log.txt +++ b/Documentation/git-log.txt @@ -14,9 +14,9 @@ DESCRIPTION ----------- Shows the commit logs. -The command takes options applicable to the `git-rev-list` +The command takes options applicable to the 'git-rev-list' command to control what is shown and how, and options applicable to -the `git-diff-*` commands to control how the changes +the 'git-diff-*' commands to control how the changes each commit introduces are shown. diff --git a/Documentation/git-ls-files.txt b/Documentation/git-ls-files.txt index a6883bf43b..f43af41740 100644 --- a/Documentation/git-ls-files.txt +++ b/Documentation/git-ls-files.txt @@ -143,7 +143,7 @@ which case it outputs: [<tag> ]<mode> <object> <stage> <file> -`git-ls-files --unmerged` and `git-ls-files --stage` can be used to examine +'git-ls-files --unmerged' and 'git-ls-files --stage' can be used to examine detailed information on unmerged paths. For an unmerged path, instead of recording a single mode/SHA1 pair, @@ -160,7 +160,7 @@ respectively. Exclude Patterns ---------------- -`git-ls-files` can use a list of "exclude patterns" when +'git-ls-files' can use a list of "exclude patterns" when traversing the directory tree and finding files to show when the flags --others or --ignored are specified. linkgit:gitignore[5] specifies the format of exclude patterns. @@ -176,7 +176,7 @@ These exclude patterns come from these places, in order: in the same order they appear in the file. 3. command line flag --exclude-per-directory=<name> specifies - a name of the file in each directory `git-ls-files` + a name of the file in each directory 'git-ls-files' examines, normally `.gitignore`. Files in deeper directories take precedence. Patterns are ordered in the same order they appear in the files. diff --git a/Documentation/git-ls-remote.txt b/Documentation/git-ls-remote.txt index c267cdae4a..4f252441ed 100644 --- a/Documentation/git-ls-remote.txt +++ b/Documentation/git-ls-remote.txt @@ -31,7 +31,7 @@ OPTIONS -u <exec>:: --upload-pack=<exec>:: - Specify the full path of `git-upload-pack` on the remote + Specify the full path of 'git-upload-pack' on the remote host. This allows listing references from repositories accessed via SSH and where the SSH daemon does not use the PATH configured by the user. diff --git a/Documentation/git-mailinfo.txt b/Documentation/git-mailinfo.txt index 6ebdeee843..cc52db3bef 100644 --- a/Documentation/git-mailinfo.txt +++ b/Documentation/git-mailinfo.txt @@ -16,7 +16,7 @@ DESCRIPTION Reading a single e-mail message from the standard input, and writes the commit log message in <msg> file, and the patches in <patch> file. The author name, e-mail and e-mail subject are -written out to the standard output to be used by `git-am` +written out to the standard output to be used by 'git-am' to create a commit. It is usually not necessary to use this command directly. See linkgit:git-am[1] instead. @@ -30,7 +30,7 @@ OPTIONS whitespaces, (3) '[' up to ']', typically '[PATCH]', and then prepends "[PATCH] ". This flag forbids this munging, and is most useful when used to read back - `git-format-patch -k` output. + 'git-format-patch -k' output. -u:: The commit log message, author name and author email are diff --git a/Documentation/git-merge-base.txt b/Documentation/git-merge-base.txt index 41fb0c76ac..1a7ecbf8f3 100644 --- a/Documentation/git-merge-base.txt +++ b/Documentation/git-merge-base.txt @@ -13,7 +13,7 @@ SYNOPSIS DESCRIPTION ----------- -`git-merge-base` finds as good a common ancestor as possible between +'git-merge-base' finds as good a common ancestor as possible between the two commits. That is, given two commits A and B, `git merge-base A B` will output a commit which is reachable from both A and B through the parent relationship. @@ -21,7 +21,7 @@ the parent relationship. Given a selection of equally good common ancestors it should not be relied on to decide in any particular way. -The `git-merge-base` algorithm is still in flux - use the source... +The 'git-merge-base' algorithm is still in flux - use the source... OPTIONS ------- diff --git a/Documentation/git-merge-file.txt b/Documentation/git-merge-file.txt index 2a418175ac..6e70ea4923 100644 --- a/Documentation/git-merge-file.txt +++ b/Documentation/git-merge-file.txt @@ -15,15 +15,15 @@ SYNOPSIS DESCRIPTION ----------- -`git-file-merge` incorporates all changes that lead from the `<base-file>` +'git-file-merge' incorporates all changes that lead from the `<base-file>` to `<other-file>` into `<current-file>`. The result ordinarily goes into -`<current-file>`. `git-merge-file` is useful for combining separate changes +`<current-file>`. 'git-merge-file' is useful for combining separate changes to an original. Suppose `<base-file>` is the original, and both `<current-file>` and `<other-file>` are modifications of `<base-file>`. -Then `git-merge-file` combines both changes. +Then 'git-merge-file' combines both changes. A conflict occurs if both `<current-file>` and `<other-file>` have changes -in a common segment of lines. If a conflict is found, `git-merge-file` +in a common segment of lines. If a conflict is found, 'git-merge-file' normally outputs a warning and brackets the conflict with <<<<<<< and >>>>>>> lines. A typical conflict will look like this: @@ -39,7 +39,7 @@ the alternatives. The exit value of this program is negative on error, and the number of conflicts otherwise. If the merge was clean, the exit value is 0. -`git-merge-file` is designed to be a minimal clone of RCS `merge`; that is, it +'git-merge-file' is designed to be a minimal clone of RCS `merge`; that is, it implements all of RCS merge's functionality which is needed by linkgit:git[1]. diff --git a/Documentation/git-merge-index.txt b/Documentation/git-merge-index.txt index 4f04bbb1aa..5ebed57be3 100644 --- a/Documentation/git-merge-index.txt +++ b/Documentation/git-merge-index.txt @@ -36,14 +36,14 @@ OPTIONS failure usually indicates conflicts during merge). This is for porcelains which might want to emit custom messages. -If `git-merge-index` is called with multiple <file>s (or -a) then it +If 'git-merge-index' is called with multiple <file>s (or -a) then it processes them in turn only stopping if merge returns a non-zero exit code. Typically this is run with a script calling git's imitation of the 'merge' command from the RCS package. -A sample script called `git-merge-one-file` is included in the +A sample script called 'git-merge-one-file' is included in the distribution. ALERT ALERT ALERT! The git "merge object order" is different from the @@ -68,10 +68,10 @@ or This is added AA in the branch B. fatal: merge program failed -where the latter example shows how `git-merge-index` will stop trying to +where the latter example shows how 'git-merge-index' will stop trying to merge once anything has returned an error (i.e., `cat` returned an error for the AA file, because it didn't exist in the original, and thus -`git-merge-index` didn't even try to merge the MM thing). +'git-merge-index' didn't even try to merge the MM thing). Author ------ diff --git a/Documentation/git-merge-one-file.txt b/Documentation/git-merge-one-file.txt index 62e09afe13..1dd134538d 100644 --- a/Documentation/git-merge-one-file.txt +++ b/Documentation/git-merge-one-file.txt @@ -12,8 +12,8 @@ SYNOPSIS DESCRIPTION ----------- -This is the standard helper program to use with `git-merge-index` -to resolve a merge after the trivial merge done with `git-read-tree -m`. +This is the standard helper program to use with 'git-merge-index' +to resolve a merge after the trivial merge done with 'git-read-tree -m'. Author ------ diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt index e6fa2b9ae4..62f99b5f3b 100644 --- a/Documentation/git-merge.txt +++ b/Documentation/git-merge.txt @@ -29,8 +29,8 @@ include::merge-options.txt[] -m <msg>:: The commit message to be used for the merge commit (in case - it is created). The `git-fmt-merge-msg` script can be used - to give a good default for automated `git-merge` invocations. + it is created). The 'git-fmt-merge-msg' script can be used + to give a good default for automated 'git-merge' invocations. <remote>:: Other branch head merged into our branch. You need at @@ -41,7 +41,7 @@ include::merge-strategies.txt[] If you tried a merge which resulted in a complex conflicts and -would want to start over, you can recover with `git-reset`. +would want to start over, you can recover with 'git-reset'. CONFIGURATION ------------- @@ -49,7 +49,7 @@ include::merge-config.txt[] branch.<name>.mergeoptions:: Sets default options for merging into branch <name>. The syntax and - supported options are equal to that of `git-merge`, but option values + supported options are equal to that of 'git-merge', but option values containing whitespace characters are currently not supported. HOW MERGE WORKS @@ -84,7 +84,7 @@ with `git pull remote rbranch:lbranch`, but your working tree, `.git/HEAD` pointer and index file are left intact). You may have local modifications in the working tree files. In -other words, `git-diff` is allowed to report changes. +other words, 'git-diff' is allowed to report changes. However, the merge uses your working tree as the working area, and in order to prevent the merge operation from losing such changes, it makes sure that they do not interfere with the @@ -140,14 +140,14 @@ After seeing a conflict, you can do two things: * Decide not to merge. The only clean-up you need are to reset the index file to the `HEAD` commit to reverse 2. and to clean - up working tree changes made by 2. and 3.; `git-reset` can + up working tree changes made by 2. and 3.; 'git-reset' can be used for this. * Resolve the conflicts. `git diff` would report only the conflicting paths because of the above 2. and 3. Edit the - working tree files into a desirable shape, `git-add` or `git-rm` + working tree files into a desirable shape, 'git-add' or 'git-rm' them, to make the index file contain what the merge result - should be, and run `git-commit` to commit the result. + should be, and run 'git-commit' to commit the result. SEE ALSO diff --git a/Documentation/git-mergetool.txt b/Documentation/git-mergetool.txt index fedcfa0543..31570b1e27 100644 --- a/Documentation/git-mergetool.txt +++ b/Documentation/git-mergetool.txt @@ -13,11 +13,11 @@ DESCRIPTION ----------- Use `git mergetool` to run one of several merge utilities to resolve -merge conflicts. It is typically run after `git-merge`. +merge conflicts. It is typically run after 'git-merge'. If one or more <file> parameters are given, the merge tool program will be run to resolve differences on each file. If no <file> names are -specified, `git-mergetool` will run the merge tool program on every file +specified, 'git-mergetool' will run the merge tool program on every file with merge conflicts. OPTIONS @@ -27,23 +27,23 @@ OPTIONS Valid merge tools are: kdiff3, tkdiff, meld, xxdiff, emerge, vimdiff, gvimdiff, ecmerge, and opendiff + -If a merge resolution program is not specified, `git-mergetool` +If a merge resolution program is not specified, 'git-mergetool' will use the configuration variable `merge.tool`. If the -configuration variable `merge.tool` is not set, `git-mergetool` +configuration variable `merge.tool` is not set, 'git-mergetool' will pick a suitable default. + You can explicitly provide a full path to the tool by setting the configuration variable `mergetool.<tool>.path`. For example, you can configure the absolute path to kdiff3 by setting -`mergetool.kdiff3.path`. Otherwise, `git-mergetool` assumes the +`mergetool.kdiff3.path`. Otherwise, 'git-mergetool' assumes the tool is available in PATH. + Instead of running one of the known merge tool programs -`git-mergetool` can be customized to run an alternative program +'git-mergetool' can be customized to run an alternative program by specifying the command line to invoke in a configration variable `mergetool.<tool>.cmd`. + -When `git-mergetool` is invoked with this tool (either through the +When 'git-mergetool' is invoked with this tool (either through the `-t` or `--tool` option or the `merge.tool` configuration variable) the configured command line will be invoked with `$BASE` set to the name of a temporary file containing the common base for @@ -57,7 +57,7 @@ merge resolution. If the custom merge tool correctly indicates the success of a merge resolution with its exit code then the configuration variable `mergetool.<tool>.trustExitCode` can be set to `true`. -Otherwise, `git-mergetool` will prompt the user to indicate the +Otherwise, 'git-mergetool' will prompt the user to indicate the success of the resolution after the custom tool has exited. Author diff --git a/Documentation/git-name-rev.txt b/Documentation/git-name-rev.txt index 00b1fa4dcb..6e77ab1353 100644 --- a/Documentation/git-name-rev.txt +++ b/Documentation/git-name-rev.txt @@ -15,7 +15,7 @@ SYNOPSIS DESCRIPTION ----------- Finds symbolic names suitable for human digestion for revisions given in any -format parsable by `git-rev-parse`. +format parsable by 'git-rev-parse'. OPTIONS @@ -38,7 +38,7 @@ OPTIONS Instead of printing both the SHA-1 and the name, print only the name. If given with --tags the usual tag prefix of "tags/" is also omitted from the name, matching the output - of `git-describe` more closely. This option + of 'git-describe' more closely. This option cannot be combined with --stdin. --no-undefined:: @@ -56,7 +56,7 @@ wrote you about that fantastic commit 33db5f4d9027a10e477ccf054b2c1ab94f74c85a. Of course, you look into the commit, but that only tells you what happened, but not the context. -Enter `git-name-rev`: +Enter 'git-name-rev': ------------ % git name-rev 33db5f4d9027a10e477ccf054b2c1ab94f74c85a diff --git a/Documentation/git-pack-objects.txt b/Documentation/git-pack-objects.txt index d9cd16ae16..8c354bd470 100644 --- a/Documentation/git-pack-objects.txt +++ b/Documentation/git-pack-objects.txt @@ -30,7 +30,7 @@ Placing both in the pack/ subdirectory of $GIT_OBJECT_DIRECTORY (or any of the directories on $GIT_ALTERNATE_OBJECT_DIRECTORIES) enables git to read from such an archive. -The `git-unpack-objects` command can read the packed archive and +The 'git-unpack-objects' command can read the packed archive and expand the objects contained in the pack into "one-file one-object" format; this is typically done by the smart-pull commands when a pack is created on-the-fly for efficient network @@ -59,7 +59,7 @@ base-name:: --revs:: Read the revision arguments from the standard input, instead of individual object names. The revision arguments are processed - the same way as `git-rev-list` with the `--objects` flag + the same way as 'git-rev-list' with the `--objects` flag uses its `commit` arguments to build the list of objects it outputs. The objects on the resulting list are packed. @@ -170,7 +170,7 @@ base-name:: A packed archive can express base object of a delta as either 20-byte object name or as an offset in the stream, but older version of git does not understand the - latter. By default, `git-pack-objects` only uses the + latter. By default, 'git-pack-objects' only uses the former format for better compatibility. This option allows the command to use the latter format for compactness. Depending on the average delta chain diff --git a/Documentation/git-pack-redundant.txt b/Documentation/git-pack-redundant.txt index 80fc1bae35..5f9435e59b 100644 --- a/Documentation/git-pack-redundant.txt +++ b/Documentation/git-pack-redundant.txt @@ -16,7 +16,7 @@ This program computes which packs in your repository are redundant. The output is suitable for piping to `xargs rm` if you are in the root of the repository. -`git-pack-redundant` accepts a list of objects on standard input. Any objects +'git-pack-redundant' accepts a list of objects on standard input. Any objects given will be ignored when checking which packs are required. This makes the following command useful when wanting to remove packs which contain unreachable objects. diff --git a/Documentation/git-parse-remote.txt b/Documentation/git-parse-remote.txt index 421312eca9..cd43069874 100644 --- a/Documentation/git-parse-remote.txt +++ b/Documentation/git-parse-remote.txt @@ -32,7 +32,7 @@ get_remote_refs_for_fetch:: get_remote_refs_for_push:: Given the list of user-supplied `<repo> <refspec>...`, return the list of refs to push in a form suitable to be - fed to the `git-send-pack` command. When `<refspec>...` + fed to the 'git-send-pack' command. When `<refspec>...` is empty the returned list of refs consists of the defaults for the given `<repo>`, if specified in `$GIT_DIR/remotes/`. diff --git a/Documentation/git-patch-id.txt b/Documentation/git-patch-id.txt index 17c178f867..477785e134 100644 --- a/Documentation/git-patch-id.txt +++ b/Documentation/git-patch-id.txt @@ -18,7 +18,7 @@ ID" are almost guaranteed to be the same thing. IOW, you can use this thing to look for likely duplicate commits. -When dealing with `git-diff-tree` output, it takes advantage of +When dealing with 'git-diff-tree' output, it takes advantage of the fact that the patch is prefixed with the object name of the commit, and outputs two 40-byte hexadecimal string. The first string is the patch ID, and the second string is the commit ID. diff --git a/Documentation/git-peek-remote.txt b/Documentation/git-peek-remote.txt index c3ed4a10f4..79c03ee7f7 100644 --- a/Documentation/git-peek-remote.txt +++ b/Documentation/git-peek-remote.txt @@ -12,12 +12,12 @@ SYNOPSIS DESCRIPTION ----------- -This command is deprecated; use `git-ls-remote` instead. +This command is deprecated; use 'git-ls-remote' instead. OPTIONS ------- --upload-pack=<git-upload-pack>:: - Use this to specify the path to `git-upload-pack` on the + Use this to specify the path to 'git-upload-pack' on the remote side, if it is not found on your $PATH. Some installations of sshd ignores the user's environment setup scripts for login shells (e.g. .bash_profile) and @@ -30,7 +30,7 @@ OPTIONS <host>:: A remote host that houses the repository. When this - part is specified, `git-upload-pack` is invoked via + part is specified, 'git-upload-pack' is invoked via ssh. <directory>:: diff --git a/Documentation/git-prune.txt b/Documentation/git-prune.txt index a4a0d56cae..54f1dab38d 100644 --- a/Documentation/git-prune.txt +++ b/Documentation/git-prune.txt @@ -13,16 +13,16 @@ SYNOPSIS DESCRIPTION ----------- -NOTE: In most cases, users should run `git-gc`, which calls -`git-prune`. See the section "NOTES", below. +NOTE: In most cases, users should run 'git-gc', which calls +'git-prune'. See the section "NOTES", below. -This runs `git-fsck --unreachable` using all the refs +This runs 'git-fsck --unreachable' using all the refs available in `$GIT_DIR/refs`, optionally with additional set of objects specified on the command line, and prunes all unpacked objects unreachable from any of these head objects from the object database. In addition, it prunes the unpacked objects that are also found in packs by -running `git-prune-packed`. +running 'git-prune-packed'. Note that unreachable, packed objects will remain. If this is not desired, see linkgit:git-repack[1]. @@ -59,12 +59,12 @@ $ git prune $(cd ../another && $(git rev-parse --all)) Notes ----- -In most cases, users will not need to call `git-prune` directly, but -should instead call `git-gc`, which handles pruning along with +In most cases, users will not need to call 'git-prune' directly, but +should instead call 'git-gc', which handles pruning along with many other housekeeping tasks. For a description of which objects are considered for pruning, see -`git-fsck`'s --unreachable option. +'git-fsck''s --unreachable option. SEE ALSO -------- diff --git a/Documentation/git-pull.txt b/Documentation/git-pull.txt index d9537ebc6a..092d1b8a3e 100644 --- a/Documentation/git-pull.txt +++ b/Documentation/git-pull.txt @@ -13,16 +13,16 @@ SYNOPSIS DESCRIPTION ----------- -Runs `git-fetch` with the given parameters, and calls `git-merge` +Runs 'git-fetch' with the given parameters, and calls 'git-merge' to merge the retrieved head(s) into the current branch. -With `--rebase`, calls `git-rebase` instead of `git-merge`. +With `--rebase`, calls 'git-rebase' instead of 'git-merge'. Note that you can use `.` (current directory) as the <repository> to pull from the local repository -- this is useful when merging local branches into the current branch. -Also note that options meant for `git-pull` itself and underlying -`git-merge` must be given before the options meant for `git-fetch`. +Also note that options meant for 'git-pull' itself and underlying +'git-merge' must be given before the options meant for 'git-fetch'. OPTIONS ------- @@ -182,7 +182,7 @@ The final command then merges the newly fetched `tmp` into master. If you tried a pull which resulted in a complex conflicts and -would want to start over, you can recover with `git-reset`. +would want to start over, you can recover with 'git-reset'. SEE ALSO diff --git a/Documentation/git-push.txt b/Documentation/git-push.txt index 1f70e72758..c44dce374a 100644 --- a/Documentation/git-push.txt +++ b/Documentation/git-push.txt @@ -85,7 +85,7 @@ nor in any Push line of the corresponding remotes file---see below). line. --receive-pack=<git-receive-pack>:: - Path to the `git-receive-pack` program on the remote + Path to the 'git-receive-pack' program on the remote end. Sometimes useful when pushing to a remote repository over ssh, and you do not have the program in a directory on the default $PATH. @@ -106,7 +106,7 @@ nor in any Push line of the corresponding remotes file---see below). --thin:: --no-thin:: - These options are passed to `git-send-pack`. Thin + These options are passed to 'git-send-pack'. Thin transfer spends extra cycles to minimize the number of objects to be sent and meant to be used on slower connection. diff --git a/Documentation/git-read-tree.txt b/Documentation/git-read-tree.txt index 0c7cc6b940..6f4b9b017f 100644 --- a/Documentation/git-read-tree.txt +++ b/Documentation/git-read-tree.txt @@ -22,8 +22,8 @@ fast-forward (i.e. 2-way) merge, or a 3-way merge, with the `-m` flag. When used with `-m`, the `-u` flag causes it to also update the files in the work tree with the result of the merge. -Trivial merges are done by `git-read-tree` itself. Only conflicting paths -will be in unmerged state when `git-read-tree` returns. +Trivial merges are done by 'git-read-tree' itself. Only conflicting paths +will be in unmerged state when 'git-read-tree' returns. OPTIONS ------- @@ -54,13 +54,13 @@ OPTIONS Show the progress of checking files out. --trivial:: - Restrict three-way merge by `git-read-tree` to happen + Restrict three-way merge by 'git-read-tree' to happen only if there is no file-level merging required, instead of resolving merge for trivial cases and leaving conflicting files unresolved in the index. --aggressive:: - Usually a three-way merge by `git-read-tree` resolves + Usually a three-way merge by 'git-read-tree' resolves the merge for really trivial cases and leaves other cases unresolved in the index, so that Porcelains can implement different merge policies. This flag makes the @@ -113,7 +113,7 @@ OPTIONS Merging ------- -If `-m` is specified, `git-read-tree` can perform 3 kinds of +If `-m` is specified, 'git-read-tree' can perform 3 kinds of merge, a single tree merge if only 1 tree is given, a fast-forward merge with 2 trees, or a 3-way merge if 3 trees are provided. @@ -121,18 +121,18 @@ provided. Single Tree Merge ~~~~~~~~~~~~~~~~~ -If only 1 tree is specified, `git-read-tree` operates as if the user did not +If only 1 tree is specified, 'git-read-tree' operates as if the user did not specify `-m`, except that if the original index has an entry for a given pathname, and the contents of the path matches with the tree being read, the stat info from the index is used. (In other words, the index's stat()s take precedence over the merged tree's). That means that if you do a `git read-tree -m <newtree>` followed by a -`git checkout-index -f -u -a`, the `git-checkout-index` only checks out +`git checkout-index -f -u -a`, the 'git-checkout-index' only checks out the stuff that really changed. -This is used to avoid unnecessary false hits when `git-diff-files` is -run after `git-read-tree`. +This is used to avoid unnecessary false hits when 'git-diff-files' is +run after 'git-read-tree'. Two Tree Merge @@ -143,7 +143,7 @@ is the head commit of the current repository, and $M is the head of a foreign tree, which is simply ahead of $H (i.e. we are in a fast forward situation). -When two trees are specified, the user is telling `git-read-tree` +When two trees are specified, the user is telling 'git-read-tree' the following: 1. The current index and work tree is derived from $H, but @@ -193,10 +193,10 @@ Here are the "carry forward" rules: In all "keep index" cases, the index entry stays as in the original index file. If the entry were not up to date, -`git-read-tree` keeps the copy in the work tree intact when +'git-read-tree' keeps the copy in the work tree intact when operating under the -u flag. -When this form of `git-read-tree` returns successfully, you can +When this form of 'git-read-tree' returns successfully, you can see what "local changes" you made are carried forward by running `git diff-index --cached $M`. Note that this does not necessarily match `git diff-index --cached $H` would have @@ -213,7 +213,7 @@ output after two-tree merge. Each "index" entry has two bits worth of "stage" state. stage 0 is the normal one, and is the only one you'd see in any kind of normal use. -However, when you do `git-read-tree` with three trees, the "stage" +However, when you do 'git-read-tree' with three trees, the "stage" starts out at 1. This means that you can do @@ -229,7 +229,7 @@ branch into the current branch, we use the common ancestor tree as <tree1>, the current branch head as <tree2>, and the other branch head as <tree3>. -Furthermore, `git-read-tree` has special-case logic that says: if you see +Furthermore, 'git-read-tree' has special-case logic that says: if you see a file that matches in all respects in the following states, it "collapses" back to "stage0": @@ -245,7 +245,7 @@ a file that matches in all respects in the following states, it - stage 1 and stage 3 are the same and stage 2 is different take stage 2 (we did something while they did nothing) -The `git-write-tree` command refuses to write a nonsensical tree, and it +The 'git-write-tree' command refuses to write a nonsensical tree, and it will complain about unmerged entries if it sees a single entry that is not stage 0. @@ -261,7 +261,7 @@ start a 3-way merge with an index file that is already populated. Here is an outline of how the algorithm works: - if a file exists in identical format in all three trees, it will - automatically collapse to "merged" state by `git-read-tree`. + automatically collapse to "merged" state by 'git-read-tree'. - a file that has _any_ difference what-so-ever in the three trees will stay as separate entries in the index. It's up to "porcelain @@ -285,8 +285,8 @@ populated. Here is an outline of how the algorithm works: matching "stage1" entry if it exists too. .. all the normal trivial rules .. -You would normally use `git-merge-index` with supplied -`git-merge-one-file` to do this last step. The script updates +You would normally use 'git-merge-index' with supplied +'git-merge-one-file' to do this last step. The script updates the files in the working tree as it merges each path and at the end of a successful merge. @@ -308,7 +308,7 @@ $ JC=`git rev-parse --verify "HEAD^0"` $ git checkout-index -f -u -a $JC ---------------- -You do random edits, without running `git-update-index`. And then +You do random edits, without running 'git-update-index'. And then you notice that the tip of your "upstream" tree has advanced since you pulled from him: @@ -334,14 +334,14 @@ your work-in-progress changes, and your work tree would be updated to the result of the merge. However, if you have local changes in the working tree that -would be overwritten by this merge, `git-read-tree` will refuse +would be overwritten by this merge, 'git-read-tree' will refuse to run to prevent your changes from being lost. In other words, there is no need to worry about what exists only in the working tree. When you have local changes in a part of the project that is not involved in the merge, your changes do not interfere with the merge, and are kept intact. When they -*do* interfere, the merge does not even start (`git-read-tree` +*do* interfere, the merge does not even start ('git-read-tree' complains loudly and fails without modifying anything). In such a case, you can simply continue doing what you were in the middle of doing, and when your working tree is ready (i.e. you diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt index 67aa497f46..f3459c7de7 100644 --- a/Documentation/git-rebase.txt +++ b/Documentation/git-rebase.txt @@ -16,7 +16,7 @@ SYNOPSIS DESCRIPTION ----------- -If <branch> is specified, `git-rebase` will perform an automatic +If <branch> is specified, 'git-rebase' will perform an automatic `git checkout <branch>` before doing anything else. Otherwise it remains on the current branch. @@ -167,8 +167,8 @@ This is useful if F and G were flawed in some way, or should not be part of topicA. Note that the argument to --onto and the <upstream> parameter can be any valid commit-ish. -In case of conflict, `git-rebase` will stop at the first problematic commit -and leave conflict markers in the tree. You can use `git-diff` to locate +In case of conflict, 'git-rebase' will stop at the first problematic commit +and leave conflict markers in the tree. You can use 'git-diff' to locate the markers (<<<<<<) and make edits to resolve the conflict. For each file you edit, you need to tell git that the conflict has been resolved, typically this would be done with @@ -184,7 +184,7 @@ desired resolution, you can continue the rebasing process with git rebase --continue -Alternatively, you can undo the `git-rebase` with +Alternatively, you can undo the 'git-rebase' with git rebase --abort @@ -224,8 +224,8 @@ OPTIONS Use the given merge strategy; can be supplied more than once to specify them in the order they should be tried. If there is no `-s` option, a built-in list of strategies - is used instead (`git-merge-recursive` when merging a single - head, `git-merge-octopus` otherwise). This implies --merge. + is used instead ('git-merge-recursive' when merging a single + head, 'git-merge-octopus' otherwise). This implies --merge. -v:: --verbose:: @@ -238,7 +238,7 @@ OPTIONS ever ignored. --whitespace=<nowarn|warn|error|error-all|strip>:: - This flag is passed to the `git-apply` program + This flag is passed to the 'git-apply' program (see linkgit:git-apply[1]) that applies the patch. -i:: @@ -314,12 +314,12 @@ pick fa1afe1 The oneline of the next commit ... ------------------------------------------- -The oneline descriptions are purely for your pleasure; `git-rebase` will +The oneline descriptions are purely for your pleasure; 'git-rebase' will not look at them but at the commit names ("deadbee" and "fa1afe1" in this example), so do not delete or edit the names. By replacing the command "pick" with the command "edit", you can tell -`git-rebase` to stop after applying that commit, so that you can edit +'git-rebase' to stop after applying that commit, so that you can edit the files and/or the commit message, amend the commit, and continue rebasing. @@ -334,7 +334,7 @@ the loop with `git rebase --continue`. For example, if you want to reorder the last 5 commits, such that what was HEAD~4 becomes the new HEAD. To achieve that, you would call -`git-rebase` like this: +'git-rebase' like this: ---------------------- $ git rebase -i HEAD~5 @@ -364,7 +364,7 @@ SPLITTING COMMITS ----------------- In interactive mode, you can mark commits with the action "edit". However, -this does not necessarily mean that `git-rebase` expects the result of this +this does not necessarily mean that 'git-rebase' expects the result of this edit to be exactly one commit. Indeed, you can undo the commit, or you can add other commits. This can be used to split a commit into two: @@ -380,7 +380,7 @@ add other commits. This can be used to split a commit into two: - Now add the changes to the index that you want to have in the first commit. You can use `git add` (possibly interactively) or - `git-gui` (or both) to do that. + 'git-gui' (or both) to do that. - Commit the now-current index with whatever commit message is appropriate now. @@ -391,7 +391,7 @@ add other commits. This can be used to split a commit into two: If you are not absolutely sure that the intermediate revisions are consistent (they compile, pass the testsuite, etc.) you should use -`git-stash` to stash away the not-yet-committed changes +'git-stash' to stash away the not-yet-committed changes after each commit, test, and amend the commit if fixes are necessary. diff --git a/Documentation/git-receive-pack.txt b/Documentation/git-receive-pack.txt index 207684d1c1..6b2f8c4de7 100644 --- a/Documentation/git-receive-pack.txt +++ b/Documentation/git-receive-pack.txt @@ -12,23 +12,23 @@ SYNOPSIS DESCRIPTION ----------- -Invoked by `git-send-pack` and updates the repository with the +Invoked by 'git-send-pack' and updates the repository with the information fed from the remote end. This command is usually not invoked directly by the end user. -The UI for the protocol is on the `git-send-pack` side, and the +The UI for the protocol is on the 'git-send-pack' side, and the program pair is meant to be used to push updates to remote repository. For pull operations, see linkgit:git-fetch-pack[1]. The command allows for creation and fast forwarding of sha1 refs (heads/tags) on the remote end (strictly speaking, it is the -local end `git-receive-pack` runs, but to the user who is sitting at +local end 'git-receive-pack' runs, but to the user who is sitting at the send-pack end, it is updating the remote. Confused?) There are other real-world examples of using update and post-update hooks found in the Documentation/howto directory. -`git-receive-pack` honours the receive.denyNonFastForwards config +'git-receive-pack' honours the receive.denyNonFastForwards config option, which tells it if updates to a ref should be denied if they are not fast-forwards. @@ -125,7 +125,7 @@ non-zero exit code will generate an error message. Note that it is possible for refname to not have sha1-new when this hook runs. This can easily occur if another user modifies the ref -after it was updated by `git-receive-pack`, but before the hook was able +after it was updated by 'git-receive-pack', but before the hook was able to evaluate it. It is recommended that hooks rely on sha1-new rather than the current value of refname. @@ -137,7 +137,7 @@ post-update will called with the list of refs that have been updated. This can be used to implement any repository wide cleanup tasks. The exit code from this hook invocation is ignored; the only thing -left for `git-receive-pack` to do at that point is to exit itself +left for 'git-receive-pack' to do at that point is to exit itself anyway. This hook can be used, for example, to run `git update-server-info` diff --git a/Documentation/git-repack.txt b/Documentation/git-repack.txt index c956affb43..38ac60947b 100644 --- a/Documentation/git-repack.txt +++ b/Documentation/git-repack.txt @@ -47,29 +47,29 @@ OPTIONS deleted by way of being left in the old pack and then removed. Instead, the loose unreachable objects will be pruned according to normal expiry rules - with the next `git-gc` invocation. See linkgit:git-gc[1]. + with the next 'git-gc' invocation. See linkgit:git-gc[1]. -d:: After packing, if the newly created packs make some existing packs redundant, remove the redundant packs. - Also run `git-prune-packed` to remove redundant + Also run 'git-prune-packed' to remove redundant loose object files. -l:: - Pass the `--local` option to `git-pack-objects`. See + Pass the `--local` option to 'git-pack-objects'. See linkgit:git-pack-objects[1]. -f:: - Pass the `--no-reuse-delta` option to `git-pack-objects`. See + Pass the `--no-reuse-delta` option to 'git-pack-objects'. See linkgit:git-pack-objects[1]. -q:: - Pass the `-q` option to `git-pack-objects`. See + Pass the `-q` option to 'git-pack-objects'. See linkgit:git-pack-objects[1]. -n:: Do not update the server information with - `git-update-server-info`. This option skips + 'git-update-server-info'. This option skips updating local catalog files needed to publish this repository (or a direct copy of it) over HTTP or FTP. See linkgit:git-update-server-info[1]. @@ -107,7 +107,7 @@ Configuration When configuration variable `repack.UseDeltaBaseOffset` is set for the repository, the command passes `--delta-base-offset` -option to `git-pack-objects`; this typically results in slightly +option to 'git-pack-objects'; this typically results in slightly smaller packs, but the generated packs are incompatible with versions of git older than (and including) v1.4.3; do not set the variable in a repository that older version of git needs to diff --git a/Documentation/git-rerere.txt b/Documentation/git-rerere.txt index 30ec68d3eb..666349d178 100644 --- a/Documentation/git-rerere.txt +++ b/Documentation/git-rerere.txt @@ -30,14 +30,14 @@ enable this command. COMMANDS -------- -Normally, `git-rerere` is run without arguments or user-intervention. +Normally, 'git-rerere' is run without arguments or user-intervention. However, it has several commands that allow it to interact with its working state. 'clear':: This resets the metadata used by rerere if a merge resolution is to be -is aborted. Calling `git-am --skip` or `git-rebase [--skip|--abort]` +is aborted. Calling 'git-am --skip' or 'git-rebase [--skip|--abort]' will automatically invoke this command. 'diff':: @@ -142,33 +142,33 @@ finally ready and merged into the master branch. This merge would require you to resolve the conflict, introduced by the commits marked with `*`. However, often this conflict is the same conflict you resolved when you created the test merge you -blew away. `git-rerere` command helps you to resolve this final +blew away. 'git-rerere' command helps you to resolve this final conflicted merge using the information from your earlier hand resolve. -Running the `git-rerere` command immediately after a conflicted +Running the 'git-rerere' command immediately after a conflicted automerge records the conflicted working tree files, with the usual conflict markers `<<<<<<<`, `=======`, and `>>>>>>>` in them. Later, after you are done resolving the conflicts, -running `git-rerere` again records the resolved state of these +running 'git-rerere' again records the resolved state of these files. Suppose you did this when you created the test merge of master into the topic branch. -Next time, running `git-rerere` after seeing a conflicted +Next time, running 'git-rerere' after seeing a conflicted automerge, if the conflict is the same as the earlier one recorded, it is noticed and a three-way merge between the earlier conflicted automerge, the earlier manual resolution, and the current conflicted automerge is performed by the command. If this three-way merge resolves cleanly, the result is written out to your working tree file, so you would not have to manually -resolve it. Note that `git-rerere` leaves the index file alone, +resolve it. Note that 'git-rerere' leaves the index file alone, so you still need to do the final sanity checks with `git diff` -(or `git diff -c`) and `git-add` when you are satisfied. +(or `git diff -c`) and 'git-add' when you are satisfied. -As a convenience measure, `git-merge` automatically invokes -`git-rerere` when it exits with a failed automerge, which +As a convenience measure, 'git-merge' automatically invokes +'git-rerere' when it exits with a failed automerge, which records it if it is a new conflict, or reuses the earlier hand -resolve when it is not. `git-commit` also invokes `git-rerere` +resolve when it is not. 'git-commit' also invokes 'git-rerere' when recording a merge result. What this means is that you do not have to do anything special yourself (Note: you still have to set the config variable rerere.enabled to enable this command). @@ -178,8 +178,8 @@ resolution is recorded, and it will be reused when you do the actual merge later with updated master and topic branch, as long as the earlier resolution is still applicable. -The information `git-rerere` records is also used when running -`git-rebase`. After blowing away the test merge and continuing +The information 'git-rerere' records is also used when running +'git-rebase'. After blowing away the test merge and continuing development on the topic branch: ------------ @@ -198,7 +198,7 @@ you could run `git rebase master topic`, to keep yourself up-to-date even before your topic is ready to be sent upstream. This would result in falling back to three-way merge, and it would conflict the same way the test merge you resolved earlier. -`git-rerere` is run by `git-rebase` to help you resolve this +'git-rerere' is run by 'git-rebase' to help you resolve this conflict. diff --git a/Documentation/git-reset.txt b/Documentation/git-reset.txt index dc05f58f18..c8d175768c 100644 --- a/Documentation/git-reset.txt +++ b/Documentation/git-reset.txt @@ -37,7 +37,7 @@ OPTIONS --soft:: Does not touch the index file nor the working tree at all, but requires them to be in a good order. This leaves all your changed - files "Changes to be committed", as `git-status` would + files "Changes to be committed", as 'git-status' would put it. --hard:: diff --git a/Documentation/git-rev-list.txt b/Documentation/git-rev-list.txt index e7d736ffa4..fd1de92e34 100644 --- a/Documentation/git-rev-list.txt +++ b/Documentation/git-rev-list.txt @@ -83,11 +83,11 @@ between the two operands. The following two commands are equivalent: $ git rev-list A...B ----------------------------------------------------------------------- -`git-rev-list` is a very essential git program, since it +'git-rev-list' is a very essential git program, since it provides the ability to build and traverse commit ancestry graphs. For this reason, it has a lot of different options that enables it to be -used by commands as different as `git-bisect` and -`git-repack`. +used by commands as different as 'git-bisect' and +'git-repack'. OPTIONS ------- diff --git a/Documentation/git-rev-parse.txt b/Documentation/git-rev-parse.txt index 6825ae27c4..0501a87025 100644 --- a/Documentation/git-rev-parse.txt +++ b/Documentation/git-rev-parse.txt @@ -15,16 +15,16 @@ DESCRIPTION Many git porcelainish commands take mixture of flags (i.e. parameters that begin with a dash '-') and parameters -meant for the underlying `git-rev-list` command they use internally +meant for the underlying 'git-rev-list' command they use internally and flags and parameters for the other commands they use -downstream of `git-rev-list`. This command is used to +downstream of 'git-rev-list'. This command is used to distinguish between them. OPTIONS ------- --parseopt:: - Use `git-rev-parse` in option parsing mode (see PARSEOPT section below). + Use 'git-rev-parse' in option parsing mode (see PARSEOPT section below). --keep-dash-dash:: Only meaningful in `--parseopt` mode. Tells the option parser to echo @@ -32,11 +32,11 @@ OPTIONS --revs-only:: Do not output flags and parameters not meant for - `git-rev-list` command. + 'git-rev-list' command. --no-revs:: Do not output flags and parameters meant for - `git-rev-list` command. + 'git-rev-list' command. --flags:: Do not output non-flag parameters. @@ -64,7 +64,7 @@ OPTIONS properly quoted for consumption by shell. Useful when you expect your parameter to contain whitespaces and newlines (e.g. when using pickaxe `-S` with - `git-diff-\*`). + 'git-diff-\*'). --not:: When showing object names, prefix them with '{caret}' and @@ -129,12 +129,12 @@ OPTIONS --since=datestring:: --after=datestring:: Parse the date string, and output the corresponding - --max-age= parameter for `git-rev-list`. + --max-age= parameter for 'git-rev-list'. --until=datestring:: --before=datestring:: Parse the date string, and output the corresponding - --min-age= parameter for `git-rev-list`. + --min-age= parameter for 'git-rev-list'. <args>...:: Flags and parameters to be parsed. @@ -155,7 +155,7 @@ blobs contained in a commit. name the same commit object if there are no other object in your repository whose object name starts with dae86e. -* An output from `git-describe`; i.e. a closest tag, followed by a +* An output from 'git-describe'; i.e. a closest tag, followed by a dash, a `g`, and an abbreviated object name. * A symbolic ref name. E.g. 'master' typically means the commit @@ -278,7 +278,7 @@ G H I J SPECIFYING RANGES ----------------- -History traversing commands such as `git-log` operate on a set +History traversing commands such as 'git-log' operate on a set of commits, not just a single commit. To these commands, specifying a single revision with the notation described in the previous section means the set of commits reachable from that @@ -319,7 +319,7 @@ Here are a handful of examples: PARSEOPT -------- -In `--parseopt` mode, `git-rev-parse` helps massaging options to bring to shell +In `--parseopt` mode, 'git-rev-parse' helps massaging options to bring to shell scripts the same facilities C builtins have. It works as an option normalizer (e.g. splits single switches aggregate values), a bit like `getopt(1)` does. @@ -331,7 +331,7 @@ usage on the standard error stream, and exits with code 129. Input Format ~~~~~~~~~~~~ -`git-rev-parse --parseopt` input format is fully text based. It has two parts, +'git-rev-parse --parseopt' input format is fully text based. It has two parts, separated by a line that contains only `--`. The lines before the separator (should be more than one) are used for the usage. The lines after the separator describe the options. diff --git a/Documentation/git-revert.txt b/Documentation/git-revert.txt index 3d0c5aba93..5411edca96 100644 --- a/Documentation/git-revert.txt +++ b/Documentation/git-revert.txt @@ -24,7 +24,7 @@ OPTIONS -e:: --edit:: - With this option, `git-revert` will let you edit the commit + With this option, 'git-revert' will let you edit the commit message prior to committing the revert. This is the default if you run the command from a terminal. @@ -37,7 +37,7 @@ OPTIONS relative to the specified parent. --no-edit:: - With this option, `git-revert` will not start the commit + With this option, 'git-revert' will not start the commit message editor. -n:: diff --git a/Documentation/git-rm.txt b/Documentation/git-rm.txt index 01b63be385..4d0c495bc3 100644 --- a/Documentation/git-rm.txt +++ b/Documentation/git-rm.txt @@ -12,7 +12,7 @@ SYNOPSIS DESCRIPTION ----------- Remove files from the index, or from the working tree and the index. -`git-rm` will not remove a file from just your working directory. +'git-rm' will not remove a file from just your working directory. (There is no option to remove a file only from the work tree and yet keep it in the index; use `/bin/rm` if you want to do that.) The files being removed have to be identical to the tip of the branch, @@ -63,7 +63,7 @@ OPTIONS -q:: --quiet:: - `git-rm` normally outputs one line (in the form of an "rm" command) + 'git-rm' normally outputs one line (in the form of an "rm" command) for each file removed. This option suppresses that output. diff --git a/Documentation/git-send-pack.txt b/Documentation/git-send-pack.txt index 410504df46..399821832c 100644 --- a/Documentation/git-send-pack.txt +++ b/Documentation/git-send-pack.txt @@ -12,17 +12,17 @@ SYNOPSIS DESCRIPTION ----------- -Usually you would want to use `git-push`, which is a +Usually you would want to use 'git-push', which is a higher-level wrapper of this command, instead. See linkgit:git-push[1]. -Invokes `git-receive-pack` on a possibly remote repository, and +Invokes 'git-receive-pack' on a possibly remote repository, and updates it from the current repository, sending named refs. OPTIONS ------- --receive-pack=<git-receive-pack>:: - Path to the `git-receive-pack` program on the remote + Path to the 'git-receive-pack' program on the remote end. Sometimes useful when pushing to a remote repository over ssh, and you do not have the program in a directory on the default $PATH. @@ -53,7 +53,7 @@ OPTIONS <host>:: A remote host to house the repository. When this - part is specified, `git-receive-pack` is invoked via + part is specified, 'git-receive-pack' is invoked via ssh. <directory>:: @@ -86,7 +86,7 @@ and the destination side (after the colon). The ref to be pushed is determined by finding a match that matches the source side, and where it is pushed is determined by using the destination side. The rules used to match a ref are the same -rules used by `git-rev-parse` to resolve a symbolic ref +rules used by 'git-rev-parse' to resolve a symbolic ref name. See linkgit:git-rev-parse[1]. - It is an error if <src> does not match exactly one of the diff --git a/Documentation/git-sh-setup.txt b/Documentation/git-sh-setup.txt index 6731f9ac4c..18f14b5be8 100644 --- a/Documentation/git-sh-setup.txt +++ b/Documentation/git-sh-setup.txt @@ -16,7 +16,7 @@ This is not a command the end user would want to run. Ever. This documentation is meant for people who are studying the Porcelain-ish scripts and/or are writing new ones. -The `git-sh-setup` scriptlet is designed to be sourced (using +The 'git-sh-setup' scriptlet is designed to be sourced (using `.`) by other shell scripts to set up some variables pointing at the normal git directories and a few helper shell functions. diff --git a/Documentation/git-shell.txt b/Documentation/git-shell.txt index 9b2ae7f268..ff420f8f8c 100644 --- a/Documentation/git-shell.txt +++ b/Documentation/git-shell.txt @@ -18,7 +18,7 @@ of server-side GIT commands implementing the pull/push functionality. The commands can be executed only by the '-c' option; the shell is not interactive. -Currently, only the `git-receive-pack` and `git-upload-pack` commands +Currently, only the 'git-receive-pack' and 'git-upload-pack' commands are permitted to be called, with a single required argument. Author diff --git a/Documentation/git-shortlog.txt b/Documentation/git-shortlog.txt index 74a5f29cd8..7ccf31ccc4 100644 --- a/Documentation/git-shortlog.txt +++ b/Documentation/git-shortlog.txt @@ -13,7 +13,7 @@ git shortlog [-n|--numbered] [-s|--summary] [-e|--email] [-w[<width>[,<indent1>[ DESCRIPTION ----------- -Summarizes `git-log` output in a format suitable for inclusion +Summarizes 'git-log' output in a format suitable for inclusion in release announcements. Each commit will be grouped by author and the first line of the commit message will be shown. diff --git a/Documentation/git-show-branch.txt b/Documentation/git-show-branch.txt index 578bdb7850..14e10362b1 100644 --- a/Documentation/git-show-branch.txt +++ b/Documentation/git-show-branch.txt @@ -75,7 +75,7 @@ OPTIONS --merge-base:: Instead of showing the commit list, just act like the - `git-merge-base -a` command, except that it can accept + 'git-merge-base -a' command, except that it can accept more than two heads. --independent:: diff --git a/Documentation/git-show-index.txt b/Documentation/git-show-index.txt index 4ae6ede11e..e3285aacfd 100644 --- a/Documentation/git-show-index.txt +++ b/Documentation/git-show-index.txt @@ -14,10 +14,10 @@ SYNOPSIS DESCRIPTION ----------- Reads given idx file for packed git archive created with -`git-pack-objects` command, and dumps its contents. +'git-pack-objects' command, and dumps its contents. The information it outputs is subset of what you can get from -`git-verify-pack -v`; this command only shows the packfile +'git-verify-pack -v'; this command only shows the packfile offset and SHA1 of each object. diff --git a/Documentation/git-show-ref.txt b/Documentation/git-show-ref.txt index a78a7dcf7a..9a4389981c 100644 --- a/Documentation/git-show-ref.txt +++ b/Documentation/git-show-ref.txt @@ -74,7 +74,7 @@ OPTIONS --exclude-existing:: --exclude-existing=pattern:: - Make `git-show-ref` act as a filter that reads refs from stdin of the + Make 'git-show-ref' act as a filter that reads refs from stdin of the form "^(?:<anything>\s)?<refname>(?:\^\{\})?$" and performs the following actions on each: (1) strip "^{}" at the end of line if any; @@ -137,7 +137,7 @@ When using the '--verify' flag, the command requires an exact path: will only match the exact branch called "master". -If nothing matches, `git-show-ref` will return an error code of 1, +If nothing matches, 'git-show-ref' will return an error code of 1, and in the case of verification, it will show an error message. For scripting, you can ask it to be quiet with the "--quiet" flag, which diff --git a/Documentation/git-show.txt b/Documentation/git-show.txt index 70b54aec2f..e0b52bcb37 100644 --- a/Documentation/git-show.txt +++ b/Documentation/git-show.txt @@ -16,16 +16,16 @@ Shows one or more objects (blobs, trees, tags and commits). For commits it shows the log message and textual diff. It also presents the merge commit in a special format as produced by -`git-diff-tree --cc`. +'git-diff-tree --cc'. For tags, it shows the tag message and the referenced objects. -For trees, it shows the names (equivalent to `git-ls-tree` +For trees, it shows the names (equivalent to 'git-ls-tree' with \--name-only). For plain blobs, it shows the plain contents. -The command takes options applicable to the `git-diff-tree` command to +The command takes options applicable to the 'git-diff-tree' command to control how the changes the commit introduces are shown. This manual page describes only the most frequently used options. diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt index 23ac331295..9b6b911091 100644 --- a/Documentation/git-stash.txt +++ b/Documentation/git-stash.txt @@ -56,7 +56,7 @@ stash@{0}: WIP on submit: 6ebd0e2... Update git-stash documentation stash@{1}: On master: 9cc0589... Add git-stash ---------------------------------------------------------------- + -The command takes options applicable to the `git-log` +The command takes options applicable to the 'git-log' command to control what is shown and how. See linkgit:git-log[1]. show [<stash>]:: @@ -64,7 +64,7 @@ show [<stash>]:: Show the changes recorded in the stash as a diff between the stashed state and its original parent. When no `<stash>` is given, shows the latest one. By default, the command shows the diffstat, but - it will accept any format known to `git-diff` (e.g., `git stash show + it will accept any format known to 'git-diff' (e.g., `git stash show -p stash@\{1}` to view the second most recent stash in patch form). apply [--index] [<stash>]:: @@ -158,7 +158,7 @@ $ git reset --soft HEAD^ ... continue hacking ... ---------------------------------------------------------------- + -You can use `git-stash` to simplify the above, like this: +You can use 'git-stash' to simplify the above, like this: + ---------------------------------------------------------------- ... hack hack hack ... diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt index c9d4a046c7..57b7498239 100644 --- a/Documentation/git-status.txt +++ b/Documentation/git-status.txt @@ -17,12 +17,12 @@ current HEAD commit, paths that have differences between the working tree and the index file, and paths in the working tree that are not tracked by git (and are not ignored by linkgit:gitignore[5]). The first are what you _would_ commit by running `git commit`; the second and -third are what you _could_ commit by running `git-add` before running +third are what you _could_ commit by running 'git-add' before running `git commit`. -The command takes the same set of options as `git-commit`; it +The command takes the same set of options as 'git-commit'; it shows what would be committed if the same options are given to -`git-commit`. +'git-commit'. If there is no path that is different between the index file and the current HEAD commit (i.e., there is nothing to commit by running diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt index 9c4052c58a..105fc2dcdc 100644 --- a/Documentation/git-submodule.txt +++ b/Documentation/git-submodule.txt @@ -32,11 +32,11 @@ add:: status:: Show the status of the submodules. This will print the SHA-1 of the currently checked out commit for each submodule, along with the - submodule path and the output of `git-describe` for the + submodule path and the output of 'git-describe' for the SHA-1. Each SHA-1 will be prefixed with `-` if the submodule is not initialized and `+` if the currently checked out submodule commit does not match the SHA-1 found in the index of the containing - repository. This command is the default command for `git-submodule`. + repository. This command is the default command for 'git-submodule'. init:: Initialize the submodules, i.e. register in .git/config each submodule diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt index 6caa130611..dd12335a43 100644 --- a/Documentation/git-svn.txt +++ b/Documentation/git-svn.txt @@ -11,17 +11,17 @@ SYNOPSIS DESCRIPTION ----------- -`git-svn` is a simple conduit for changesets between Subversion and git. +'git-svn' is a simple conduit for changesets between Subversion and git. It is not to be confused with linkgit:git-svnimport[1], which is read-only. -`git-svn` was originally designed for an individual developer who wants a +'git-svn' was originally designed for an individual developer who wants a bidirectional flow of changesets between a single branch in Subversion and an arbitrary number of branches in git. Since its inception, -`git-svn` has gained the ability to track multiple branches in a manner -similar to `git-svnimport`. +'git-svn' has gained the ability to track multiple branches in a manner +similar to 'git-svnimport'. -`git-svn` is especially useful when it comes to tracking repositories +'git-svn' is especially useful when it comes to tracking repositories not organized in the way Subversion developers recommend (trunk, branches, tags directories). @@ -31,7 +31,7 @@ COMMANDS 'init':: Initializes an empty git repository with additional - metadata directories for `git-svn`. The Subversion URL + metadata directories for 'git-svn'. The Subversion URL may be specified as a command-line argument, or as full URL arguments to -T/-t/-b. Optionally, the target directory to operate on can be specified as a second @@ -107,20 +107,20 @@ COMMANDS This fetches revisions from the SVN parent of the current HEAD and rebases the current (uncommitted to SVN) work against it. -This works similarly to `svn update` or `git-pull` except that -it preserves linear history with `git-rebase` instead of -`git-merge` for ease of dcommiting with `git-svn`. +This works similarly to `svn update` or 'git-pull' except that +it preserves linear history with 'git-rebase' instead of +'git-merge' for ease of dcommiting with 'git-svn'. -This accepts all options that `git-svn fetch` and `git-rebase` +This accepts all options that 'git-svn fetch' and 'git-rebase' accept. However, '--fetch-all' only fetches from the current [svn-remote], and not all [svn-remote] definitions. -Like `git-rebase`; this requires that the working tree be clean +Like 'git-rebase'; this requires that the working tree be clean and have no uncommitted changes. -l;; --local;; - Do not fetch remotely; only run `git-rebase` against the + Do not fetch remotely; only run 'git-rebase' against the last fetched commit from the upstream SVN. 'dcommit':: @@ -128,7 +128,7 @@ and have no uncommitted changes. repository, and then rebase or reset (depending on whether or not there is a diff between SVN and head). This will create a revision in SVN for each commit in git. - It is recommended that you run `git-svn` fetch and rebase (not + It is recommended that you run 'git-svn' fetch and rebase (not pull or merge) your commits against the latest changes in the SVN repository. An optional command-line argument may be specified as an @@ -173,7 +173,7 @@ NOTE: SVN itself only stores times in UTC and nothing else. The regular svn client converts the UTC time to the local time (or based on the TZ= environment). This command has the same behaviour. + -Any other arguments are passed directly to `git-log` +Any other arguments are passed directly to 'git-log' 'blame':: Show what revision and author last modified each line of a file. The @@ -181,10 +181,10 @@ Any other arguments are passed directly to `git-log` `svn blame' by default. Like the SVN blame command, local uncommitted changes in the working copy are ignored; the version of the file in the HEAD revision is annotated. Unknown - arguments are passed directly to `git-blame`. + arguments are passed directly to 'git-blame'. + --git-format;; - Produce output in the same format as `git-blame`, but with + Produce output in the same format as 'git-blame', but with SVN revision numbers instead of git commit hashes. In this mode, changes that haven't been committed to SVN (including local working-copy edits) are shown as revision 0. @@ -203,7 +203,7 @@ Any other arguments are passed directly to `git-log` absolutely no attempts to do patching when committing to SVN, it simply overwrites files with those specified in the tree or commit. All merging is assumed to have taken place - independently of `git-svn` functions. + independently of 'git-svn' functions. 'create-ignore':: Recursively finds the svn:ignore property on directories and @@ -219,12 +219,12 @@ Any other arguments are passed directly to `git-log` 'commit-diff':: Commits the diff of two tree-ish arguments from the command-line. This command is intended for interoperability with - `git-svnimport` and does not rely on being inside an `git-svn + 'git-svnimport' and does not rely on being inside an `git-svn init`-ed repository. This command takes three arguments, (a) the original tree to diff against, (b) the new tree result, (c) the URL of the target Subversion repository. The final argument - (URL) may be omitted if you are working from a `git-svn`-aware - repository (that has been `init`-ed with `git-svn`). + (URL) may be omitted if you are working from a 'git-svn'-aware + repository (that has been `init`-ed with 'git-svn'). The -r<revision> option is required for this. 'info':: @@ -255,7 +255,7 @@ OPTIONS --shared[={false|true|umask|group|all|world|everybody}]:: --template=<template_directory>:: Only used with the 'init' command. - These are passed directly to `git-init`. + These are passed directly to 'git-init'. -r <ARG>:: --revision <ARG>:: @@ -277,7 +277,7 @@ Only used with the 'set-tree' command. Read a list of commits from stdin and commit them in reverse order. Only the leading sha1 is read from each line, so -`git-rev-list --pretty=oneline` output can be used. +'git-rev-list --pretty=oneline' output can be used. --rmdir:: @@ -307,7 +307,7 @@ config key: svn.edit Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands. -They are both passed directly to `git-diff-tree`; see +They are both passed directly to 'git-diff-tree'; see linkgit:git-diff-tree[1] for more information. [verse] @@ -317,24 +317,24 @@ config key: svn.findcopiesharder -A<filename>:: --authors-file=<filename>:: -Syntax is compatible with the files used by `git-svnimport` and -`git-cvsimport`: +Syntax is compatible with the files used by 'git-svnimport' and +'git-cvsimport': ------------------------------------------------------------------------ loginname = Joe User <user@example.com> ------------------------------------------------------------------------ -If this option is specified and `git-svn` encounters an SVN -committer name that does not exist in the authors-file, `git-svn` +If this option is specified and 'git-svn' encounters an SVN +committer name that does not exist in the authors-file, 'git-svn' will abort operation. The user will then have to add the -appropriate entry. Re-running the previous `git-svn` command +appropriate entry. Re-running the previous 'git-svn' command after the authors-file is modified should continue operation. config key: svn.authorsfile -q:: --quiet:: - Make `git-svn` less verbose. + Make 'git-svn' less verbose. --repack[=<n>]:: --repack-flags=<flags>:: @@ -346,7 +346,7 @@ with many revisions. to fetch before repacking. This defaults to repacking every 1000 commits fetched if no argument is specified. ---repack-flags are passed directly to `git-repack`. +--repack-flags are passed directly to 'git-repack'. [verse] config key: svn.repack @@ -359,8 +359,8 @@ config key: svn.repackflags These are only used with the 'dcommit' and 'rebase' commands. -Passed directly to `git-rebase` when using 'dcommit' if a -`git-reset` cannot be used (see 'dcommit'). +Passed directly to 'git-rebase' when using 'dcommit' if a +'git-reset' cannot be used (see 'dcommit'). -n:: --dry-run:: @@ -413,18 +413,18 @@ svn-remote.<name>.noMetadata:: This gets rid of the 'git-svn-id:' lines at the end of every commit. -If you lose your .git/svn/git-svn/.rev_db file, `git-svn` will not +If you lose your .git/svn/git-svn/.rev_db file, 'git-svn' will not be able to rebuild it and you won't be able to fetch again, either. This is fine for one-shot imports. -The `git-svn log` command will not work on repositories using +The 'git-svn log' command will not work on repositories using this, either. Using this conflicts with the 'useSvmProps' option for (hopefully) obvious reasons. svn.useSvmProps:: svn-remote.<name>.useSvmProps:: -This allows `git-svn` to re-map repository URLs and UUIDs from +This allows 'git-svn' to re-map repository URLs and UUIDs from mirrors created using SVN::Mirror (or svk) for metadata. If an SVN revision has a property, "svm:headrev", it is likely @@ -443,7 +443,7 @@ svn-remote.<name>.useSvnsyncprops:: svn-remote.<name>.rewriteRoot:: This allows users to create repositories from alternate - URLs. For example, an administrator could run `git-svn` on the + URLs. For example, an administrator could run 'git-svn' on the server locally (accessing via file://) but wish to distribute the repository with a public http:// or svn:// URL in the metadata so users of it will see the public URL. @@ -451,7 +451,7 @@ svn-remote.<name>.rewriteRoot:: -- Since the noMetadata, rewriteRoot, useSvnsyncProps and useSvmProps -options all affect the metadata generated and used by `git-svn`; they +options all affect the metadata generated and used by 'git-svn'; they *must* be set in the configuration file before any history is imported and these settings should never be changed once they are set. @@ -498,12 +498,12 @@ Tracking and contributing to an entire Subversion-managed project # of dcommit/rebase/show-ignore should be the same as above. ------------------------------------------------------------------------ -The initial `git-svn clone` can be quite time-consuming +The initial 'git-svn clone' can be quite time-consuming (especially for large Subversion repositories). If multiple people (or one person with multiple machines) want to use -`git-svn` to interact with the same Subversion repository, you can -do the initial `git-svn clone` to a repository on a server and -have each person clone that repository with `git-clone`: +'git-svn' to interact with the same Subversion repository, you can +do the initial 'git-svn clone' to a repository on a server and +have each person clone that repository with 'git-clone': ------------------------------------------------------------------------ # Do the initial import on a server @@ -524,7 +524,7 @@ have each person clone that repository with `git-clone`: REBASE VS. PULL/MERGE --------------------- -Originally, `git-svn` recommended that the 'remotes/git-svn' branch be +Originally, 'git-svn' recommended that the 'remotes/git-svn' branch be pulled or merged from. This is because the author favored `git svn set-tree B` to commit a single head rather than the `git svn set-tree A..B` notation to commit multiple commits. @@ -539,7 +539,7 @@ previous commits in SVN. DESIGN PHILOSOPHY ----------------- Merge tracking in Subversion is lacking and doing branched development -with Subversion can be cumbersome as a result. While `git-svn` can track +with Subversion can be cumbersome as a result. While 'git-svn' can track copy history (including branches and tags) for repositories adopting a standard layout, it cannot yet represent merge history that happened inside git back upstream to SVN users. Therefore it is advised that @@ -550,25 +550,25 @@ CAVEATS ------- For the sake of simplicity and interoperating with a less-capable system -(SVN), it is recommended that all `git-svn` users clone, fetch and dcommit -directly from the SVN server, and avoid all `git-clone`/`pull`/`merge`/`push` +(SVN), it is recommended that all 'git-svn' users clone, fetch and dcommit +directly from the SVN server, and avoid all 'git-clone'/`pull`/`merge`/`push` operations between git repositories and branches. The recommended method of exchanging code between git branches and users is -`git-format-patch` and `git-am`, or just 'dcommit'ing to the SVN repository. +'git-format-patch' and 'git-am', or just 'dcommit'ing to the SVN repository. -Running `git-merge` or `git-pull` is NOT recommended on a branch you +Running 'git-merge' or 'git-pull' is NOT recommended on a branch you plan to 'dcommit' from. Subversion does not represent merges in any reasonable or useful fashion; so users using Subversion cannot see any merges you've made. Furthermore, if you merge or pull from a git branch that is a mirror of an SVN branch, 'dcommit' may commit to the wrong branch. -`git-clone` does not clone branches under the refs/remotes/ hierarchy or -any `git-svn` metadata, or config. So repositories created and managed with -using `git-svn` should use `rsync` for cloning, if cloning is to be done +'git-clone' does not clone branches under the refs/remotes/ hierarchy or +any 'git-svn' metadata, or config. So repositories created and managed with +using 'git-svn' should use `rsync` for cloning, if cloning is to be done at all. -Since 'dcommit' uses rebase internally, any git branches you `git-push` to +Since 'dcommit' uses rebase internally, any git branches you 'git-push' to before 'dcommit' on will require forcing an overwrite of the existing ref on the remote repository. This is generally considered bad practice, see the linkgit:git-push[1] documentation for details. @@ -594,7 +594,7 @@ for git to detect them. CONFIGURATION ------------- -`git-svn` stores [svn-remote] configuration information in the +'git-svn' stores [svn-remote] configuration information in the repository .git/config file. It is similar the core git [remote] sections except 'fetch' keys do not accept glob arguments; but they are instead handled by the 'branches' @@ -615,7 +615,7 @@ Keep in mind that the '*' (asterisk) wildcard of the local ref however the remote wildcard may be anywhere as long as it's own independent path component (surrounded by '/' or EOL). This type of configuration is not automatically created by 'init' and -should be manually entered with a text-editor or using `git-config`. +should be manually entered with a text-editor or using 'git-config'. SEE ALSO -------- diff --git a/Documentation/git-symbolic-ref.txt b/Documentation/git-symbolic-ref.txt index a4962413d3..6266e6f658 100644 --- a/Documentation/git-symbolic-ref.txt +++ b/Documentation/git-symbolic-ref.txt @@ -49,7 +49,7 @@ cumbersome. On some platforms, `ln -sf` does not even work as advertised (horrors). Therefore symbolic links are now deprecated and symbolic refs are used by default. -`git-symbolic-ref` will exit with status 0 if the contents of the +'git-symbolic-ref' will exit with status 0 if the contents of the symbolic ref were printed correctly, with status 1 if the requested name is not a symbolic ref, or 128 if another error occurs. diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt index 1db98e2d0d..b605e6caa2 100644 --- a/Documentation/git-tag.txt +++ b/Documentation/git-tag.txt @@ -82,7 +82,7 @@ OPTIONS CONFIGURATION ------------- -By default, `git-tag` in sign-with-default mode (-s) will use your +By default, 'git-tag' in sign-with-default mode (-s) will use your committer identity (of the form "Your Name <your@email.address>") to find a key. If you want to use a different default key, you can specify it in the repository configuration as follows: @@ -118,12 +118,12 @@ and be done with it. . The insane thing. You really want to call the new version "X" too, 'even though' -others have already seen the old one. So just use `git-tag -f` +others have already seen the old one. So just use 'git-tag -f' again, as if you hadn't already published the old one. However, Git does *not* (and it should not) change tags behind users back. So if somebody already got the old tag, doing a -`git-pull` on your tree shouldn't just make them overwrite the old +'git-pull' on your tree shouldn't just make them overwrite the old one. If somebody got a release tag from you, you cannot just change @@ -177,7 +177,7 @@ private anchor point tags from the other person. You would notice "please pull" messages on the mailing list says repo URL and branch name alone. This is designed to be easily -cut&pasted to a `git-fetch` command line: +cut&pasted to a 'git-fetch' command line: ------------ Linus, please pull from diff --git a/Documentation/git-tar-tree.txt b/Documentation/git-tar-tree.txt index b3097aa79c..a5d9558dd1 100644 --- a/Documentation/git-tar-tree.txt +++ b/Documentation/git-tar-tree.txt @@ -12,19 +12,19 @@ SYNOPSIS DESCRIPTION ----------- -THIS COMMAND IS DEPRECATED. Use `git-archive` with `--format=tar` +THIS COMMAND IS DEPRECATED. Use 'git-archive' with `--format=tar` option instead (and move the <base> argument to `--prefix=base/`). Creates a tar archive containing the tree structure for the named tree. When <base> is specified it is added as a leading path to the files in the generated tar archive. -`git-tar-tree` behaves differently when given a tree ID versus when given +'git-tar-tree' behaves differently when given a tree ID versus when given a commit ID or tag ID. In the first case the current time is used as modification time of each file in the archive. In the latter case the commit time as recorded in the referenced commit object is used instead. Additionally the commit ID is stored in a global extended pax header. -It can be extracted using `git-get-tar-commit-id`. +It can be extracted using 'git-get-tar-commit-id'. OPTIONS ------- diff --git a/Documentation/git-update-index.txt b/Documentation/git-update-index.txt index 999e9a7c84..a91fd214d2 100644 --- a/Documentation/git-update-index.txt +++ b/Documentation/git-update-index.txt @@ -31,7 +31,7 @@ cleared. See also linkgit:git-add[1] for a more user-friendly way to do some of the most common operations on the index. -The way `git-update-index` handles files it is told about can be modified +The way 'git-update-index' handles files it is told about can be modified using the various options: OPTIONS @@ -53,7 +53,7 @@ OPTIONS -q:: Quiet. If --refresh finds that the index needs an update, the default behavior is to error out. This option makes - `git-update-index` continue anyway. + 'git-update-index' continue anyway. --ignore-submodules: Do not try to update submodules. This option is only respected @@ -61,7 +61,7 @@ OPTIONS --unmerged:: If --refresh finds unmerged changes in the index, the default - behavior is to error out. This option makes `git-update-index` + behavior is to error out. This option makes 'git-update-index' continue anyway. --ignore-missing:: @@ -91,7 +91,7 @@ OPTIONS -g:: --again:: - Runs `git-update-index` itself on the paths whose index + Runs 'git-update-index' itself on the paths whose index entries are different from those from the `HEAD` commit. --unresolve:: @@ -109,7 +109,7 @@ OPTIONS --replace:: By default, when a file `path` exists in the index, - `git-update-index` refuses an attempt to add `path/file`. + 'git-update-index' refuses an attempt to add `path/file`. Similarly if a file `path/file` exists, a file `path` cannot be added. With --replace flag, existing entries that conflicts with the entry being added are @@ -145,7 +145,7 @@ up-to-date for mode/content changes. But what it *does* do is to can refresh the index for a file that hasn't been changed but where the stat entry is out of date. -For example, you'd want to do this after doing a `git-read-tree`, to link +For example, you'd want to do this after doing a 'git-read-tree', to link up the stat index details with the proper files. Using --cacheinfo or --info-only @@ -186,13 +186,13 @@ back on 3-way merge. . mode SP type SP sha1 TAB path + -The second format is to stuff `git-ls-tree` output +The second format is to stuff 'git-ls-tree' output into the index file. . mode SP sha1 SP stage TAB path + This format is to put higher order stages into the -index file and matches `git-ls-files --stage` output. +index file and matches 'git-ls-files --stage' output. To place a higher stage entry to the index, the path should first be removed by feeding a mode=0 entry for the path, and @@ -249,8 +249,8 @@ option. To unset, use `--no-assume-unchanged`. The command looks at `core.ignorestat` configuration variable. When this is true, paths updated with `git update-index paths...` and paths updated with other git commands that update both index and -working tree (e.g. `git-apply --index`, `git-checkout-index -u`, -and `git-read-tree -u`) are automatically marked as "assume +working tree (e.g. 'git-apply --index', 'git-checkout-index -u', +and 'git-read-tree -u') are automatically marked as "assume unchanged". Note that "assume unchanged" bit is *not* set if `git update-index --refresh` finds the working tree file matches the index (use `git update-index --really-refresh` if you want @@ -303,7 +303,7 @@ unreliable, this should be set to 'false' (see linkgit:git-config[1]). This causes the command to ignore differences in file modes recorded in the index and the file mode on the filesystem if they differ only on executable bit. On such an unfortunate filesystem, you may -need to use `git-update-index --chmod=`. +need to use 'git-update-index --chmod='. Quite similarly, if `core.symlinks` configuration variable is set to 'false' (see linkgit:git-config[1]), symbolic links are checked out diff --git a/Documentation/git-upload-archive.txt b/Documentation/git-upload-archive.txt index 526e5bdd22..bbd7617587 100644 --- a/Documentation/git-upload-archive.txt +++ b/Documentation/git-upload-archive.txt @@ -16,7 +16,7 @@ Invoked by 'git-archive --remote' and sends a generated archive to the other end over the git protocol. This command is usually not invoked directly by the end user. The UI -for the protocol is on the `git-archive` side, and the program pair +for the protocol is on the 'git-archive' side, and the program pair is meant to be used to get an archive from a remote repository. OPTIONS diff --git a/Documentation/git-upload-pack.txt b/Documentation/git-upload-pack.txt index 52724d4c65..b8e49dce4a 100644 --- a/Documentation/git-upload-pack.txt +++ b/Documentation/git-upload-pack.txt @@ -12,13 +12,13 @@ SYNOPSIS DESCRIPTION ----------- -Invoked by `git-fetch-pack`, learns what +Invoked by 'git-fetch-pack', learns what objects the other side is missing, and sends them after packing. This command is usually not invoked directly by the end user. -The UI for the protocol is on the `git-fetch-pack` side, and the +The UI for the protocol is on the 'git-fetch-pack' side, and the program pair is meant to be used to pull updates from a remote -repository. For push operations, see `git-send-pack`. +repository. For push operations, see 'git-send-pack'. OPTIONS diff --git a/Documentation/git-var.txt b/Documentation/git-var.txt index 10d1e19cc0..3647dd6c8f 100644 --- a/Documentation/git-var.txt +++ b/Documentation/git-var.txt @@ -20,7 +20,7 @@ OPTIONS Cause the logical variables to be listed. In addition, all the variables of the git configuration file .git/config are listed as well. (However, the configuration variables listing functionality - is deprecated in favor of `git-config -l`.) + is deprecated in favor of 'git-config -l'.) EXAMPLE -------- diff --git a/Documentation/git-verify-pack.txt b/Documentation/git-verify-pack.txt index 4d95c6c891..53a9ce3085 100644 --- a/Documentation/git-verify-pack.txt +++ b/Documentation/git-verify-pack.txt @@ -14,7 +14,7 @@ SYNOPSIS DESCRIPTION ----------- Reads given idx file for packed git archive created with the -`git-pack-objects` command and verifies idx file and the +'git-pack-objects' command and verifies idx file and the corresponding pack file. OPTIONS diff --git a/Documentation/git-verify-tag.txt b/Documentation/git-verify-tag.txt index de4a89a105..ba837df4bc 100644 --- a/Documentation/git-verify-tag.txt +++ b/Documentation/git-verify-tag.txt @@ -11,7 +11,7 @@ SYNOPSIS DESCRIPTION ----------- -Validates the gpg signature created by `git-tag`. +Validates the gpg signature created by 'git-tag'. OPTIONS ------- diff --git a/Documentation/git-web--browse.txt b/Documentation/git-web--browse.txt index fefa6fd38b..36afad8d4e 100644 --- a/Documentation/git-web--browse.txt +++ b/Documentation/git-web--browse.txt @@ -61,7 +61,7 @@ browser.<tool>.path You can explicitly provide a full path to your preferred browser by setting the configuration variable 'browser.<tool>.path'. For example, you can configure the absolute path to firefox by setting -'browser.firefox.path'. Otherwise, `git-web--browse` assumes the tool +'browser.firefox.path'. Otherwise, 'git-web--browse' assumes the tool is available in PATH. browser.<tool>.cmd @@ -70,7 +70,7 @@ browser.<tool>.cmd When the browser, specified by options or configuration variables, is not among the supported ones, then the corresponding 'browser.<tool>.cmd' configuration variable will be looked up. If this -variable exists then `git-web--browse` will treat the specified tool +variable exists then 'git-web--browse' will treat the specified tool as a custom command and will use a shell eval to run the command with the URLs passed as arguments. @@ -112,7 +112,7 @@ See linkgit:git-config[1] for more information about this. Author ------ Written by Christian Couder <chriscool@tuxfamily.org> and the git-list -<git@vger.kernel.org>, based on `git-mergetool` by Theodore Y. Ts'o. +<git@vger.kernel.org>, based on 'git-mergetool' by Theodore Y. Ts'o. Documentation ------------- diff --git a/Documentation/git-whatchanged.txt b/Documentation/git-whatchanged.txt index 3b0ea2c591..d7fad15329 100644 --- a/Documentation/git-whatchanged.txt +++ b/Documentation/git-whatchanged.txt @@ -13,8 +13,8 @@ SYNOPSIS DESCRIPTION ----------- Shows commit logs and diff output each commit introduces. The -command internally invokes `git-rev-list` piped to -`git-diff-tree`, and takes command line options for both of +command internally invokes 'git-rev-list' piped to +'git-diff-tree', and takes command line options for both of these commands. This manual page describes only the most frequently used options. diff --git a/Documentation/git-write-tree.txt b/Documentation/git-write-tree.txt index 19d979bcc7..26d3850e73 100644 --- a/Documentation/git-write-tree.txt +++ b/Documentation/git-write-tree.txt @@ -16,17 +16,17 @@ Creates a tree object using the current index. The index must be in a fully merged state. -Conceptually, `git-write-tree` sync()s the current index contents +Conceptually, 'git-write-tree' sync()s the current index contents into a set of tree files. In order to have that match what is actually in your directory right -now, you need to have done a `git-update-index` phase before you did the -`git-write-tree`. +now, you need to have done a 'git-update-index' phase before you did the +'git-write-tree'. OPTIONS ------- --missing-ok:: - Normally `git-write-tree` ensures that the objects referenced by the + Normally 'git-write-tree' ensures that the objects referenced by the directory exist in the object database. This option disables this check. diff --git a/Documentation/git.txt b/Documentation/git.txt index 0ede9b9967..db4da79b79 100644 --- a/Documentation/git.txt +++ b/Documentation/git.txt @@ -484,8 +484,8 @@ other a pager. 'GIT_SSH':: - If this environment variable is set then `git-fetch` - and `git-push` will use this command instead + If this environment variable is set then 'git-fetch' + and 'git-push' will use this command instead of `ssh` when they need to connect to a remote system. The '$GIT_SSH' command will be given exactly two arguments: the 'username@host' (or just 'host') from the URL and the @@ -501,8 +501,8 @@ for further details. 'GIT_FLUSH':: If this environment variable is set to "1", then commands such - as `git-blame` (in incremental mode), `git-rev-list`, `git-log`, - and `git-whatchanged` will force a flush of the output stream + as 'git-blame' (in incremental mode), 'git-rev-list', 'git-log', + and 'git-whatchanged' will force a flush of the output stream after each commit-oriented record have been flushed. If this variable is set to "0", the output of these commands will be done using completely buffered I/O. If this environment variable is diff --git a/Documentation/gitattributes.txt b/Documentation/gitattributes.txt index 124170a967..0b53044411 100644 --- a/Documentation/gitattributes.txt +++ b/Documentation/gitattributes.txt @@ -87,9 +87,9 @@ Checking-out and checking-in These attributes affect how the contents stored in the repository are copied to the working tree files when commands -such as `git-checkout` and `git-merge` run. They also affect how +such as 'git-checkout' and 'git-merge' run. They also affect how git stores the contents you prepare in the working tree in the -repository upon `git-add` and `git-commit`. +repository upon 'git-add' and 'git-commit'. `crlf` ^^^^^^ @@ -148,16 +148,16 @@ an irreversible conversion. The safety triggers to prevent such a conversion done to the files in the work tree, but there are a few exceptions. Even though... -- `git-add` itself does not touch the files in the work tree, the +- 'git-add' itself does not touch the files in the work tree, the next checkout would, so the safety triggers; -- `git-apply` to update a text file with a patch does touch the files +- 'git-apply' to update a text file with a patch does touch the files in the work tree, but the operation is about text files and CRLF conversion is about fixing the line ending inconsistencies, so the safety does not trigger; -- `git-diff` itself does not touch the files in the work tree, it is - often run to inspect the changes you intend to next `git-add`. To +- 'git-diff' itself does not touch the files in the work tree, it is + often run to inspect the changes you intend to next 'git-add'. To catch potential problems early, safety triggers. @@ -214,7 +214,7 @@ with `crlf`, and then `ident` and fed to `filter`. Generating diff text ~~~~~~~~~~~~~~~~~~~~ -The attribute `diff` affects if `git-diff` generates textual +The attribute `diff` affects if 'git-diff' generates textual patch for the path or just says `Binary files differ`. It also can affect what line is shown on the hunk header `@@ -k,l +n,m @@` line. @@ -514,7 +514,7 @@ archive files. If the attribute `export-subst` is set for a file then git will expand several placeholders when adding this file to an archive. The expansion depends on the availability of a commit ID, i.e., if -`git-archive` has been given a tree instead of a commit or a +'git-archive' has been given a tree instead of a commit or a tag then no replacement will be done. The placeholders are the same as those for the option `--pretty=format:` of linkgit:git-log[1], except that they need to be wrapped like this: `$Format:PLACEHOLDERS$` diff --git a/Documentation/gitcore-tutorial.txt b/Documentation/gitcore-tutorial.txt index 059c8ffd27..2bbe7dea37 100644 --- a/Documentation/gitcore-tutorial.txt +++ b/Documentation/gitcore-tutorial.txt @@ -42,9 +42,9 @@ one for a totally new project, or an existing working tree that you want to import into git. For our first example, we're going to start a totally new repository from -scratch, with no pre-existing files, and we'll call it `git-tutorial`. +scratch, with no pre-existing files, and we'll call it 'git-tutorial'. To start up, create a subdirectory for it, change into that -subdirectory, and initialize the git infrastructure with `git-init`: +subdirectory, and initialize the git infrastructure with 'git-init': ------------------------------------------------ $ mkdir git-tutorial @@ -139,7 +139,7 @@ but to actually check in your hard work, you will have to go through two steps: - commit that index file as an object. The first step is trivial: when you want to tell git about any changes -to your working tree, you use the `git-update-index` program. That +to your working tree, you use the 'git-update-index' program. That program normally just takes a list of filenames you want to update, but to avoid trivial mistakes, it refuses to add new entries to the index (or remove existing ones) unless you explicitly tell it that you're @@ -173,14 +173,14 @@ and see two files: which correspond with the objects with names of `557db...` and `f24c7...` respectively. -If you want to, you can use `git-cat-file` to look at those objects, but +If you want to, you can use 'git-cat-file' to look at those objects, but you'll have to use the object name, not the filename of the object: ---------------- $ git cat-file -t 557db03de997c86a4a028e1ebd3a1ceb225be238 ---------------- -where the `-t` tells `git-cat-file` to tell you what the "type" of the +where the `-t` tells 'git-cat-file' to tell you what the "type" of the object is. git will tell you that you have a "blob" object (i.e., just a regular file), and you can see the contents with @@ -205,7 +205,7 @@ hexadecimal digits in most places. Anyway, as we mentioned previously, you normally never actually take a look at the objects themselves, and typing long 40-character hex names is not something you'd normally want to do. The above digression -was just to show that `git-update-index` did something magical, and +was just to show that 'git-update-index' did something magical, and actually saved away the contents of your files into the git object database. @@ -228,7 +228,7 @@ $ echo "It's a new day for git" >>hello and you can now, since you told git about the previous state of `hello`, ask git what has changed in the tree compared to your old index, using the -`git-diff-files` command: +'git-diff-files' command: ------------ $ git diff-files @@ -239,7 +239,7 @@ version of a `diff`, but that internal version really just tells you that it has noticed that "hello" has been modified, and that the old object contents it had have been replaced with something else. -To make it readable, we can tell `git-diff-files` to output the +To make it readable, we can tell 'git-diff-files' to output the differences as a patch, using the `-p` flag: ------------ @@ -255,7 +255,7 @@ index 557db03..263414f 100644 i.e. the diff of the change we caused by adding another line to `hello`. -In other words, `git-diff-files` always shows us the difference between +In other words, 'git-diff-files' always shows us the difference between what is recorded in the index, and what is currently in the working tree. That's very useful. @@ -283,7 +283,7 @@ that in two phases: creating a 'tree' object, and committing that 'tree' object as a 'commit' object together with an explanation of what the tree was all about, along with information of how we came to that state. -Creating a tree object is trivial, and is done with `git-write-tree`. +Creating a tree object is trivial, and is done with 'git-write-tree'. There are no options or other input: `git write-tree` will take the current index state, and write an object that describes that whole index. In other words, we're now tying together all the different @@ -307,23 +307,23 @@ is not a "blob" object, but a "tree" object (you can also use `git cat-file` to actually output the raw object contents, but you'll see mainly a binary mess, so that's less interesting). -However -- normally you'd never use `git-write-tree` on its own, because +However -- normally you'd never use 'git-write-tree' on its own, because normally you always commit a tree into a commit object using the -`git-commit-tree` command. In fact, it's easier to not actually use -`git-write-tree` on its own at all, but to just pass its result in as an -argument to `git-commit-tree`. +'git-commit-tree' command. In fact, it's easier to not actually use +'git-write-tree' on its own at all, but to just pass its result in as an +argument to 'git-commit-tree'. -`git-commit-tree` normally takes several arguments -- it wants to know +'git-commit-tree' normally takes several arguments -- it wants to know what the 'parent' of a commit was, but since this is the first commit ever in this new repository, and it has no parents, we only need to pass in -the object name of the tree. However, `git-commit-tree` also wants to get a +the object name of the tree. However, 'git-commit-tree' also wants to get a commit message on its standard input, and it will write out the resulting object name for the commit to its standard output. And this is where we create the `.git/refs/heads/master` file which is pointed at by `HEAD`. This file is supposed to contain the reference to the top-of-tree of the master branch, and since -that's exactly what `git-commit-tree` spits out, we can do this +that's exactly what 'git-commit-tree' spits out, we can do this all with a sequence of simple shell commands: ------------------------------------------------ @@ -345,11 +345,11 @@ instead, and it would have done the above magic scripting for you. Making a change --------------- -Remember how we did the `git-update-index` on file `hello` and then we +Remember how we did the 'git-update-index' on file `hello` and then we changed `hello` afterward, and could compare the new state of `hello` with the state we saved in the index file? -Further, remember how I said that `git-write-tree` writes the contents +Further, remember how I said that 'git-write-tree' writes the contents of the *index* file to the tree, and thus what we just committed was in fact the *original* contents of the file `hello`, not the new ones. We did that on purpose, to show the difference between the index state, and the @@ -360,12 +360,12 @@ As before, if we do `git diff-files -p` in our git-tutorial project, we'll still see the same difference we saw last time: the index file hasn't changed by the act of committing anything. However, now that we have committed something, we can also learn to use a new command: -`git-diff-index`. +'git-diff-index'. -Unlike `git-diff-files`, which showed the difference between the index -file and the working tree, `git-diff-index` shows the differences +Unlike 'git-diff-files', which showed the difference between the index +file and the working tree, 'git-diff-index' shows the differences between a committed *tree* and either the index file or the working -tree. In other words, `git-diff-index` wants a tree to be diffed +tree. In other words, 'git-diff-index' wants a tree to be diffed against, and before we did the commit, we couldn't do that, because we didn't have anything to diff against. @@ -375,7 +375,7 @@ But now we can do $ git diff-index -p HEAD ---------------- -(where `-p` has the same meaning as it did in `git-diff-files`), and it +(where `-p` has the same meaning as it did in 'git-diff-files'), and it will show us the same difference, but for a totally different reason. Now we're comparing the working tree not against the index file, but against the tree we just wrote. It just so happens that those two @@ -390,7 +390,7 @@ $ git diff HEAD which ends up doing the above for you. -In other words, `git-diff-index` normally compares a tree against the +In other words, 'git-diff-index' normally compares a tree against the working tree, but when given the `\--cached` flag, it is told to instead compare against just the index cache contents, and ignore the current working tree state entirely. Since we just wrote the index @@ -399,7 +399,7 @@ an empty set of differences, and that's exactly what it does. [NOTE] ================ -`git-diff-index` really always uses the index for its +'git-diff-index' really always uses the index for its comparisons, and saying that it compares a tree against the working tree is thus not strictly accurate. In particular, the list of files to compare (the "meta-data") *always* comes from the index file, @@ -428,11 +428,11 @@ $ git update-index hello (note how we didn't need the `\--add` flag this time, since git knew about the file already). -Note what happens to the different `git-diff-\*` versions here. After +Note what happens to the different 'git-diff-\*' versions here. After we've updated `hello` in the index, `git diff-files -p` now shows no differences, but `git diff-index -p HEAD` still *does* show that the current state is different from the state we committed. In fact, now -`git-diff-index` shows the same difference whether we use the `--cached` +'git-diff-index' shows the same difference whether we use the `--cached` flag or not, since now the index is coherent with the working tree. Now, since we've updated `hello` in the index, we can commit the new @@ -460,7 +460,7 @@ You've now made your first real git commit. And if you're interested in looking at what `git commit` really does, feel free to investigate: it's a few very simple shell scripts to generate the helpful (?) commit message headers, and a few one-liners that actually do the -commit itself (`git-commit`). +commit itself ('git-commit'). Inspecting Changes @@ -468,9 +468,9 @@ Inspecting Changes While creating changes is useful, it's even more useful if you can tell later what changed. The most useful command for this is another of the -`diff` family, namely `git-diff-tree`. +`diff` family, namely 'git-diff-tree'. -`git-diff-tree` can be given two arbitrary trees, and it will tell you the +'git-diff-tree' can be given two arbitrary trees, and it will tell you the differences between them. Perhaps even more commonly, though, you can give it just a single commit object, and it will figure out the parent of that commit itself, and show the difference directly. Thus, to get @@ -518,15 +518,15 @@ various diff-\* commands compare things. +-----------+ ============ -More interestingly, you can also give `git-diff-tree` the `--pretty` flag, +More interestingly, you can also give 'git-diff-tree' the `--pretty` flag, which tells it to also show the commit message and author and date of the commit, and you can tell it to show a whole series of diffs. Alternatively, you can tell it to be "silent", and not show the diffs at all, but just show the actual commit message. -In fact, together with the `git-rev-list` program (which generates a -list of revisions), `git-diff-tree` ends up being a veritable fount of -changes. A trivial (but very useful) script called `git-whatchanged` is +In fact, together with the 'git-rev-list' program (which generates a +list of revisions), 'git-diff-tree' ends up being a veritable fount of +changes. A trivial (but very useful) script called 'git-whatchanged' is included with git which does exactly this, and shows a log of recent activities. @@ -553,14 +553,14 @@ When using the above two commands, the initial commit will be shown. If this is a problem because it is huge, you can hide it by setting the log.showroot configuration variable to false. Having this, you can still show it for each command just adding the `\--root` option, -which is a flag for `git-diff-tree` accepted by both commands. +which is a flag for 'git-diff-tree' accepted by both commands. With that, you should now be having some inkling of what git does, and can explore on your own. [NOTE] Most likely, you are not directly using the core -git Plumbing commands, but using Porcelain such as `git-add`, `git-rm' +git Plumbing commands, but using Porcelain such as 'git-add', `git-rm' and `git-commit'. @@ -595,7 +595,7 @@ pointer to the state you want to tag, but also a small tag name and message, along with optionally a PGP signature that says that yes, you really did that tag. You create these annotated tags with either the `-a` or -`-s` flag to `git-tag`: +`-s` flag to 'git-tag': ---------------- $ git tag -s <tagname> @@ -642,7 +642,7 @@ and it will be gone. There's no external repository, and there's no history outside the project you created. - if you want to move or duplicate a git repository, you can do so. There - is `git-clone` command, but if all you want to do is just to + is 'git-clone' command, but if all you want to do is just to create a copy of your repository (with all the full history that went along with it), you can do so with a regular `cp -a git-tutorial new-git-tutorial`. @@ -666,7 +666,7 @@ When copying a remote repository, you'll want to at a minimum update the index cache when you do this, and especially with other peoples' repositories you often want to make sure that the index cache is in some known state (you don't know *what* they've done and not yet checked in), -so usually you'll precede the `git-update-index` with a +so usually you'll precede the 'git-update-index' with a ---------------- $ git read-tree --reset HEAD @@ -674,7 +674,7 @@ $ git update-index --refresh ---------------- which will force a total index re-build from the tree pointed to by `HEAD`. -It resets the index contents to `HEAD`, and then the `git-update-index` +It resets the index contents to `HEAD`, and then the 'git-update-index' makes sure to match up all index entries with the checked-out files. If the original repository had uncommitted changes in its working tree, `git update-index --refresh` notices them and @@ -689,8 +689,8 @@ $ git reset and in fact a lot of the common git command combinations can be scripted with the `git xyz` interfaces. You can learn things by just looking at what the various git scripts do. For example, `git reset` used to be -the above two lines implemented in `git-reset`, but some things like -`git-status` and `git-commit` are slightly more complex scripts around +the above two lines implemented in 'git-reset', but some things like +'git-status' and 'git-commit' are slightly more complex scripts around the basic git commands. Many (most?) public remote repositories will not contain any of @@ -729,7 +729,7 @@ where the `-u` flag means that you want the checkout to keep the index up-to-date (so that you don't have to refresh it afterward), and the `-a` flag means "check out all files" (if you have a stale copy or an older version of a checked out tree you may also need to add the `-f` -flag first, to tell `git-checkout-index` to *force* overwriting of any old +flag first, to tell 'git-checkout-index' to *force* overwriting of any old files). Again, this can all be simplified with @@ -776,7 +776,7 @@ to it. ================================================ If you make the decision to start your new branch at some other point in the history than the current `HEAD`, you can do so by -just telling `git-checkout` what the base of the checkout would be. +just telling 'git-checkout' what the base of the checkout would be. In other words, if you have an earlier tag or branch, you'd just do ------------ @@ -819,7 +819,7 @@ $ git branch <branchname> [startingpoint] which will simply _create_ the branch, but will not do anything further. You can then later -- once you decide that you want to actually develop -on that branch -- switch to that branch with a regular `git-checkout` +on that branch -- switch to that branch with a regular 'git-checkout' with the branchname as the argument. @@ -881,7 +881,7 @@ source. Anyway, let's exit `gitk` (`^Q` or the File menu), and decide that we want to merge the work we did on the `mybranch` branch into the `master` branch (which is currently our `HEAD` too). To do that, there's a nice -script called `git-merge`, which wants to know which branches you want +script called 'git-merge', which wants to know which branches you want to resolve and what the merge is all about: ------------ @@ -925,7 +925,7 @@ $ git commit -i hello which will very loudly warn you that you're now committing a merge (which is correct, so never mind), and you can write a small merge -message about your adventures in `git-merge`-land. +message about your adventures in 'git-merge'-land. After you're done, start up `gitk \--all` to see graphically what the history looks like. Notice that `mybranch` still exists, and you can @@ -967,21 +967,21 @@ branch head. Please see linkgit:git-rev-parse[1] if you want to see more complex cases. [NOTE] -Without the '--more=1' option, `git-show-branch` would not output the +Without the '--more=1' option, 'git-show-branch' would not output the '[master^]' commit, as '[mybranch]' commit is a common ancestor of both 'master' and 'mybranch' tips. Please see linkgit:git-show-branch[1] for details. [NOTE] If there were more commits on the 'master' branch after the merge, the -merge commit itself would not be shown by `git-show-branch` by +merge commit itself would not be shown by 'git-show-branch' by default. You would need to provide '--sparse' option to make the merge commit visible in this case. Now, let's pretend you are the one who did all the work in `mybranch`, and the fruit of your hard work has finally been merged to the `master` branch. Let's go back to `mybranch`, and run -`git-merge` to get the "upstream changes" back to your branch. +'git-merge' to get the "upstream changes" back to your branch. ------------ $ git checkout mybranch @@ -1023,12 +1023,12 @@ Merging external work It's usually much more common that you merge with somebody else than merging with your own branches, so it's worth pointing out that git makes that very easy too, and in fact, it's not that different from -doing a `git-merge`. In fact, a remote merge ends up being nothing +doing a 'git-merge'. In fact, a remote merge ends up being nothing more than "fetch the work from a remote repository into a temporary tag" -followed by a `git-merge`. +followed by a 'git-merge'. Fetching from a remote repository is done by, unsurprisingly, -`git-fetch`: +'git-fetch': ---------------- $ git fetch <remote-repository> @@ -1095,7 +1095,7 @@ The 'commit walkers' are sometimes also called 'dumb transports', because they do not require any git aware smart server like git Native transport does. Any stock HTTP server that does not even support directory index would suffice. But -you must prepare your repository with `git-update-server-info` +you must prepare your repository with 'git-update-server-info' to help dumb transport downloaders. Once you fetch from the remote repository, you `merge` that @@ -1115,7 +1115,7 @@ argument. [NOTE] You could do without using any branches at all, by keeping as many local repositories as you would like to have -branches, and merging between them with `git-pull`, just like +branches, and merging between them with 'git-pull', just like you merge between branches. The advantage of this approach is that it lets you keep a set of files for each `branch` checked out and you may find it easier to switch back and forth if you @@ -1132,7 +1132,7 @@ like this: $ git config remote.linus.url http://www.kernel.org/pub/scm/git/git.git/ ------------------------------------------------ -and use the "linus" keyword with `git-pull` instead of the full URL. +and use the "linus" keyword with 'git-pull' instead of the full URL. Examples. @@ -1168,7 +1168,7 @@ $ git show-branch --more=2 master mybranch +* [master^] Some fun. ------------ -Remember, before running `git-merge`, our `master` head was at +Remember, before running 'git-merge', our `master` head was at "Some fun." commit, while our `mybranch` head was at "Some work." commit. @@ -1195,7 +1195,7 @@ Now we are ready to experiment with the merge by hand. `git merge` command, when merging two branches, uses 3-way merge algorithm. First, it finds the common ancestor between them. -The command it uses is `git-merge-base`: +The command it uses is 'git-merge-base': ------------ $ mb=$(git merge-base HEAD mybranch) @@ -1219,7 +1219,7 @@ this: $ git read-tree -m -u $mb HEAD mybranch ------------ -This is the same `git-read-tree` command we have already seen, +This is the same 'git-read-tree' command we have already seen, but it takes three trees, unlike previous examples. This reads the contents of each tree into different 'stage' in the index file (the first tree goes to stage 1, the second to stage 2, @@ -1260,8 +1260,8 @@ $ git ls-files --unmerged The next step of merging is to merge these three versions of the file, using 3-way merge. This is done by giving -`git-merge-one-file` command as one of the arguments to -`git-merge-index` command: +'git-merge-one-file' command as one of the arguments to +'git-merge-index' command: ------------ $ git merge-index git-merge-one-file hello @@ -1271,7 +1271,7 @@ ERROR: Merge conflict in hello. fatal: merge program failed ------------ -`git-merge-one-file` script is called with parameters to +'git-merge-one-file' script is called with parameters to describe those three versions, and is responsible to leave the merge results in the working tree. It is a fairly straightforward shell script, and @@ -1290,9 +1290,9 @@ $ git ls-files --stage ------------ This is the state of the index file and the working file after -`git-merge` returns control back to you, leaving the conflicting +'git-merge' returns control back to you, leaving the conflicting merge for you to resolve. Notice that the path `hello` is still -unmerged, and what you see with `git-diff` at this point is +unmerged, and what you see with 'git-diff' at this point is differences since stage 2 (i.e. your version). @@ -1320,7 +1320,7 @@ how git repositories at `kernel.org` are managed. Publishing the changes from your local (private) repository to your remote (public) repository requires a write privilege on the remote machine. You need to have an SSH account there to -run a single command, `git-receive-pack`. +run a single command, 'git-receive-pack'. First, you need to create an empty repository on the remote machine that will house your public repository. This empty @@ -1329,8 +1329,8 @@ into it later. Obviously, this repository creation needs to be done only once. [NOTE] -`git-push` uses a pair of programs, -`git-send-pack` on your local machine, and `git-receive-pack` +'git-push' uses a pair of programs, +'git-send-pack' on your local machine, and 'git-receive-pack' on the remote machine. The communication between the two over the network internally uses an SSH connection. @@ -1345,7 +1345,7 @@ $ mkdir my-git.git ------------ Then, make that directory into a git repository by running -`git-init`, but this time, since its name is not the usual +'git-init', but this time, since its name is not the usual `.git`, we do things slightly differently: ------------ @@ -1354,7 +1354,7 @@ $ GIT_DIR=my-git.git git init Make sure this directory is available for others you want your changes to be pulled by via the transport of your choice. Also -you need to make sure that you have the `git-receive-pack` +you need to make sure that you have the 'git-receive-pack' program on the `$PATH`. [NOTE] @@ -1362,7 +1362,7 @@ Many installations of sshd do not invoke your shell as the login shell when you directly run programs; what this means is that if your login shell is `bash`, only `.bashrc` is read and not `.bash_profile`. As a workaround, make sure `.bashrc` sets up -`$PATH` so that you can run `git-receive-pack` program. +`$PATH` so that you can run 'git-receive-pack' program. [NOTE] If you plan to publish this repository to be accessed over http, @@ -1407,7 +1407,7 @@ $ git repack will do it for you. If you followed the tutorial examples, you would have accumulated about 17 objects in `.git/objects/??/` -directories by now. `git-repack` tells you how many objects it +directories by now. 'git-repack' tells you how many objects it packed, and stores the packed file in `.git/objects/pack` directory. @@ -1420,7 +1420,7 @@ them together. The former holds all the data from the objects in the pack, and the latter holds the index for random access. -If you are paranoid, running `git-verify-pack` command would +If you are paranoid, running 'git-verify-pack' command would detect if you have a corrupt pack, but do not worry too much. Our programs are always perfect ;-). @@ -1487,17 +1487,17 @@ If other people are pulling from your repository over dumb transport protocols (HTTP), you need to keep this repository 'dumb transport friendly'. After `git init`, `$GIT_DIR/hooks/post-update` copied from the standard templates -would contain a call to `git-update-server-info` but the +would contain a call to 'git-update-server-info' but the `post-update` hook itself is disabled by default -- enable it -with `chmod +x post-update`. This makes sure `git-update-server-info` +with `chmod +x post-update`. This makes sure 'git-update-server-info' keeps the necessary files up-to-date. 3. Push into the public repository from your primary repository. -4. `git-repack` the public repository. This establishes a big +4. 'git-repack' the public repository. This establishes a big pack that contains the initial set of objects as the - baseline, and possibly `git-prune` if the transport + baseline, and possibly 'git-prune' if the transport used for pulling from your repository supports packed repositories. @@ -1518,7 +1518,7 @@ You can repack this private repository whenever you feel like. A recommended work cycle for a "subsystem maintainer" who works on that project and has an own "public repository" goes like this: -1. Prepare your work repository, by `git-clone` the public +1. Prepare your work repository, by 'git-clone' the public repository of the "project lead". The URL used for the initial cloning is stored in the remote.origin.url configuration variable. @@ -1533,7 +1533,7 @@ on that project and has an own "public repository" goes like this: point at the repository you are borrowing from. 4. Push into the public repository from your primary - repository. Run `git-repack`, and possibly `git-prune` if the + repository. Run 'git-repack', and possibly 'git-prune' if the transport used for pulling from your repository supports packed repositories. @@ -1550,7 +1550,7 @@ like. "project lead" and possibly your "sub-subsystem maintainers" to pull from it. -7. Every once in a while, `git-repack` the public repository. +7. Every once in a while, 'git-repack' the public repository. Go back to step 5. and continue working. @@ -1558,7 +1558,7 @@ A recommended work cycle for an "individual developer" who does not have a "public" repository is somewhat different. It goes like this: -1. Prepare your work repository, by `git-clone` the public +1. Prepare your work repository, by 'git-clone' the public repository of the "project lead" (or a "subsystem maintainer", if you work on a subsystem). The URL used for the initial cloning is stored in the remote.origin.url diff --git a/Documentation/gitcvs-migration.txt b/Documentation/gitcvs-migration.txt index 4dc7ec5407..41ad6087e5 100644 --- a/Documentation/gitcvs-migration.txt +++ b/Documentation/gitcvs-migration.txt @@ -47,25 +47,25 @@ them first before running git pull. [NOTE] ================================ The `pull` command knows where to get updates from because of certain -configuration variables that were set by the first `git-clone` +configuration variables that were set by the first 'git-clone' command; see `git config -l` and the linkgit:git-config[1] man page for details. ================================ You can update the shared repository with your changes by first committing -your changes, and then using the `git-push` command: +your changes, and then using the 'git-push' command: ------------------------------------------------ $ git push origin master ------------------------------------------------ to "push" those commits to the shared repository. If someone else has -updated the repository more recently, `git-push`, like `cvs commit`, will +updated the repository more recently, 'git-push', like `cvs commit`, will complain, in which case you must pull any changes before attempting the push again. -In the `git-push` command above we specify the name of the remote branch -to update (`master`). If we leave that out, `git-push` tries to update +In the 'git-push' command above we specify the name of the remote branch +to update (`master`). If we leave that out, 'git-push' tries to update any branches in the remote repository that have the same name as a branch in the local repository. So the last `push` can be done with either of: @@ -118,7 +118,7 @@ Importing a CVS archive First, install version 2.1 or higher of cvsps from link:http://www.cobite.com/cvsps/[http://www.cobite.com/cvsps/] and make sure it is in your path. Then cd to a checked out CVS working directory -of the project you are interested in and run `git-cvsimport`: +of the project you are interested in and run 'git-cvsimport': ------------------------------------------- $ git cvsimport -C <destination> <module> diff --git a/Documentation/gitdiffcore.txt b/Documentation/gitdiffcore.txt index 949332b58e..84b95a4e74 100644 --- a/Documentation/gitdiffcore.txt +++ b/Documentation/gitdiffcore.txt @@ -12,7 +12,7 @@ SYNOPSIS DESCRIPTION ----------- -The diff commands `git-diff-index`, `git-diff-files`, and `git-diff-tree` +The diff commands 'git-diff-index', 'git-diff-files', and 'git-diff-tree' can be told to manipulate differences they find in unconventional ways before showing `diff` output. The manipulation is collectively called "diffcore transformation". This short note @@ -23,18 +23,18 @@ that is easier to understand than the conventional kind. The chain of operation ---------------------- -The `git-diff-{asterisk}` family works by first comparing two sets of +The 'git-diff-{asterisk}' family works by first comparing two sets of files: - - `git-diff-index` compares contents of a "tree" object and the + - 'git-diff-index' compares contents of a "tree" object and the working directory (when '\--cached' flag is not used) or a "tree" object and the index file (when '\--cached' flag is used); - - `git-diff-files` compares contents of the index file and the + - 'git-diff-files' compares contents of the index file and the working directory; - - `git-diff-tree` compares contents of two "tree" objects; + - 'git-diff-tree' compares contents of two "tree" objects; In all of these cases, the commands themselves compare corresponding paths in the two sets of files. The result of @@ -61,12 +61,12 @@ into another list. There are currently 6 such transformations: - diffcore-pickaxe - diffcore-order -These are applied in sequence. The set of filepairs `git-diff-{asterisk}` +These are applied in sequence. The set of filepairs 'git-diff-{asterisk}' commands find are used as the input to diffcore-pathspec, and the output from diffcore-pathspec is used as the input to the next transformation. The final result is then passed to the output routine and generates either diff-raw format (see Output -format sections of the manual for `git-diff-{asterisk}` commands) or +format sections of the manual for 'git-diff-{asterisk}' commands) or diff-patch format. @@ -75,7 +75,7 @@ diffcore-pathspec: For Ignoring Files Outside Our Consideration The first transformation in the chain is diffcore-pathspec, and is controlled by giving the pathname parameters to the -`git-diff-{asterisk}` commands on the command line. The pathspec is used +'git-diff-{asterisk}' commands on the command line. The pathspec is used to limit the world diff operates in. It removes the filepairs outside the specified set of pathnames. E.g. If the input set of filepairs included: @@ -88,7 +88,7 @@ but the command invocation was `git diff-files myfile`, then the junkfile entry would be removed from the list because only "myfile" is under consideration. -Implementation note. For performance reasons, `git-diff-tree` +Implementation note. For performance reasons, 'git-diff-tree' uses the pathname parameters on the command line to cull set of filepairs it feeds the diffcore mechanism itself, and does not use diffcore-pathspec, but the end result is the same. @@ -98,7 +98,7 @@ diffcore-break: For Splitting Up "Complete Rewrites" ---------------------------------------------------- The second transformation in the chain is diffcore-break, and is -controlled by the -B option to the `git-diff-{asterisk}` commands. This is +controlled by the -B option to the 'git-diff-{asterisk}' commands. This is used to detect a filepair that represents "complete rewrite" and break such filepair into two filepairs that represent delete and create. E.g. If the input contained this filepair: @@ -134,7 +134,7 @@ diffcore-rename: For Detection Renames and Copies This transformation is used to detect renames and copies, and is controlled by the -M option (to detect renames) and the -C option -(to detect copies as well) to the `git-diff-{asterisk}` commands. If the +(to detect copies as well) to the 'git-diff-{asterisk}' commands. If the input contained these filepairs: ------------------------------------------------ @@ -179,11 +179,11 @@ number after the "-M" or "-C" option (e.g. "-M8" to tell it to use 8/10 = 80%). Note. When the "-C" option is used with `\--find-copies-harder` -option, `git-diff-{asterisk}` commands feed unmodified filepairs to +option, 'git-diff-{asterisk}' commands feed unmodified filepairs to diffcore mechanism as well as modified ones. This lets the copy detector consider unmodified files as copy source candidates at the expense of making it slower. Without `\--find-copies-harder`, -`git-diff-{asterisk}` commands can detect copies only if the file that was +'git-diff-{asterisk}' commands can detect copies only if the file that was copied happened to have been modified in the same changeset. @@ -234,7 +234,7 @@ diffcore-pickaxe: For Detecting Addition/Deletion of Specified String This transformation is used to find filepairs that represent changes that touch a specified string, and is controlled by the --S option and the `\--pickaxe-all` option to the `git-diff-{asterisk}` +-S option and the `\--pickaxe-all` option to the 'git-diff-{asterisk}' commands. When diffcore-pickaxe is in use, it checks if there are @@ -257,7 +257,7 @@ diffcore-order: For Sorting the Output Based on Filenames This is used to reorder the filepairs according to the user's (or project's) taste, and is controlled by the -O option to the -`git-diff-{asterisk}` commands. +'git-diff-{asterisk}' commands. This takes a text file each of whose lines is a shell glob pattern. Filepairs that match a glob pattern on an earlier line diff --git a/Documentation/githooks.txt b/Documentation/githooks.txt index 6a0d098f7c..046a2a7fe7 100644 --- a/Documentation/githooks.txt +++ b/Documentation/githooks.txt @@ -15,7 +15,7 @@ DESCRIPTION Hooks are little scripts you can place in `$GIT_DIR/hooks` directory to trigger action at certain points. When -`git-init` is run, a handful example hooks are copied in the +'git-init' is run, a handful example hooks are copied in the `hooks` directory of the new repository, but by default they are all disabled. To enable a hook, rename it by removing its `.sample` suffix. @@ -25,10 +25,10 @@ This document describes the currently defined hooks. applypatch-msg -------------- -This hook is invoked by `git-am` script. It takes a single +This hook is invoked by 'git-am' script. It takes a single parameter, the name of the file that holds the proposed commit log message. Exiting with non-zero status causes -`git-am` to abort before applying the patch. +'git-am' to abort before applying the patch. The hook is allowed to edit the message file in place, and can be used to normalize the message into some project standard @@ -41,7 +41,7 @@ The default 'applypatch-msg' hook, when enabled, runs the pre-applypatch -------------- -This hook is invoked by `git-am`. It takes no parameter, and is +This hook is invoked by 'git-am'. It takes no parameter, and is invoked after the patch is applied, but before a commit is made. If it exits with non-zero status, then the working tree will not be @@ -56,33 +56,33 @@ The default 'pre-applypatch' hook, when enabled, runs the post-applypatch --------------- -This hook is invoked by `git-am`. It takes no parameter, +This hook is invoked by 'git-am'. It takes no parameter, and is invoked after the patch is applied and a commit is made. This hook is meant primarily for notification, and cannot affect -the outcome of `git-am`. +the outcome of 'git-am'. pre-commit ---------- -This hook is invoked by `git-commit`, and can be bypassed +This hook is invoked by 'git-commit', and can be bypassed with `\--no-verify` option. It takes no parameter, and is invoked before obtaining the proposed commit log message and making a commit. Exiting with non-zero status from this script -causes the `git-commit` to abort. +causes the 'git-commit' to abort. The default 'pre-commit' hook, when enabled, catches introduction of lines with trailing whitespaces and aborts the commit when such a line is found. -All the `git-commit` hooks are invoked with the environment +All the 'git-commit' hooks are invoked with the environment variable `GIT_EDITOR=:` if the command will not bring up an editor to modify the commit message. prepare-commit-msg ------------------ -This hook is invoked by `git-commit` right after preparing the +This hook is invoked by 'git-commit' right after preparing the default log message, and before the editor is started. It takes one to three parameters. The first is the name of the file @@ -94,7 +94,7 @@ commit is a merge or a `.git/MERGE_MSG` file exists); `squash` (if a `.git/SQUASH_MSG` file exists); or `commit`, followed by a commit SHA1 (if a `\-c`, `\-C` or `\--amend` option was given). -If the exit status is non-zero, `git-commit` will abort. +If the exit status is non-zero, 'git-commit' will abort. The purpose of the hook is to edit the message file in place, and it is not suppressed by the `\--no-verify` option. A non-zero exit @@ -107,10 +107,10 @@ out the `Conflicts:` part of a merge's commit message. commit-msg ---------- -This hook is invoked by `git-commit`, and can be bypassed +This hook is invoked by 'git-commit', and can be bypassed with `\--no-verify` option. It takes a single parameter, the name of the file that holds the proposed commit log message. -Exiting with non-zero status causes the `git-commit` to +Exiting with non-zero status causes the 'git-commit' to abort. The hook is allowed to edit the message file in place, and can @@ -124,21 +124,21 @@ The default 'commit-msg' hook, when enabled, detects duplicate post-commit ----------- -This hook is invoked by `git-commit`. It takes no +This hook is invoked by 'git-commit'. It takes no parameter, and is invoked after a commit is made. This hook is meant primarily for notification, and cannot affect -the outcome of `git-commit`. +the outcome of 'git-commit'. post-checkout ----------- -This hook is invoked when a `git-checkout` is run after having updated the +This hook is invoked when a 'git-checkout' is run after having updated the worktree. The hook is given three parameters: the ref of the previous HEAD, the ref of the new HEAD (which may or may not have changed), and a flag indicating whether the checkout was a branch checkout (changing branches, flag=1) or a file checkout (retrieving a file from the index, flag=0). -This hook cannot affect the outcome of `git-checkout`. +This hook cannot affect the outcome of 'git-checkout'. This hook can be used to perform repository validity checks, auto-display differences from the previous HEAD if different, or set working dir metadata @@ -147,10 +147,10 @@ properties. post-merge ----------- -This hook is invoked by `git-merge`, which happens when a `git-pull` +This hook is invoked by 'git-merge', which happens when a 'git-pull' is done on a local repository. The hook takes a single parameter, a status flag specifying whether or not the merge being done was a squash merge. -This hook cannot affect the outcome of `git-merge` and is not executed, +This hook cannot affect the outcome of 'git-merge' and is not executed, if the merge failed due to conflicts. This hook can be used in conjunction with a corresponding pre-commit hook to @@ -162,8 +162,8 @@ for an example of how to do this. pre-receive ----------- -This hook is invoked by `git-receive-pack` on the remote repository, -which happens when a `git-push` is done on a local repository. +This hook is invoked by 'git-receive-pack' on the remote repository, +which happens when a 'git-push' is done on a local repository. Just before starting to update refs on the remote repository, the pre-receive hook is invoked. Its exit status determines the success or failure of the update. @@ -184,15 +184,15 @@ updated. If the hook exits with zero, updating of individual refs can still be prevented by the <<update,'update'>> hook. Both standard output and standard error output are forwarded to -`git-send-pack` on the other end, so you can simply `echo` messages +'git-send-pack' on the other end, so you can simply `echo` messages for the user. [[update]] update ------ -This hook is invoked by `git-receive-pack` on the remote repository, -which happens when a `git-push` is done on a local repository. +This hook is invoked by 'git-receive-pack' on the remote repository, +which happens when a 'git-push' is done on a local repository. Just before updating the ref on the remote repository, the update hook is invoked. Its exit status determines the success or failure of the ref update. @@ -205,7 +205,7 @@ three parameters: - and the new objectname to be stored in the ref. A zero exit from the update hook allows the ref to be updated. -Exiting with a non-zero status prevents `git-receive-pack` +Exiting with a non-zero status prevents 'git-receive-pack' from updating that ref. This hook can be used to prevent 'forced' update on certain refs by @@ -223,7 +223,7 @@ implement access control which is finer grained than the one based on filesystem group. Both standard output and standard error output are forwarded to -`git-send-pack` on the other end, so you can simply `echo` messages +'git-send-pack' on the other end, so you can simply `echo` messages for the user. The default 'update' hook, when enabled--and with @@ -234,8 +234,8 @@ unannotated tags to be pushed. post-receive ------------ -This hook is invoked by `git-receive-pack` on the remote repository, -which happens when a `git-push` is done on a local repository. +This hook is invoked by 'git-receive-pack' on the remote repository, +which happens when a 'git-push' is done on a local repository. It executes on the remote repository once after all the refs have been updated. @@ -244,7 +244,7 @@ arguments, but gets the same information as the <<pre-receive,'pre-receive'>> hook does on its standard input. -This hook does not affect the outcome of `git-receive-pack`, as it +This hook does not affect the outcome of 'git-receive-pack', as it is called after the real work is done. This supersedes the <<post-update,'post-update'>> hook in that it gets @@ -252,7 +252,7 @@ both old and new values of all the refs in addition to their names. Both standard output and standard error output are forwarded to -`git-send-pack` on the other end, so you can simply `echo` messages +'git-send-pack' on the other end, so you can simply `echo` messages for the user. The default 'post-receive' hook is empty, but there is @@ -264,8 +264,8 @@ emails. post-update ----------- -This hook is invoked by `git-receive-pack` on the remote repository, -which happens when a `git-push` is done on a local repository. +This hook is invoked by 'git-receive-pack' on the remote repository, +which happens when a 'git-push' is done on a local repository. It executes on the remote repository once after all the refs have been updated. @@ -273,7 +273,7 @@ It takes a variable number of parameters, each of which is the name of ref that was actually updated. This hook is meant primarily for notification, and cannot affect -the outcome of `git-receive-pack`. +the outcome of 'git-receive-pack'. The 'post-update' hook can tell what are the heads that were pushed, but it does not know what their original and updated values are, @@ -283,20 +283,20 @@ updated values of the refs. You might consider it instead if you need them. When enabled, the default 'post-update' hook runs -`git-update-server-info` to keep the information used by dumb +'git-update-server-info' to keep the information used by dumb transports (e.g., HTTP) up-to-date. If you are publishing a git repository that is accessible via HTTP, you should probably enable this hook. Both standard output and standard error output are forwarded to -`git-send-pack` on the other end, so you can simply `echo` messages +'git-send-pack' on the other end, so you can simply `echo` messages for the user. pre-auto-gc ----------- -This hook is invoked by `git-gc --auto`. It takes no parameter, and -exiting with non-zero status from this script causes the `git-gc --auto` +This hook is invoked by 'git-gc --auto'. It takes no parameter, and +exiting with non-zero status from this script causes the 'git-gc --auto' to abort. GIT diff --git a/Documentation/gitignore.txt b/Documentation/gitignore.txt index cafdac7e3d..fc0efd8ec8 100644 --- a/Documentation/gitignore.txt +++ b/Documentation/gitignore.txt @@ -51,10 +51,10 @@ the user's editor of choice) generally go into a file specified by `core.excludesfile` in the user's `~/.gitconfig`. The underlying git plumbing tools, such as -`git-ls-files` and `git-read-tree`, read +'git-ls-files' and 'git-read-tree', read `gitignore` patterns specified by command-line options, or from files specified by command-line options. Higher-level git -tools, such as `git-status` and `git-add`, +tools, such as 'git-status' and 'git-add', use patterns from the sources specified above. Patterns have the following format: diff --git a/Documentation/gitk.txt b/Documentation/gitk.txt index 03688bfa6b..e02ecf5744 100644 --- a/Documentation/gitk.txt +++ b/Documentation/gitk.txt @@ -22,7 +22,7 @@ git repository. OPTIONS ------- To control which revisions to shown, the command takes options applicable to -the `git-rev-list` command (see linkgit:git-rev-list[1]). +the 'git-rev-list' command (see linkgit:git-rev-list[1]). This manual page describes only the most frequently used options. diff --git a/Documentation/gitrepository-layout.txt b/Documentation/gitrepository-layout.txt index ade812e0e6..a969b3fbc3 100644 --- a/Documentation/gitrepository-layout.txt +++ b/Documentation/gitrepository-layout.txt @@ -64,7 +64,7 @@ objects/info/packs:: are available in this object store. Whenever a pack is added or removed, `git update-server-info` should be run to keep this file up-to-date if the repository is - published for dumb transports. `git-repack` does this + published for dumb transports. 'git-repack' does this by default. objects/info/alternates:: @@ -85,7 +85,7 @@ objects/info/http-alternates:: refs:: References are stored in subdirectories of this - directory. The `git-prune` command knows to keep + directory. The 'git-prune' command knows to keep objects reachable from refs found in this directory and its subdirectories. @@ -125,7 +125,7 @@ details. branches:: A slightly deprecated way to store shorthands to be used - to specify URL to `git-fetch`, `git-pull` and `git-push` + to specify URL to 'git-fetch', 'git-pull' and 'git-push' commands is to store a file in `branches/<name>` and give 'name' to these commands in place of 'repository' argument. @@ -133,7 +133,7 @@ branches:: hooks:: Hooks are customization scripts used by various git commands. A handful of sample hooks are installed when - `git-init` is run, but all of them are disabled by + 'git-init' is run, but all of them are disabled by default. To enable, they need to be made executable. Read linkgit:githooks[5] for more details about each hook. @@ -150,10 +150,10 @@ info/refs:: This file helps dumb transports discover what refs are available in this repository. If the repository is published for dumb transports, this file should be - regenerated by `git-update-server-info` every time a tag + regenerated by 'git-update-server-info' every time a tag or branch is created or modified. This is normally done from the `hooks/update` hook, which is run by the - `git-receive-pack` command when you `git-push` into the + 'git-receive-pack' command when you 'git-push' into the repository. info/grafts:: @@ -167,14 +167,14 @@ info/grafts:: info/exclude:: This file, by convention among Porcelains, stores the exclude pattern list. `.gitignore` is the per-directory - ignore file. `git-status`, `git-add`, `git-rm` and - `git-clean` look at it but the core git commands do not look + ignore file. 'git-status', 'git-add', 'git-rm' and + 'git-clean' look at it but the core git commands do not look at it. See also: linkgit:gitignore[5]. remotes:: Stores shorthands to be used to give URL and default refnames to interact with remote repository to - `git-fetch`, `git-pull` and `git-push` commands. + 'git-fetch', 'git-pull' and 'git-push' commands. logs:: Records of changes made to refs are stored in this diff --git a/Documentation/gittutorial-2.txt b/Documentation/gittutorial-2.txt index 6c93445cc1..660904686c 100644 --- a/Documentation/gittutorial-2.txt +++ b/Documentation/gittutorial-2.txt @@ -255,7 +255,7 @@ index a042389..513feba 100644 +hello world, again ------------------------------------------------ -So `git-diff` is comparing against something other than the head. +So 'git-diff' is comparing against something other than the head. The thing that it's comparing against is actually the index file, which is stored in .git/index in a binary format, but whose contents we can examine with ls-files: @@ -270,9 +270,9 @@ hello world! hello world, again ------------------------------------------------ -So what our `git-add` did was store a new blob and then put +So what our 'git-add' did was store a new blob and then put a reference to it in the index file. If we modify the file again, -we'll see that the new modifications are reflected in the `git-diff` +we'll see that the new modifications are reflected in the 'git-diff' output: ------------------------------------------------ @@ -287,7 +287,7 @@ index 513feba..ba3da7b 100644 +again? ------------------------------------------------ -With the right arguments, `git-diff` can also show us the difference +With the right arguments, 'git-diff' can also show us the difference between the working directory and the last commit, or between the index and the last commit: @@ -311,7 +311,7 @@ index a042389..513feba 100644 +hello world, again ------------------------------------------------ -At any time, we can create a new commit using `git-commit` (without +At any time, we can create a new commit using 'git-commit' (without the "-a" option), and verify that the state committed only includes the changes stored in the index file, not the additional change that is still only in our working tree: @@ -329,11 +329,11 @@ index 513feba..ba3da7b 100644 +again? ------------------------------------------------ -So by default `git-commit` uses the index to create the commit, not +So by default 'git-commit' uses the index to create the commit, not the working tree; the "-a" option to commit tells it to first update the index with all changes in the working tree. -Finally, it's worth looking at the effect of `git-add` on the index +Finally, it's worth looking at the effect of 'git-add' on the index file: ------------------------------------------------ @@ -341,7 +341,7 @@ $ echo "goodbye, world" >closing.txt $ git add closing.txt ------------------------------------------------ -The effect of the `git-add` was to add one entry to the index file: +The effect of the 'git-add' was to add one entry to the index file: ------------------------------------------------ $ git ls-files --stage diff --git a/Documentation/gittutorial.txt b/Documentation/gittutorial.txt index 036a27c41c..2c4346c9e8 100644 --- a/Documentation/gittutorial.txt +++ b/Documentation/gittutorial.txt @@ -58,7 +58,7 @@ You've now initialized the working directory--you may notice a new directory created, named ".git". Next, tell git to take a snapshot of the contents of all files under the -current directory (note the '.'), with `git-add`: +current directory (note the '.'), with 'git-add': ------------------------------------------------ $ git add . @@ -66,7 +66,7 @@ $ git add . This snapshot is now stored in a temporary staging area which git calls the "index". You can permanently store the contents of the index in the -repository with `git-commit`: +repository with 'git-commit': ------------------------------------------------ $ git commit @@ -85,15 +85,15 @@ $ git add file1 file2 file3 ------------------------------------------------ You are now ready to commit. You can see what is about to be committed -using `git-diff` with the --cached option: +using 'git-diff' with the --cached option: ------------------------------------------------ $ git diff --cached ------------------------------------------------ -(Without --cached, `git-diff` will show you any changes that +(Without --cached, 'git-diff' will show you any changes that you've made but not yet added to the index.) You can also get a brief -summary of the situation with `git-status`: +summary of the situation with 'git-status': ------------------------------------------------ $ git status @@ -117,7 +117,7 @@ $ git commit This will again prompt you for a message describing the change, and then record a new version of the project. -Alternatively, instead of running `git-add` beforehand, you can use +Alternatively, instead of running 'git-add' beforehand, you can use ------------------------------------------------ $ git commit -a @@ -138,7 +138,7 @@ Git tracks content not files Many revision control systems provide an `add` command that tells the system to start tracking changes to a new file. Git's `add` command -does something simpler and more powerful: `git-add` is used both for new +does something simpler and more powerful: 'git-add' is used both for new and newly modified files, and in both cases it takes a snapshot of the given files and stages that content in the index, ready for inclusion in the next commit. @@ -316,7 +316,7 @@ $ git remote add bob /home/bob/myrepo ------------------------------------------------ With this, Alice can perform the first operation alone using the -`git-fetch` command without merging them with her own branch, +'git-fetch' command without merging them with her own branch, using: ------------------------------------- @@ -324,7 +324,7 @@ $ git fetch bob ------------------------------------- Unlike the longhand form, when Alice fetches from Bob using a -remote repository shorthand set up with `git-remote`, what was +remote repository shorthand set up with 'git-remote', what was fetched is stored in a remote tracking branch, in this case `bob/master`. So after this: @@ -368,7 +368,7 @@ $ git config --get remote.origin.url /home/alice/project ------------------------------------- -(The complete configuration created by `git-clone` is visible using +(The complete configuration created by 'git-clone' is visible using `git config -l`, and the linkgit:git-config[1] man page explains the meaning of each option.) @@ -398,7 +398,7 @@ Exploring history ----------------- Git history is represented as a series of interrelated commits. We -have already seen that the `git-log` command can list those commits. +have already seen that the 'git-log' command can list those commits. Note that first line of each git log entry also gives a name for the commit: @@ -411,7 +411,7 @@ Date: Tue May 16 17:18:22 2006 -0700 merge-base: Clarify the comments on post processing. ------------------------------------- -We can give this name to `git-show` to see the details about this +We can give this name to 'git-show' to see the details about this commit. ------------------------------------- @@ -469,13 +469,13 @@ $ git reset --hard HEAD^ # reset your current branch and working Be careful with that last command: in addition to losing any changes in the working directory, it will also remove all later commits from this branch. If this branch is the only branch containing those -commits, they will be lost. Also, don't use `git-reset` on a +commits, they will be lost. Also, don't use 'git-reset' on a publicly-visible branch that other developers pull from, as it will force needless merges on other developers to clean up the history. -If you need to undo changes that you have pushed, use `git-revert` +If you need to undo changes that you have pushed, use 'git-revert' instead. -The `git-grep` command can search for strings in any version of your +The 'git-grep' command can search for strings in any version of your project, so ------------------------------------- @@ -484,7 +484,7 @@ $ git grep "hello" v2.5 searches for all occurrences of "hello" in v2.5. -If you leave out the commit name, `git-grep` will search any of the +If you leave out the commit name, 'git-grep' will search any of the files it manages in your current directory. So ------------------------------------- @@ -494,7 +494,7 @@ $ git grep "hello" is a quick way to search just the files that are tracked by git. Many git commands also take sets of commits, which can be specified -in a number of ways. Here are some examples with `git-log`: +in a number of ways. Here are some examples with 'git-log': ------------------------------------- $ git log v2.5..v2.6 # commits between v2.5 and v2.6 @@ -504,7 +504,7 @@ $ git log v2.5.. Makefile # commits since v2.5 which modify # Makefile ------------------------------------- -You can also give `git-log` a "range" of commits where the first is not +You can also give 'git-log' a "range" of commits where the first is not necessarily an ancestor of the second; for example, if the tips of the branches "stable-release" and "master" diverged from a common commit some time ago, then @@ -523,9 +523,9 @@ $ git log experimental..stable will show the list of commits made on the stable branch but not the experimental branch. -The `git-log` command has a weakness: it must present commits in a +The 'git-log' command has a weakness: it must present commits in a list. When the history has lines of development that diverged and -then merged back together, the order in which `git-log` presents +then merged back together, the order in which 'git-log' presents those commits is meaningless. Most projects with multiple contributors (such as the linux kernel, @@ -549,7 +549,7 @@ of the file: $ git diff v2.5:Makefile HEAD:Makefile.in ------------------------------------- -You can also use `git-show` to see any such file: +You can also use 'git-show' to see any such file: ------------------------------------- $ git show v2.5:Makefile diff --git a/Documentation/i18n.txt b/Documentation/i18n.txt index 1e188e6e74..fb0d7da56b 100644 --- a/Documentation/i18n.txt +++ b/Documentation/i18n.txt @@ -21,7 +21,7 @@ project find it more convenient to use legacy encodings, git does not forbid it. However, there are a few things to keep in mind. -. `git-commit-tree` (hence, `git-commit` which uses it) issues +. 'git-commit-tree' (hence, 'git-commit' which uses it) issues a warning if the commit log message given to it does not look like a valid UTF-8 string, unless you explicitly say your project uses a legacy encoding. The way to say this is to @@ -37,7 +37,7 @@ of `i18n.commitencoding` in its `encoding` header. This is to help other people who look at them later. Lack of this header implies that the commit log message is encoded in UTF-8. -. `git-log`, `git-show` and friends looks at the `encoding` +. 'git-log', 'git-show' and friends looks at the `encoding` header of a commit object, and tries to re-code the log message into UTF-8 unless otherwise specified. You can specify the desired output encoding with diff --git a/Documentation/merge-options.txt b/Documentation/merge-options.txt index ffbc6e9861..007909a82f 100644 --- a/Documentation/merge-options.txt +++ b/Documentation/merge-options.txt @@ -56,5 +56,5 @@ Use the given merge strategy; can be supplied more than once to specify them in the order they should be tried. If there is no `-s` option, a built-in list of strategies - is used instead (`git-merge-recursive` when merging a single - head, `git-merge-octopus` otherwise). + is used instead ('git-merge-recursive' when merging a single + head, 'git-merge-octopus' otherwise). diff --git a/Documentation/pull-fetch-param.txt b/Documentation/pull-fetch-param.txt index cbee369947..00a8d21047 100644 --- a/Documentation/pull-fetch-param.txt +++ b/Documentation/pull-fetch-param.txt @@ -32,7 +32,7 @@ must know this is the expected usage pattern for a branch. [NOTE] You never do your own development on branches that appear on the right hand side of a <refspec> colon on `Pull:` lines; -they are to be updated by `git-fetch`. If you intend to do +they are to be updated by 'git-fetch'. If you intend to do development derived from a remote branch `B`, have a `Pull:` line to track it (i.e. `Pull: B:remote-B`), and have a separate branch `my-B` to do your development on top of it. The latter @@ -44,13 +44,13 @@ on the remote branch, merge it into your development branch with + [NOTE] There is a difference between listing multiple <refspec> -directly on `git-pull` command line and having multiple +directly on 'git-pull' command line and having multiple `Pull:` <refspec> lines for a <repository> and running -`git-pull` command without any explicit <refspec> parameters. +'git-pull' command without any explicit <refspec> parameters. <refspec> listed explicitly on the command line are always merged into the current branch after fetching. In other words, if you list more than one remote refs, you would be making -an Octopus. While `git-pull` run without any explicit <refspec> +an Octopus. While 'git-pull' run without any explicit <refspec> parameter takes default <refspec>s from `Pull:` lines, it merges only the first <refspec> found into the current branch, after fetching all the remote refs. This is because making an diff --git a/Documentation/urls-remotes.txt b/Documentation/urls-remotes.txt index 99753006e2..504ae8a53b 100644 --- a/Documentation/urls-remotes.txt +++ b/Documentation/urls-remotes.txt @@ -49,8 +49,8 @@ following format: ------------ -`Push:` lines are used by `git-push` and -`Pull:` lines are used by `git-pull` and `git-fetch`. +`Push:` lines are used by 'git-push' and +`Pull:` lines are used by 'git-pull' and 'git-fetch'. Multiple `Push:` and `Pull:` lines may be specified for additional branch mappings. |