diff options
103 files changed, 510 insertions, 509 deletions
diff --git a/Documentation/git-annotate.txt b/Documentation/git-annotate.txt index d05ec19..8b6b56a 100644 --- a/Documentation/git-annotate.txt +++ b/Documentation/git-annotate.txt @@ -7,7 +7,7 @@ git-annotate - Annotate file lines with commit info SYNOPSIS -------- -git annotate [options] file [revision] +'git annotate' [options] file [revision] DESCRIPTION ----------- diff --git a/Documentation/git-apply.txt b/Documentation/git-apply.txt index 138f735..70d19f6 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, linkgit:git-apply[1] 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, linkgit:git-apply[1] 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, linkgit:git-apply[1] 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. @@ -147,7 +147,7 @@ discouraged. considered whitespace errors. + By default, the command outputs warning messages but applies the patch. -When linkgit:git-apply[1] is used for statistics and not applying a +When `git-apply is used for statistics and not applying a patch, it defaults to `nowarn`. + You can use different `<action>` to control this @@ -191,7 +191,7 @@ apply.whitespace:: Submodules ---------- -If the patch contains any changes to submodules then linkgit:git-apply[1] +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 ffd01ae..f089deb 100644 --- a/Documentation/git-archimport.txt +++ b/Documentation/git-archimport.txt @@ -34,12 +34,12 @@ 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`. -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 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 1b0d782..dbe9bad 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 executable 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 fdb040b..8bbcb94 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' option 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. @@ -215,13 +215,13 @@ 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 tree to the pristine state. Finally the "run" script can exit with -the status of the real test to let "git bisect run" command loop to -know the outcome. +the status of the real test to let the "git bisect run" command loop to +determine the outcome. EXAMPLES -------- diff --git a/Documentation/git-blame.txt b/Documentation/git-blame.txt index 738249a..443039f 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 linkgit:git-diff[1] 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:: diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt index dce8c45..5e78aed 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 linkgit:git-pull[1] 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 linkgit:git-fetch[1] 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 9b1b13d..b729db7 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 linkgit:git-fetch[1] and linkgit:git-pull[1] +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,16 +51,15 @@ list-heads <file>:: printed out. unbundle <file>:: - Passes the objects in the bundle to linkgit:git-index-pack[1] + 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 - linkgit:git-fetch[1]. + 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 @@ -70,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 linkgit:git-fetch-pack[1]). + 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 12cdfcd..429083b 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 - linkgit:git-cat-file[1] "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 daa6aee..a833a4d 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 diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt index fd048ea..c0f9c6e 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 197ef94..1b864da 100644 --- a/Documentation/git-cherry-pick.txt +++ b/Documentation/git-cherry-pick.txt @@ -19,7 +19,7 @@ OPTIONS ------- <commit>:: Commit to cherry-pick. - For a more complete list of ways to spell commits, see + For a more complete list of ways to spell commits, see the "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1]. -e:: diff --git a/Documentation/git-cherry.txt b/Documentation/git-cherry.txt index d63d33b..9859bc8 100644 --- a/Documentation/git-cherry.txt +++ b/Documentation/git-cherry.txt @@ -13,8 +13,8 @@ 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 linkgit:git-patch-id[1] -program. +The commits are compared with their 'patch id', obtained from +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 09108d0..8e6c7e6 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 linkgit:git-commit[1] 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 f001f8f..8168bf3 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 linkgit:git-reset[1]) 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 852b478..eef95a4 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt @@ -68,10 +68,10 @@ 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[1]) -which automatically call git-gc[1]. If these objects are removed and -were referenced by the cloned repository, then the cloned repository -will become corrupt. +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 @@ 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 @@ 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 620c45f..9cd8d07 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 c351424..03594cd 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt @@ -20,11 +20,11 @@ commit along with a log message describing the changes you have made. The content to be added can be specified in several ways: -1. by using linkgit:git-add[1] 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 linkgit:git-rm[1] 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 @@ -41,13 +41,13 @@ The content to be added can be specified in several ways: by one which files should be part of the commit, before finalizing the operation. Currently, this is done by invoking `git-add --interactive`. -The linkgit:git-status[1] 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 found a mistake immediately after -that, you can recover from it with linkgit:git-reset[1]. +If you make a commit and then find a mistake immediately after +that, you can recover from it with `git-reset`. OPTIONS @@ -205,7 +205,7 @@ 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 linkgit:git-add[1]. 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 @@ -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 either linkgit:git-merge[1] or -linkgit:git-pull[1]) stops because of conflicts, cleanly merged +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 linkgit:git-status[1] +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 linkgit:git-add[1]: +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 d0a0d30..63ddb2c 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 614c2e5..2a02ffa 100644 --- a/Documentation/git-cvsexportcommit.txt +++ b/Documentation/git-cvsexportcommit.txt @@ -8,7 +8,8 @@ git-cvsexportcommit - Export a single commit to a CVS checkout SYNOPSIS -------- -'git cvsexportcommit' [-h] [-u] [-v] [-c] [-P] [-p] [-a] [-d cvsroot] [-w cvsworkdir] [-W] [-f] [-m msgprefix] [PARENTCOMMIT] COMMITID +'git cvsexportcommit' [-h] [-u] [-v] [-c] [-P] [-p] [-a] [-d cvsroot] + [-w cvsworkdir] [-W] [-f] [-m msgprefix] [PARENTCOMMIT] COMMITID DESCRIPTION @@ -26,8 +27,8 @@ 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 parent -should the changeset be done against. +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 7890851..ed79bb8 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 -linkgit:git-cvsexportcommit[1]. +`git-cvsexportcommit`. -h:: Print a short usage message and exit. diff --git a/Documentation/git-cvsserver.txt b/Documentation/git-cvsserver.txt index 2401516..e0e35db 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 @@ git-cvsserver and pretends that the other end runs the real cvs better. 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 +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 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 --------------------- @@ -328,14 +328,13 @@ is left blank. But if `gitcvs.allbinary` is set to "guess", then the correct '-k' mode will be guessed based on the contents of the file. -For best consistency with cvs, it is probably best to override the +For best consistency with `cvs`, it is probably best to override the defaults by setting `gitcvs.usecrlfattr` to true, 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 266458b..3cf2d3b 100644 --- a/Documentation/git-daemon.txt +++ b/Documentation/git-daemon.txt @@ -9,11 +9,11 @@ SYNOPSIS -------- [verse] 'git daemon' [--verbose] [--syslog] [--export-all] - [--timeout=n] [--init-timeout=n] [--strict-paths] - [--base-path=path] [--user-path | --user-path=path] - [--interpolated-path=pathtemplate] - [--reuseaddr] [--detach] [--pid-file=file] - [--enable=service] [--disable=service] + [--timeout=n] [--init-timeout=n] [--strict-paths] + [--base-path=path] [--user-path | --user-path=path] + [--interpolated-path=pathtemplate] + [--reuseaddr] [--detach] [--pid-file=file] + [--enable=service] [--disable=service] [--allow-override=service] [--forbid-override=service] [--inetd | [--listen=host_or_ipaddr] [--port=n] [--user=user [--group=group]] [directory...] @@ -27,7 +27,7 @@ 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 @@ -44,12 +44,12 @@ 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 as '/srv/git/hello.git'. @@ -199,7 +199,7 @@ $ grep 9418 /etc/services git 9418/tcp # Git Version Control System ------------ -git-daemon as inetd server:: +`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 @@ -212,7 +212,7 @@ git-daemon as inetd server:: ------------------------------------------------ -git-daemon as inetd server for virtual hosts:: +`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 @@ -235,7 +235,7 @@ clients, a symlink from `/software` into the appropriate default repository could be made as well. -git-daemon as regular daemon for virtual hosts:: +`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: diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt index b6c86c2..51a0cc0 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. @@ -129,7 +129,7 @@ abbreviation of the input committish's SHA1. If multiple tags were found during the walk then the tag which has the fewest commits different from the input committish will be selected and output. Here fewest commits different is defined as -the number of commits which would be shown by "git log tag..input" +the number of commits which would be shown by `git log tag..input` will be the smallest number of commits possible. diff --git a/Documentation/git-diff-files.txt b/Documentation/git-diff-files.txt index 378f349..6c65757 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 "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 2474745..784bbf3 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 with a "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 @@ -60,9 +60,9 @@ object and compare it that way, and to do that, you just do git diff-index --cached HEAD Example: let's say I had renamed `commit.c` to `git-commit.c`, and I had -done an "git-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: +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: torvalds@ppc970:~/git> git diff-index --cached HEAD -100644 blob 4161aecc6700a2eb579e842af0b7f22b98443f74 commit.c @@ -70,11 +70,11 @@ 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 +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 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 7d41a0f..68feb08 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 b21cd77..dbc2b19 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 linkgit:git-fast-import[1]. +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 -linkgit:git-filter-branch[1]. +`git-filter-branch`. OPTIONS ------- --progress=<n>:: Insert 'progress' statements every <n> objects, to be shown by - linkgit:git-fast-import[1] 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 linkgit:git-fast-import[1] 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 8881686..70cc8e8 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 linkgit:git-init[1]) 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 linkgit:git-pack-objects[1]. + to `git-pack-objects`. --quiet:: Disable all non-fatal output, making fast-import silent when it @@ -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 linkgit:git-am[1] 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 -linkgit:git-update-index[1]. +`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 linkgit:git-tag[1] 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 linkgit:git-blame[1] 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 linkgit:git-repack[1]. +\--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 ff328ab..a069f8d 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 linkgit:git-fetch[1] which is a -higher level wrapper of this command instead. +Usually you would want to use `git-fetch`, which is a +higher level wrapper of this command, instead. -Invokes 'git-upload-pack' on a potentially 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 e4b5297..b225566 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 924afb2..a9388e0 100644 --- a/Documentation/git-filter-branch.txt +++ b/Documentation/git-filter-branch.txt @@ -95,7 +95,7 @@ OPTIONS This is the filter for rewriting the commit's parent list. It will receive the parent string on stdin and shall output the new parent string on stdout. The parent string is in - a format accepted by linkgit:git-commit-tree[1]: empty for + the format described in linkgit:git-commit-tree[1]: empty for the initial commit, "-p parent" for a normal commit and "-p parent1 -p parent2 -p parent3 ..." for a merge commit. @@ -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 - linkgit:git-commit-tree[1] 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 linkgit:git-rebase[1] instead). +that, use `git-rebase` instead). --tag-name-filter <command>:: This is the filter for rewriting tag names. When passed, @@ -169,7 +169,7 @@ to other tags will be rewritten to point to the underlying commit. <rev-list-options>:: When options are given after the new branch name, they will - be passed to linkgit:git-rev-list[1]. 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. @@ -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 linkgit:git-rebase[1]. +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 46d4a4a..ddb89f8 100644 --- a/Documentation/git-fmt-merge-msg.txt +++ b/Documentation/git-fmt-merge-msg.txt @@ -9,8 +9,8 @@ git-fmt-merge-msg - Produce a merge commit message SYNOPSIS -------- [verse] -git fmt-merge-msg [--log | --no-log] <$GIT_DIR/FETCH_HEAD -git fmt-merge-msg [--log | --no-log] -F <file> +'git fmt-merge-msg' [--log | --no-log] <$GIT_DIR/FETCH_HEAD +'git fmt-merge-msg' [--log | --no-log] -F <file> DESCRIPTION ----------- diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt index ce1af82..894b82d 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 linkgit:git-am[1]. +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. diff --git a/Documentation/git-fsck.txt b/Documentation/git-fsck.txt index c26b40a..ef4ceb3 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,11 +83,11 @@ 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 -(i.e., you can just remove them and do an "rsync" with some other site in +(i.e., you can just remove them and do an `rsync` with some other site in the hopes that somebody else has the object you have corrupted). Of course, "valid tree" doesn't mean that it wasn't generated by some diff --git a/Documentation/git-gc.txt b/Documentation/git-gc.txt index 587ce14..0cce389 100644 --- a/Documentation/git-gc.txt +++ b/Documentation/git-gc.txt @@ -15,7 +15,7 @@ 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 linkgit:git-add[1]. +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 @@ -33,9 +33,9 @@ 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. @@ -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 linkgit:git-filter-branch[1] 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 5a047b0..50dfdfa 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 -linkgit:git-archive[1]. 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 cbda116..25cb649 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 105397f..940e43f 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 linkgit:gitk[1], 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. +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`. -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 ca232e0..05550c5 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 faecd6b..5ace863 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 e7c7961..cfc5989 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 27d3de9..776aa25 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 9020561..1940237 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 - linkgit:git-repack[1]. + `git-repack`. --fix-thin:: - It is possible for linkgit:git-pack-objects[1] 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 linkgit:git-repack[1] 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 linkgit:git-repack[1] +.keep file used as a lock to prevent the race with `git-repack` mentioned above. diff --git a/Documentation/git-instaweb.txt b/Documentation/git-instaweb.txt index 522a58d..e7ca537 100644 --- a/Documentation/git-instaweb.txt +++ b/Documentation/git-instaweb.txt @@ -14,7 +14,7 @@ SYNOPSIS DESCRIPTION ----------- -A simple script to setup gitweb and a web server for browsing the local +A simple script to set up `gitweb` and a web server for browsing the local repository. OPTIONS @@ -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 cf1ab7b..3373c26 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 linkgit:git-rev-list[1] +The command takes options applicable to the `git-rev-list` command to control what is shown and how, and options applicable to -the linkgit:git-diff-tree[1] 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 adcec3c..a6883bf 100644 --- a/Documentation/git-ls-files.txt +++ b/Documentation/git-ls-files.txt @@ -143,14 +143,14 @@ 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, the index records up to three such pairs; one from tree O in stage 1, A in stage 2, and B in stage 3. This information can be used by the user (or the porcelain) to see what should eventually be recorded at the -path. (see git-read-tree for more information on state) +path. (see linkgit:git-read-tree[1] for more information on state) When `-z` option is not used, TAB, LF, and backslash characters in pathnames are represented as `\t`, `\n`, and `\\`, @@ -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 061909d..c267cda 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 linkgit:git-upload-pack[1] 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 87cfa45..6ebdeee 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 9105735..41fb0c7 100644 --- a/Documentation/git-merge-base.txt +++ b/Documentation/git-merge-base.txt @@ -13,15 +13,15 @@ SYNOPSIS DESCRIPTION ----------- -"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 +`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. 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 2a683f1..f057e49 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 fb55e92..4368084 100644 --- a/Documentation/git-merge-index.txt +++ b/Documentation/git-merge-index.txt @@ -36,20 +36,20 @@ 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 -RCS "merge" program merge object order. In the above ordering, the +RCS `merge` program merge object order. In the above ordering, the original is first. But the argument order to the 3-way merge program -"merge" is to have the original in the middle. Don't ask me why. +`merge` is to have the original in the middle. Don't ask me why. Examples: @@ -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 -merge once anything has returned an error (i.e., "cat" returned an error +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 5c9ce64..62e09af 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 7e328ea..e6fa2b9 100644 --- a/Documentation/git-merge.txt +++ b/Documentation/git-merge.txt @@ -41,8 +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 -linkgit:git-reset[1]. +would want to start over, you can recover with `git-reset`. CONFIGURATION ------------- @@ -50,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 @@ -145,7 +144,7 @@ After seeing a conflict, you can do two things: be used for this. * Resolve the conflicts. `git diff` would report only the - conflicting paths because of the above 2. and 3.. Edit the + conflicting paths because of the above 2. and 3. Edit the 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. @@ -154,8 +153,11 @@ After seeing a conflict, you can do two things: SEE ALSO -------- linkgit:git-fmt-merge-msg[1], linkgit:git-pull[1], -linkgit:gitattributes[5] - +linkgit:gitattributes[5], +linkgit:git-reset[1], +linkgit:git-diff[1], linkgit:git-ls-files[1], +linkgit:git-add[1], linkgit:git-rm[1], +linkgit:git-mergetool[1] Author ------ diff --git a/Documentation/git-mergetool.txt b/Documentation/git-mergetool.txt index fc1b030..fedcfa0 100644 --- a/Documentation/git-mergetool.txt +++ b/Documentation/git-mergetool.txt @@ -13,7 +13,7 @@ DESCRIPTION ----------- Use `git mergetool` to run one of several merge utilities to resolve -merge conflicts. It is typically run after linkgit:git-merge[1]. +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 diff --git a/Documentation/git-name-rev.txt b/Documentation/git-name-rev.txt index b2d40a7..00b1fa4 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 linkgit:git-describe[1] 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 c4ac3a7..d9cd16a 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. -'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 linkgit:git-rev-list[1] with `--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. @@ -163,14 +163,14 @@ base-name:: generated pack. If not specified, pack compression level is determined first by pack.compression, then by core.compression, and defaults to -1, the zlib default, if neither is set. - Add \--no-reuse-object if you want to force a uniform compression + Add --no-reuse-object if you want to force a uniform compression level on all data no matter the source. --delta-base-offset:: 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 95bf399..80fc1ba 100644 --- a/Documentation/git-pack-redundant.txt +++ b/Documentation/git-pack-redundant.txt @@ -14,9 +14,9 @@ DESCRIPTION ----------- 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. +`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-patch-id.txt b/Documentation/git-patch-id.txt index c9970f5..17c178f 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 05027d2..c3ed4a1 100644 --- a/Documentation/git-peek-remote.txt +++ b/Documentation/git-peek-remote.txt @@ -17,7 +17,7 @@ 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 1093000..a4a0d56 100644 --- a/Documentation/git-prune.txt +++ b/Documentation/git-prune.txt @@ -13,8 +13,8 @@ SYNOPSIS DESCRIPTION ----------- -NOTE: In most cases, users should run linkgit:git-gc[1], 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 available in `$GIT_DIR/refs`, optionally with additional set of @@ -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 linkgit:git-gc[1], 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 99eb7ed..d9537eb 100644 --- a/Documentation/git-pull.txt +++ b/Documentation/git-pull.txt @@ -182,8 +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 -linkgit:git-reset[1]. +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 1763791..1f70e72 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. diff --git a/Documentation/git-read-tree.txt b/Documentation/git-read-tree.txt index 1a57f58..0c7cc6b 100644 --- a/Documentation/git-read-tree.txt +++ b/Documentation/git-read-tree.txt @@ -121,7 +121,7 @@ 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 @@ -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 @@ -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 @@ -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,7 +334,7 @@ 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 diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt index 2753f74..754230e 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 @@ -364,34 +364,34 @@ 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: -- Start an interactive rebase with 'git rebase -i <commit>^', where +- Start an interactive rebase with `git rebase -i <commit>^`, where <commit> is the commit you want to split. In fact, any commit range will do, as long as it contains that commit. - Mark the commit you want to split with the action "edit". -- When it comes to editing that commit, execute 'git reset HEAD^'. The +- When it comes to editing that commit, execute `git reset HEAD^`. The effect is that the HEAD is rewound by one, and the index follows suit. However, the working tree stays the same. - Now add the changes to the index that you want to have in the first - commit. You can use linkgit:git-add[1] (possibly interactively) and/or - linkgit:git-gui[1] to do that. + commit. You can use `git add` (possibly interactively) or + `git-gui` (or both) to do that. - Commit the now-current index with whatever commit message is appropriate now. - Repeat the last two steps until your working tree is clean. -- Continue the rebase with 'git rebase --continue'. +- Continue the rebase with `git rebase --continue`. If you are not absolutely sure that the intermediate revisions are consistent (they compile, pass the testsuite, etc.) you should use -linkgit:git-stash[1] 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 8c69629..207684d 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 'git-fetch-pack'. +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 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 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,10 +137,10 @@ 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" +This hook can be used, for example, to run `git update-server-info` if the repository is packed and is served via a dumb transport. #!/bin/sh diff --git a/Documentation/git-repack.txt b/Documentation/git-repack.txt index 6bc5975..0d72e83 100644 --- a/Documentation/git-repack.txt +++ b/Documentation/git-repack.txt @@ -47,23 +47,24 @@ 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 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 runs linkgit:git-prune-packed[1]. + 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:: diff --git a/Documentation/git-rerere.txt b/Documentation/git-rerere.txt index d712f62..3458029 100644 --- a/Documentation/git-rerere.txt +++ b/Documentation/git-rerere.txt @@ -30,22 +30,22 @@ 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 linkgit:git-am[1] --skip or linkgit:git-rebase[1] -[--skip|--abort] will automatically invoke this command. +is aborted. Calling `git-am --skip` or `git-rebase [--skip|--abort]` +will automatically invoke this command. 'diff':: This displays diffs for the current state of the resolution. It is useful for tracking what has changed while the user is resolving conflicts. Additional arguments are passed directly to the system -diff(1) command installed in PATH. +`diff` command installed in PATH. 'status':: @@ -146,7 +146,7 @@ blew away. `git-rerere` command helps you to resolve this final conflicted merge using the information from your earlier hand resolve. -Running `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, diff --git a/Documentation/git-reset.txt b/Documentation/git-reset.txt index 12ea9b2..dc05f58 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 linkgit:git-status[1] 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 61ec6dc..e7d736f 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 ----------------------------------------------------------------------- -linkgit:git-rev-list[1] 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 linkgit:git-bisect[1] and -linkgit:git-repack[1]. +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 e9fb2b1..6825ae2 100644 --- a/Documentation/git-rev-parse.txt +++ b/Documentation/git-rev-parse.txt @@ -15,8 +15,8 @@ DESCRIPTION Many git porcelainish commands take mixture of flags (i.e. parameters that begin with a dash '-') and parameters -meant for underlying `git-rev-list` command they use internally -and flags and parameters for other commands they use as the +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 distinguish between them. @@ -128,13 +128,13 @@ OPTIONS --since=datestring:: --after=datestring:: - Parses the date string, and outputs corresponding - --max-age= parameter for git-rev-list command. + Parse the date string, and output the corresponding + --max-age= parameter for `git-rev-list`. --until=datestring:: --before=datestring:: - Parses the date string, and outputs corresponding - --min-age= parameter for git-rev-list command. + Parse the date string, and output the corresponding + --min-age= parameter for `git-rev-list`. <args>...:: Flags and parameters to be parsed. diff --git a/Documentation/git-rm.txt b/Documentation/git-rm.txt index 41e00d9..01b63be 100644 --- a/Documentation/git-rm.txt +++ b/Documentation/git-rm.txt @@ -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 dba015f..410504d 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 linkgit:git-push[1] which is a -higher level wrapper of this command instead. +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,8 +86,8 @@ 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 linkgit:git-rev-parse[1] to resolve a symbolic ref -name. +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 local refs. diff --git a/Documentation/git-shell.txt b/Documentation/git-shell.txt index bd09196..9b2ae7f 100644 --- a/Documentation/git-shell.txt +++ b/Documentation/git-shell.txt @@ -8,7 +8,7 @@ git-shell - Restricted login shell for GIT-only SSH access SYNOPSIS -------- -'git-shell' -c <command> <argument> +'$(git --exec-path)/git-shell' -c <command> <argument> DESCRIPTION ----------- diff --git a/Documentation/git-shortlog.txt b/Documentation/git-shortlog.txt index b55301b..6e4cbc4 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 b9228dc..578bdb7 100644 --- a/Documentation/git-show-branch.txt +++ b/Documentation/git-show-branch.txt @@ -29,7 +29,7 @@ no <rev> nor <glob> is given on the command line. OPTIONS ------- <rev>:: - Arbitrary extended SHA1 expression (see `git-rev-parse`) + Arbitrary extended SHA1 expression (see linkgit:git-rev-parse[1]) that typically names a branch HEAD or a tag. <glob>:: @@ -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 4227cbb..4ae6ede 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 c1f03d4..a78a7dc 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, linkgit:git-show-ref[1] 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 44570d9..70b54ae 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 linkgit:git-ls-tree[1] +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 linkgit:git-diff-tree[1] 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 f994679..23ac331 100644 --- a/Documentation/git-stash.txt +++ b/Documentation/git-stash.txt @@ -20,10 +20,10 @@ working directory. The command saves your local modifications away and reverts the working directory to match the `HEAD` commit. The modifications stashed away by this command can be listed with -`git-stash list`, inspected with `git-stash show`, and restored -(potentially on top of a different commit) with `git-stash apply`. -Calling git stash without any arguments is equivalent to `git stash -save`. A stash is by default listed as "WIP on 'branchname' ...", but +`git stash list`, inspected with `git stash show`, and restored +(potentially on top of a different commit) with `git stash apply`. +Calling `git stash` without any arguments is equivalent to `git stash save`. +A stash is by default listed as "WIP on 'branchname' ...", but you can give a more descriptive message on the command line when you create one. @@ -56,8 +56,8 @@ 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 linkgit:git-log[1] -command to control what is shown and how. +The command takes options applicable to the `git-log` +command to control what is shown and how. See linkgit:git-log[1]. show [<stash>]:: diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt index c1deec9..9c4052c 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 linkgit:git-describe[1] 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 6ddfed3..6caa130 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' -accepts. However '--fetch-all' only fetches from the current +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 - init-ed repository. This command takes three arguments, (a) the + `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 linkgit:git-init[1]. + 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 linkgit:git-repack[1]. +--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:: @@ -411,20 +411,20 @@ CONFIG FILE-ONLY OPTIONS svn.noMetadata:: svn-remote.<name>.noMetadata:: -This gets rid of the git-svn-id: lines at the end of every commit. +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,22 +524,22 @@ 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. +`git svn set-tree B` to commit a single head rather than the +`git svn set-tree A..B` notation to commit multiple commits. -If you use 'git svn set-tree A..B' to commit several diffs and you do +If you use `git svn set-tree A..B` to commit several diffs and you do not have the latest remotes/git-svn merged into my-branch, you should -use 'git svn rebase' to update your work branch instead of 'git pull' or -'git merge'. 'pull/merge' can cause non-linear history to be flattened +use `git svn rebase` to update your work branch instead of `git pull` or +`git merge`. `pull`/`merge' can cause non-linear history to be flattened when committing into SVN, which can lead to merge commits reversing 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,30 +550,30 @@ 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 dcommiting 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 -plan to dcommit from. Subversion does not represent merges in any +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 +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(1) 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 -before dcommit on will require forcing an overwrite of the existing ref +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 git-push(1) documentation for details. +see the linkgit:git-push[1] documentation for details. -Do not use the --amend option of git-commit(1) on a change you've +Do not use the --amend option of linkgit:git-commit[1] on a change you've already dcommitted. It is considered bad practice to --amend commits you've already pushed to a remote repository for other users, and dcommit with SVN is analogous to that. @@ -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,8 +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 -linkgit:git-config[1] +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 243e26e..a496241 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 9553134..1db98e2 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 "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 4995dc2..b3097aa 100644 --- a/Documentation/git-tar-tree.txt +++ b/Documentation/git-tar-tree.txt @@ -19,12 +19,12 @@ 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-unpack-objects.txt b/Documentation/git-unpack-objects.txt index ae17cc2..36d1038 100644 --- a/Documentation/git-unpack-objects.txt +++ b/Documentation/git-unpack-objects.txt @@ -21,7 +21,7 @@ Objects that already exist in the repository will *not* be unpacked from the pack-file. Therefore, nothing will be unpacked if you use this command on a pack-file that exists within the target repository. -Please see the `git-repack` documentation for options to generate +See linkgit:git-repack[1] for options to generate new packs and replace existing ones. OPTIONS diff --git a/Documentation/git-update-index.txt b/Documentation/git-update-index.txt index 5295702..999e9a7 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:: @@ -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 diff --git a/Documentation/git-upload-archive.txt b/Documentation/git-upload-archive.txt index bbd7617..526e5bd 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 b8e49dc..52724d4 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-verify-pack.txt b/Documentation/git-verify-pack.txt index 8536a18..4d95c6c 100644 --- a/Documentation/git-verify-pack.txt +++ b/Documentation/git-verify-pack.txt @@ -13,8 +13,8 @@ SYNOPSIS DESCRIPTION ----------- -Reads given idx file for packed git archive created with -git-pack-objects command and verifies idx file and the +Reads given idx file for packed git archive created with 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 2231f6d..de4a89a 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 c2cd216..fefa6fd 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 d7fad15..3b0ea2c 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.txt b/Documentation/git.txt index 1978e1b..bb33c40 100644 --- a/Documentation/git.txt +++ b/Documentation/git.txt @@ -483,10 +483,10 @@ other a pager. 'GIT_SSH':: - If this environment variable is set then linkgit:git-fetch[1] - and linkgit:git-push[1] 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 '$GIT_SSH' command will be given exactly two arguments: the 'username@host' (or just 'host') from the URL and the shell command to execute on that remote system. + @@ -500,8 +500,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, - git-whatchanged, etc., 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 e96d3cd..124170a 100644 --- a/Documentation/gitattributes.txt +++ b/Documentation/gitattributes.txt @@ -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. @@ -513,8 +513,8 @@ 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 -linkgit:git-archive[1] has been given a tree instead of a commit or a +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 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 ce197d5..7d721c5 100644 --- a/Documentation/gitcore-tutorial.txt +++ b/Documentation/gitcore-tutorial.txt @@ -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: ------------ @@ -284,7 +284,7 @@ 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`. -There are no options or other input: git write-tree will take the +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 filenames with their contents (and their permissions), and we're @@ -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 @@ -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 @@ -963,18 +963,18 @@ commits from the master branch. The string inside brackets before the commit log message is a short name you can use to name the commit. In the above example, 'master' and 'mybranch' are branch heads. 'master^' is the first parent of 'master' -branch head. Please see 'git-rev-parse' documentation if you +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 'git-show-branch' -documentation for details. +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. diff --git a/Documentation/gitcvs-migration.txt b/Documentation/gitcvs-migration.txt index 518d5d6..4dc7ec5 100644 --- a/Documentation/gitcvs-migration.txt +++ b/Documentation/gitcvs-migration.txt @@ -53,7 +53,7 @@ page for details. ================================ You can update the shared repository with your changes by first committing -your changes, and then using the linkgit:git-push[1] command: +your changes, and then using the `git-push` command: ------------------------------------------------ $ git push origin master @@ -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 linkgit:git-cvsimport[1]: +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 8f473d8..0b7daed 100644 --- a/Documentation/gitdiffcore.txt +++ b/Documentation/gitdiffcore.txt @@ -12,9 +12,9 @@ git diff * 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(1) output. The manipulation +unconventional ways before showing `diff` output. The manipulation is collectively called "diffcore transformation". This short note describes what they are and how to use them to produce diff outputs that are easier to understand than the conventional kind. @@ -23,18 +23,18 @@ that are easier to understand than the conventional kind. The chain of operation ---------------------- -The git-diff-* 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-\* +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-\* 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-* 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: @@ -84,11 +84,11 @@ of filepairs included: :100644 100644 bcd1234... 0123456... M junkfile ------------------------------------------------ -but the command invocation was "git diff-files myfile", then the +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-* 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-* 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-\* 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-\* 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-* +-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-* 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/gitignore.txt b/Documentation/gitignore.txt index 812ae83..cafdac7 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 -linkgit:git-ls-files[1] and linkgit:git-read-tree[1], 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 linkgit:git-status[1] and linkgit:git-add[1], +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 f843f39..03688bf 100644 --- a/Documentation/gitk.txt +++ b/Documentation/gitk.txt @@ -22,7 +22,8 @@ git repository. OPTIONS ------- To control which revisions to shown, the command takes options applicable to -the linkgit:git-rev-list[1] command. This manual page describes only the most +the `git-rev-list` command (see linkgit:git-rev-list[1]). +This manual page describes only the most frequently used options. -n <number>:: diff --git a/Documentation/gitrepository-layout.txt b/Documentation/gitrepository-layout.txt index e6b30ca..ade812e 100644 --- a/Documentation/gitrepository-layout.txt +++ b/Documentation/gitrepository-layout.txt @@ -178,7 +178,7 @@ remotes:: logs:: Records of changes made to refs are stored in this - directory. See the documentation on git-update-ref + directory. See linkgit:git-update-ref[1] for more information. logs/refs/heads/`name`:: diff --git a/Documentation/gittutorial-2.txt b/Documentation/gittutorial-2.txt index f2624aa..6c93445 100644 --- a/Documentation/gittutorial-2.txt +++ b/Documentation/gittutorial-2.txt @@ -54,7 +54,7 @@ following the example above generates a different SHA1 hash than the one shown above because the commit object records the time when it was created and the name of the person performing the commit. -We can ask git about this particular object with the cat-file +We can ask git about this particular object with the `cat-file` command. Don't copy the 40 hex digits from this example but use those from your own version. Note that you can shorten it to only a few characters to save yourself typing all 40 hex digits: @@ -212,8 +212,8 @@ designate such an argument. The index file -------------- -The primary tool we've been using to create commits is "git-commit --a", which creates a commit including every change you've made to +The primary tool we've been using to create commits is `git-commit +-a`, which creates a commit including every change you've made to your working tree. But what if you want to commit changes only to certain files? Or only certain changes to certain files? @@ -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,8 +311,8 @@ index a042389..513feba 100644 +hello world, again ------------------------------------------------ -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 +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 -the working tree; the -a option to commit tells it to first update +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 @@ -382,7 +382,7 @@ it is marked "changed but not updated". At this point, running "git commit" would create a commit that added closing.txt (with its new contents), but that didn't modify file.txt. -Also, note that a bare "git diff" shows the changes to file.txt, but +Also, note that a bare `git diff` shows the changes to file.txt, but not the addition of closing.txt, because the version of closing.txt in the index file is identical to the one in the working directory. diff --git a/Documentation/gittutorial.txt b/Documentation/gittutorial.txt index 87e6037..036a27c 100644 --- a/Documentation/gittutorial.txt +++ b/Documentation/gittutorial.txt @@ -20,7 +20,7 @@ for example, to test the latest version, you may prefer to start with the first two chapters of link:user-manual.html[The Git User's Manual]. First, note that you can get documentation for a command such as -"git log --graph" with: +`git log --graph` with: ------------------------------------------------ $ man git-log @@ -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 linkgit:git-add[1]: +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 linkgit:git-commit[1]: +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 linkgit:git-diff[1] with the --cached option: +using `git-diff` with the --cached option: ------------------------------------------------ $ git diff --cached ------------------------------------------------ -(Without --cached, linkgit:git-diff[1] 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 linkgit:git-status[1]: +summary of the situation with `git-status`: ------------------------------------------------ $ git status @@ -136,8 +136,8 @@ commit in the body. 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 +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 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 @@ -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: ------------------------------------- @@ -368,8 +368,8 @@ $ git config --get remote.origin.url /home/alice/project ------------------------------------- -(The complete configuration created by git-clone is visible using -"git config -l", and the linkgit:git-config[1] man page +(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.) Git also keeps a pristine copy of Alice's master branch under the @@ -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 linkgit:git-revert[1] +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,13 +523,13 @@ $ 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, -or git itself) have frequent merges, and gitk does a better job of +or git itself) have frequent merges, and `gitk` does a better job of visualizing their history. For example, ------------------------------------- @@ -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 |