diff options
Diffstat (limited to 'Documentation')
163 files changed, 1477 insertions, 1076 deletions
diff --git a/Documentation/.gitattributes b/Documentation/.gitattributes new file mode 100644 index 0000000..ddb0301 --- /dev/null +++ b/Documentation/.gitattributes @@ -0,0 +1 @@ +*.txt whitespace diff --git a/Documentation/Makefile b/Documentation/Makefile index c4486d3..43781fb 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -23,7 +23,7 @@ ARTICLES += everyday ARTICLES += git-tools ARTICLES += glossary # with their own formatting rules. -SP_ARTICLES = howto/revert-branch-rebase user-manual +SP_ARTICLES = howto/revert-branch-rebase howto/using-merge-subtree user-manual API_DOCS = $(patsubst %.txt,%,$(filter-out technical/api-index-skel.txt technical/api-index.txt, $(wildcard technical/api-*.txt))) SP_ARTICLES += $(API_DOCS) SP_ARTICLES += technical/api-index @@ -45,6 +45,7 @@ man7dir=$(mandir)/man7 ASCIIDOC=asciidoc ASCIIDOC_EXTRA = +MANPAGE_XSL = callouts.xsl INSTALL?=install RM ?= rm -f DOC_REF = origin/man @@ -65,6 +66,7 @@ ASCIIDOC_EXTRA += -a asciidoc7compatible endif ifdef DOCBOOK_XSL_172 ASCIIDOC_EXTRA += -a docbook-xsl-172 +MANPAGE_XSL = manpage-1.72.xsl endif # @@ -145,7 +147,8 @@ cmd-list.made: cmd-list.perl ../command-list.txt $(MAN1_TXT) git.7 git.html: git.txt clean: - $(RM) *.xml *.xml+ *.html *.html+ *.1 *.5 *.7 *.texi *.texi+ git.info + $(RM) *.xml *.xml+ *.html *.html+ *.1 *.5 *.7 + $(RM) *.texi *.texi+ git.info gitman.info $(RM) howto-index.txt howto/*.html doc.dep $(RM) technical/api-*.html technical/api-index.txt $(RM) $(cmds_txt) *.made @@ -158,7 +161,7 @@ $(MAN_HTML): %.html : %.txt %.1 %.5 %.7 : %.xml $(RM) $@ - xmlto -m callouts.xsl man $< + xmlto -m $(MANPAGE_XSL) man $< %.xml : %.txt $(RM) $@+ $@ @@ -224,6 +227,6 @@ install-webdoc : html sh ./install-webdoc.sh $(WEBDOC_DEST) quick-install: - sh ./install-doc-quick.sh $(DOC_REF) $(mandir) + sh ./install-doc-quick.sh $(DOC_REF) $(DESTDIR)$(mandir) .PHONY: .FORCE-GIT-VERSION-FILE diff --git a/Documentation/RelNotes-1.5.3.3.txt b/Documentation/RelNotes-1.5.3.3.txt index 2a7bfdd..d213846 100644 --- a/Documentation/RelNotes-1.5.3.3.txt +++ b/Documentation/RelNotes-1.5.3.3.txt @@ -12,7 +12,7 @@ Fixes since v1.5.3.2 * The default shell on some FreeBSD did not execute the argument parsing code correctly and made git unusable. - * git-svn incorrectly spawned pager even when the user user + * git-svn incorrectly spawned pager even when the user explicitly asked not to. * sample post-receive hook overquoted the envelope sender diff --git a/Documentation/RelNotes-1.5.3.8.txt b/Documentation/RelNotes-1.5.3.8.txt new file mode 100644 index 0000000..0e3ff58 --- /dev/null +++ b/Documentation/RelNotes-1.5.3.8.txt @@ -0,0 +1,25 @@ +GIT v1.5.3.8 Release Notes +========================== + +Fixes since v1.5.3.7 +-------------------- + + * Some documentation used "email.com" as an example domain. + + * git-svn fix to handle funky branch and project names going over + http/https correctly. + + * git-svn fix to tone down a needlessly alarming warning message. + + * git-clone did not correctly report errors while fetching over http. + + * git-send-email added redundant Message-Id: header to the outgoing + e-mail when the patch text already had one. + + * a read-beyond-end-of-buffer bug in configuration file updater was fixed. + + * git-grep used to show the same hit repeatedly for unmerged paths. + + * After amending the patch title in "git-am -i", the command did not + report the patch it applied with the updated title. + diff --git a/Documentation/RelNotes-1.5.4.txt b/Documentation/RelNotes-1.5.4.txt index 528b26f..f1323b6 100644 --- a/Documentation/RelNotes-1.5.4.txt +++ b/Documentation/RelNotes-1.5.4.txt @@ -11,18 +11,31 @@ Removal helper script lost all its users and has been removed. +Temporarily disabled +-------------------- + + * "git http-push" is known not to work well with cURL library older + than 7.16, and we had reports of repository corruption. It is + disabled on such platforms for now. Unfortunately, 1.5.3.8 shares + the same issue. In other words, this does not mean you will be + fine if you stick to an older git release. For now, please do not + use http-push from older git with cURL older than 7.16 if you + value your data. A proper fix will hopefully materialize in + later versions. + + Deprecation notices ------------------- - * The next feature release of git (this change is scheduled for v1.6.0) - will by default install dashed form of commands (e.g. "git-commit") - outside of users' normal $PATH, and will install only selected - commands ("git" itself, and "gitk") in $PATH. This implies: + * From v1.6.0, git will by default install dashed form of commands + (e.g. "git-commit") outside of users' normal $PATH, and will install + only selected commands ("git" itself, and "gitk") in $PATH. This + implies: - Using dashed forms of git commands (e.g. "git-commit") from the command line has been informally deprecated since early 2006, but now it officially is, and will be removed in the future. Use - dashless forms (e.g. "git commit") instead. + dash-less forms (e.g. "git commit") instead. - Using dashed forms from your scripts, without first prepending the return value from "git --exec-path" to the scripts' PATH, has been @@ -31,8 +44,8 @@ Deprecation notices - Use of dashed forms with "PATH=$(git --exec-path):$PATH; export PATH" early in your script is not deprecated with this change. - Users are strongly encouraged to adjust their habits and scripts now - to prepare for this. + Users are strongly encouraged to adjust their habits and scripts now + to prepare for this change. * The post-receive hook was introduced in March 2007 to supersede the post-update hook, primarily to overcome the command line length @@ -46,6 +59,10 @@ Deprecation notices and works for all transports; "git peek-remote" will be removed in the future. + * "git repo-config" which was an old name for "git config" command + has been supported without being advertised for a long time. The + next feature release will remove it. + * From v1.6.0, the repack.usedeltabaseoffset config option will default to true, which will give denser packfiles (i.e. more efficient storage). The downside is that git older than version 1.4.4 will not be able @@ -61,9 +78,9 @@ Deprecation notices Updates since v1.5.3 -------------------- - * Comes with much improved gitk. + * Comes with much improved gitk, with i18n. - * Comes with "git gui" 0.9.1 with i18n. + * Comes with git-gui 0.9.2 with i18n. * gitk is now merged as a subdirectory of git.git project, in preparation for its i18n. @@ -91,6 +108,16 @@ Updates since v1.5.3 * "git diff" Porcelain now respects diff.external configuration, which is another way to specify GIT_EXTERNAL_DIFF. + * "git diff" can be told to use different prefixes other than + "a/" and "b/" e.g. "git diff --src-prefix=l/ --dst-prefix=k/". + + * "git diff" sometimes did not quote paths with funny + characters properly. + + * "git log" (and any revision traversal commands) misbehaved + when --diff-filter is given but was not asked to actually + produce diff. + * HTTP proxy can be specified per remote repository using remote.*.httpproxy configuration, or global http.proxy configuration variable. @@ -104,6 +131,9 @@ Updates since v1.5.3 * "git reset" is now built-in and its output can be squelched with -q. + * "git reset --hard" does not make any sense in a bare + repository, but did not error out; fixed. + * "git send-email" can optionally talk over ssmtp and use SMTP-AUTH. * "git rebase" learned --whitespace option. @@ -136,7 +166,7 @@ Updates since v1.5.3 command line in the generated log message, when told to cherry-pick a commit by naming a tag that points at it. It does not anymore. - * "git for-each-ref" learned %(xxxdate:<dateformat>) syntax to show the + * "git for-each-ref" learned %(xxxdate:<date-format>) syntax to show the various date fields in different formats. * "git gc --auto" is a low-impact way to automatically run a variant of @@ -191,7 +221,7 @@ Updates since v1.5.3 * "git pull --rebase" is a different way to integrate what you fetched into your current branch. - * "git fast-export" produces datastream that can be fed to fast-import + * "git fast-export" produces data-stream that can be fed to fast-import to reproduce the history recorded in a git repository. * "git add -i" takes pathspecs to limit the set of files to work on. @@ -199,7 +229,10 @@ Updates since v1.5.3 * "git add -p" is a short-hand to go directly to the selective patch subcommand in the interactive command loop and to exit when done. - * "git add -i" UI has been colorized. + * "git add -i" UI has been colorized. The interactive prompt + and menu can be colored by setting color.interactive + configuration. The diff output (including the hunk picker) + are colored with color.diff configuration. * "git commit --allow-empty" allows you to create a single-parent commit that records the same tree as its parent, overriding the usual @@ -208,12 +241,21 @@ Updates since v1.5.3 * "git commit --amend" can amend a merge that does not change the tree from its first parent. + * "git commit" used to unconditionally strip comment lines that + began with '#' and removed excess blank lines. This behavior has + been made configurable. + * "git commit" has been rewritten in C. * "git stash random-text" does not create a new stash anymore. It was a UI mistake. Use "git stash save random-text", or "git stash" (without extra args) for that. + * "git stash clear extra-text" does not clear the whole stash + anymore. It is tempting to expect "git stash clear stash@{2}" + to drop only a single named stash entry, and it is rude to + discard everything when that is asked (but not provided). + * "git prune --expire <time>" can exempt young loose objects from getting pruned. @@ -251,6 +293,9 @@ Updates since v1.5.3 reasonable usability fix and people's scripts shouldn't have been relying on the exact output from "git show" Porcelain anyway. + * "git cvsimport" did not notice errors from underlying "cvsps" + and produced a corrupt import silently. + * "git cvsexportcommit" learned -w option to specify and switch to the CVS working directory. @@ -282,7 +327,7 @@ Updates since v1.5.3 * "git status" from a subdirectory now shows relative paths, which makes copy-and-pasting for git-checkout/git-add/git-rm easier. The - traditional behaviour to show the full path relative to the top of + traditional behavior to show the full path relative to the top of the work tree can be had by setting status.relativepaths configuration variable to false. @@ -297,7 +342,7 @@ Updates since v1.5.3 * "git help" learned "-w" option to show documentation in browsers. - * In addition there are quite a few internal clean-ups. Notably + * In addition there are quite a few internal clean-ups. Notably: - many fork/exec have been replaced with run-command API, brought from the msysgit effort. @@ -306,6 +351,7 @@ Updates since v1.5.3 - enhancement and more use of the strbuf API. + * Makefile tweaks to support HP-UX is in. Fixes since v1.5.3 ------------------ @@ -319,14 +365,13 @@ series. * The way "git diff --check" behaves is much more consistent with the way "git apply --whitespace=warn" works. - * "git svn" talking with the SVN over http will correctly quote branch + * "git svn" talking with the SVN over HTTP will correctly quote branch and project names. * "git config" did not work correctly on platforms that define REG_NOMATCH to an even number. --- -exec >/var/tmp/1 -O=v1.5.4-rc0-85-gdbedf97 -echo O=`git describe refs/heads/master` -git shortlog --no-merges $O..refs/heads/master ^refs/heads/maint + * Recent versions of AsciiDoc 8 has a change to break our + documentation; a workaround has been implemented. + + * "git diff --color-words" colored context lines in a wrong color. diff --git a/Documentation/asciidoc.conf b/Documentation/asciidoc.conf index 99d8874..10c1a15 100644 --- a/Documentation/asciidoc.conf +++ b/Documentation/asciidoc.conf @@ -1,6 +1,6 @@ -## gitlink: macro +## linkgit: macro # -# Usage: gitlink:command[manpage-section] +# Usage: linkgit:command[manpage-section] # # Note, {0} is the manpage section, while {target} is the command. # @@ -15,7 +15,7 @@ endsb=] tilde=~ ifdef::backend-docbook[] -[gitlink-inlinemacro] +[linkgit-inlinemacro] {0%{target}} {0#<citerefentry>} {0#<refentrytitle>{target}</refentrytitle><manvolnum>{0}</manvolnum>} @@ -61,6 +61,6 @@ endif::backend-docbook[] endif::doctype-manpage[] ifdef::backend-xhtml11[] -[gitlink-inlinemacro] +[linkgit-inlinemacro] <a href="{target}.html">{target}{0?({0})}</a> endif::backend-xhtml11[] diff --git a/Documentation/blame-options.txt b/Documentation/blame-options.txt index 17379f0..c11bb7d 100644 --- a/Documentation/blame-options.txt +++ b/Documentation/blame-options.txt @@ -39,7 +39,7 @@ of lines before or after the line given by <start>. Show raw timestamp (Default: off). -S <revs-file>:: - Use revs from revs-file instead of calling gitlink:git-rev-list[1]. + Use revs from revs-file instead of calling linkgit:git-rev-list[1]. -p, --porcelain:: Show in a format designed for machine consumption. @@ -52,7 +52,7 @@ of lines before or after the line given by <start>. When <rev> is not specified, the command annotates the changes starting backwards from the working tree copy. This flag makes the command pretend as if the working - tree copy has the contents of he named file (specify + tree copy has the contents of the named file (specify `-` to make the command read from the standard input). -M|<num>|:: diff --git a/Documentation/cmd-list.perl b/Documentation/cmd-list.perl index c2d55cd..04f9977 100755 --- a/Documentation/cmd-list.perl +++ b/Documentation/cmd-list.perl @@ -27,7 +27,7 @@ sub format_one { die "No description found in $name.txt"; } if (my ($verify_name, $text) = ($description =~ /^($name) - (.*)/)) { - print $out "gitlink:$name\[1\]::\n\t"; + print $out "linkgit:$name\[1\]::\n\t"; if ($attr =~ / deprecated /) { print $out "(deprecated) "; } diff --git a/Documentation/config.txt b/Documentation/config.txt index ee08845..f9bdb16 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -115,7 +115,7 @@ porcelain configuration variables in the respective porcelain documentation. core.fileMode:: If false, the executable bit differences between the index and the working copy are ignored; useful on broken filesystems like FAT. - See gitlink:git-update-index[1]. True by default. + See linkgit:git-update-index[1]. True by default. core.quotepath:: The commands that output paths (e.g. `ls-files`, @@ -141,8 +141,8 @@ core.autocrlf:: core.symlinks:: If false, symbolic links are checked out as small plain files that - contain the link text. gitlink:git-update-index[1] and - gitlink:git-add[1] will not change the recorded type to regular + contain the link text. linkgit:git-update-index[1] and + linkgit:git-add[1] will not change the recorded type to regular file. Useful on filesystems like FAT that do not support symbolic links. True by default. @@ -163,7 +163,7 @@ core.ignoreStat:: The working copy files are assumed to stay unchanged until you mark them otherwise manually - Git will not detect the file changes by lstat() calls. This is useful on systems where those are very - slow, such as Microsoft Windows. See gitlink:git-update-index[1]. + slow, such as Microsoft Windows. See linkgit:git-update-index[1]. False by default. core.preferSymlinkRefs:: @@ -176,10 +176,10 @@ core.bare:: If true this repository is assumed to be 'bare' and has no working directory associated with it. If this is the case a number of commands that require a working directory will be - disabled, such as gitlink:git-add[1] or gitlink:git-merge[1]. + disabled, such as linkgit:git-add[1] or linkgit:git-merge[1]. + -This setting is automatically guessed by gitlink:git-clone[1] or -gitlink:git-init[1] when the repository was created. By default a +This setting is automatically guessed by linkgit:git-clone[1] or +linkgit:git-init[1] when the repository was created. By default a repository that ends in "/.git" is assumed to be not bare (bare = false), while all other repositories are assumed to be bare (bare = true). @@ -216,7 +216,7 @@ core.sharedRepository:: group-writable). When 'all' (or 'world' or 'everybody'), the repository will be readable by all users, additionally to being group-shareable. When 'umask' (or 'false'), git will use permissions - reported by umask(2). See gitlink:git-init[1]. False by default. + reported by umask(2). See linkgit:git-init[1]. False by default. core.warnAmbiguousRefs:: If true, git will warn you if the ref name you passed it is ambiguous @@ -281,7 +281,7 @@ core.excludesfile:: In addition to '.gitignore' (per-directory) and '.git/info/exclude', git looks into this file for patterns of files which are not meant to be tracked. See - gitlink:gitignore[5]. + linkgit:gitignore[5]. core.editor:: Commands such as `commit` and `tag` that lets you edit @@ -310,7 +310,7 @@ core.whitespace:: space characters as an error (not enabled by default). alias.*:: - Command aliases for the gitlink:git[1] command wrapper - e.g. + Command aliases for the linkgit:git[1] command wrapper - e.g. after defining "alias.last = cat-file commit HEAD", the invocation "git last" is equivalent to "git cat-file commit HEAD". To avoid confusion and troubles with script usage, aliases that @@ -326,14 +326,14 @@ it will be treated as a shell command. For example, defining apply.whitespace:: Tells `git-apply` how to handle whitespaces, in the same way - as the '--whitespace' option. See gitlink:git-apply[1]. + as the '--whitespace' option. See linkgit:git-apply[1]. branch.autosetupmerge:: Tells `git-branch` and `git-checkout` to setup new branches - so that gitlink:git-pull[1] will appropriately merge from that + so that linkgit:git-pull[1] will appropriately merge from that remote branch. Note that even if this option is not set, this behavior can be chosen per-branch using the `--track` - and `--no-track` options. This option defaults to false. + and `--no-track` options. This option defaults to true. branch.<name>.remote:: When in branch <name>, it tells `git fetch` which remote to fetch. @@ -356,7 +356,7 @@ branch.<name>.merge:: branch.<name>.mergeoptions:: Sets default options for merging into branch <name>. The syntax and - supported options are equal to that of gitlink:git-merge[1], but + supported options are equal to that of linkgit:git-merge[1], but option values containing whitespace characters are currently not supported. @@ -364,16 +364,21 @@ branch.<name>.rebase:: When true, rebase the branch <name> on top of the fetched branch, instead of merging the default branch from the default remote. *NOTE*: this is a possibly dangerous operation; do *not* use - it unless you understand the implications (see gitlink:git-rebase[1] + it unless you understand the implications (see linkgit:git-rebase[1] for details). +browser.<tool>.path:: + Override the path for the given tool that may be used to + browse HTML help (see '-w' option in linkgit:git-help[1]) or a + working repository in gitweb (see linkgit:git-instaweb[1]). + clean.requireForce:: A boolean to make git-clean do nothing unless given -f or -n. Defaults to true. color.branch:: A boolean to enable/disable color in the output of - gitlink:git-branch[1]. May be set to `always`, + linkgit:git-branch[1]. May be set to `always`, `false` (or `never`) or `auto` (or `true`), in which case colors are used only when the output is to a terminal. Defaults to false. @@ -406,7 +411,8 @@ color.diff.<slot>:: in color.branch.<slot>. color.interactive:: - When set to `always`, always use colors in `git add --interactive`. + When set to `always`, always use colors for interactive prompts + and displays (such as those used by "git add --interactive"). When false (or `never`), never. When set to `true` or `auto`, use colors only when the output is to the terminal. Defaults to false. @@ -423,7 +429,7 @@ color.pager:: color.status:: A boolean to enable/disable color in the output of - gitlink:git-status[1]. May be set to `always`, + linkgit:git-status[1]. May be set to `always`, `false` (or `never`) or `auto` (or `true`), in which case colors are used only when the output is to a terminal. Defaults to false. @@ -453,7 +459,7 @@ diff.external:: performed using the internal diff machinery, but using the given command. Note: if you want to use an external diff program only on a subset of your files, you might want to - use gitlink:gitattributes[5] instead. + use linkgit:gitattributes[5] instead. diff.renameLimit:: The number of files to consider when performing the copy/rename @@ -472,17 +478,18 @@ fetch.unpackLimit:: exceeds this limit then the received pack will be stored as a pack, after adding any missing delta bases. Storing the pack from a push can make the push operation complete faster, - especially on slow filesystems. + especially on slow filesystems. If not set, the value of + `transfer.unpackLimit` is used instead. format.numbered:: A boolean which can enable sequence numbers in patch subjects. Setting this option to "auto" will enable it only if there is more than one patch. See --numbered option in - gitlink:git-format-patch[1]. + linkgit:git-format-patch[1]. format.headers:: Additional email headers to include in a patch to be submitted - by mail. See gitlink:git-format-patch[1]. + by mail. See linkgit:git-format-patch[1]. format.suffix:: The default for format-patch is to output files with the suffix @@ -498,14 +505,14 @@ gc.auto:: When there are approximately more than this many loose objects in the repository, `git gc --auto` will pack them. Some Porcelain commands use this command to perform a - light-weight garbage collection from time to time. Setting - this to 0 disables it. + light-weight garbage collection from time to time. The + default value is 6700. Setting this to 0 disables it. gc.autopacklimit:: When there are more than this many packs that are not marked with `*.keep` file in the repository, `git gc - --auto` consolidates them into one larger pack. Setting - this to 0 disables this. + --auto` consolidates them into one larger pack. The + default value is 20. Setting this to 0 disables it. gc.packrefs:: `git gc` does not run `git pack-refs` in a bare repository by @@ -530,27 +537,27 @@ gc.reflogexpireunreachable:: gc.rerereresolved:: Records of conflicted merge you resolved earlier are kept for this many days when `git rerere gc` is run. - The default is 60 days. See gitlink:git-rerere[1]. + The default is 60 days. See linkgit:git-rerere[1]. gc.rerereunresolved:: Records of conflicted merge you have not resolved are kept for this many days when `git rerere gc` is run. - The default is 15 days. See gitlink:git-rerere[1]. + The default is 15 days. See linkgit:git-rerere[1]. rerere.enabled:: Activate recording of resolved conflicts, so that identical conflict hunks can be resolved automatically, should they - be encountered again. gitlink:git-rerere[1] command is by - default enabled, but can be disabled by setting this option to - false. + be encountered again. linkgit:git-rerere[1] command is by + default enabled if you create `rr-cache` directory under + `$GIT_DIR`, but can be disabled by setting this option to false. gitcvs.enabled:: Whether the CVS server interface is enabled for this repository. - See gitlink:git-cvsserver[1]. + See linkgit:git-cvsserver[1]. gitcvs.logfile:: Path to a log file where the CVS server interface well... logs - various stuff. See gitlink:git-cvsserver[1]. + various stuff. See linkgit:git-cvsserver[1]. gitcvs.allbinary:: If true, all files are sent to the client in mode '-kb'. This @@ -563,7 +570,7 @@ gitcvs.dbname:: derived from the git repository. The exact meaning depends on the used database driver, for SQLite (which is the default driver) this is a filename. Supports variable substitution (see - gitlink:git-cvsserver[1] for details). May not contain semicolons (`;`). + linkgit:git-cvsserver[1] for details). May not contain semicolons (`;`). Default: '%Ggitcvs.%m.sqlite' gitcvs.dbdriver:: @@ -572,22 +579,31 @@ gitcvs.dbdriver:: with 'DBD::SQLite', reported to work with 'DBD::Pg', and reported *not* to work with 'DBD::mysql'. Experimental feature. May not contain double colons (`:`). Default: 'SQLite'. - See gitlink:git-cvsserver[1]. + See linkgit:git-cvsserver[1]. gitcvs.dbuser, gitcvs.dbpass:: Database user and password. Only useful if setting 'gitcvs.dbdriver', since SQLite has no concept of database users and/or passwords. 'gitcvs.dbuser' supports variable substitution (see - gitlink:git-cvsserver[1] for details). + linkgit:git-cvsserver[1] for details). All gitcvs variables except for 'gitcvs.allbinary' can also be specified as 'gitcvs.<access_method>.<varname>' (where 'access_method' is one of "ext" and "pserver") to make them apply only for the given access method. +help.browser:: + Specify the browser that will be used to display help in the + 'web' format. See linkgit:git-help[1]. + +help.format:: + Override the default help format used by linkgit:git-help[1]. + Values 'man', 'info', 'web' and 'html' are supported. 'man' is + the default. 'web' and 'html' are the same. + http.proxy:: Override the HTTP proxy, normally configured using the 'http_proxy' - environment variable (see gitlink:curl[1]). This can be overridden + environment variable (see linkgit:curl[1]). This can be overridden on a per-remote basis; see remote.<name>.proxy http.sslVerify:: @@ -636,16 +652,35 @@ i18n.commitEncoding:: does not care per se, but this information is necessary e.g. when importing commits from emails or in the gitk graphical history browser (and possibly at other places in the future or in other - porcelains). See e.g. gitlink:git-mailinfo[1]. Defaults to 'utf-8'. + porcelains). See e.g. linkgit:git-mailinfo[1]. Defaults to 'utf-8'. i18n.logOutputEncoding:: Character encoding the commit messages are converted to when running `git-log` and friends. +instaweb.browser:: + Specify the program that will be used to browse your working + repository in gitweb. See linkgit:git-instaweb[1]. + +instaweb.httpd:: + The HTTP daemon command-line to start gitweb on your working + repository. See linkgit:git-instaweb[1]. + +instaweb.local:: + If true the web server started by linkgit:git-instaweb[1] will + be bound to the local IP (127.0.0.1). + +instaweb.modulepath:: + The module path for an apache httpd used by linkgit:git-instaweb[1]. + +instaweb.port:: + The port number to bind the gitweb httpd to. See + linkgit:git-instaweb[1]. + log.showroot:: If true, the initial commit will be shown as a big creation event. This is equivalent to a diff against an empty tree. - Tools like gitlink:git-log[1] or gitlink:git-whatchanged[1], which + Tools like linkgit:git-log[1] or linkgit:git-whatchanged[1], which normally hide the root commit will now show it. True by default. merge.summary:: @@ -654,7 +689,7 @@ merge.summary:: merge.tool:: Controls which merge resolution program is used by - gitlink:git-mergetool[1]. Valid values are: "kdiff3", "tkdiff", + linkgit:git-mergetool[1]. Valid values are: "kdiff3", "tkdiff", "meld", "xxdiff", "emerge", "vimdiff", "gvimdiff", and "opendiff". merge.verbosity:: @@ -667,31 +702,31 @@ merge.verbosity:: merge.<driver>.name:: Defines a human readable name for a custom low-level - merge driver. See gitlink:gitattributes[5] for details. + merge driver. See linkgit:gitattributes[5] for details. merge.<driver>.driver:: Defines the command that implements a custom low-level - merge driver. See gitlink:gitattributes[5] for details. + merge driver. See linkgit:gitattributes[5] for details. merge.<driver>.recursive:: Names a low-level merge driver to be used when performing an internal merge between common ancestors. - See gitlink:gitattributes[5] for details. + See linkgit:gitattributes[5] for details. mergetool.<tool>.path:: Override the path for the given tool. This is useful in case your tool is not in the PATH. pack.window:: - The size of the window used by gitlink:git-pack-objects[1] when no + The size of the window used by linkgit:git-pack-objects[1] when no window size is given on the command line. Defaults to 10. pack.depth:: - The maximum delta depth used by gitlink:git-pack-objects[1] when no + The maximum delta depth used by linkgit:git-pack-objects[1] when no maximum depth is given on the command line. Defaults to 50. pack.windowMemory:: - The window memory size limit used by gitlink:git-pack-objects[1] + The window memory size limit used by linkgit:git-pack-objects[1] when no limit is given on the command line. The value can be suffixed with "k", "m", or "g". Defaults to 0, meaning no limit. @@ -707,16 +742,16 @@ pack.compression:: pack.deltaCacheSize:: The maximum memory in bytes used for caching deltas in - gitlink:git-pack-objects[1]. + linkgit:git-pack-objects[1]. A value of 0 means no limit. Defaults to 0. pack.deltaCacheLimit:: The maximum size of a delta, that is cached in - gitlink:git-pack-objects[1]. Defaults to 1000. + linkgit:git-pack-objects[1]. Defaults to 1000. pack.threads:: Specifies the number of threads to spawn when searching for best - delta matches. This requires that gitlink:git-pack-objects[1] + delta matches. This requires that linkgit:git-pack-objects[1] be compiled with pthreads otherwise this option is ignored with a warning. This is meant to reduce packing time on multiprocessor machines. The required amount of memory for the delta search window @@ -731,6 +766,12 @@ pack.indexVersion:: whenever the corresponding pack is larger than 2 GB. Otherwise the default is 1. +pack.packSizeLimit: + The default maximum size of a pack. This setting only affects + packing to a file, i.e. the git:// protocol is unaffected. It + can be overridden by the `\--max-pack-size` option of + linkgit:git-repack[1]. + pull.octopus:: The default merge strategy to use when pulling multiple branches at once. @@ -739,8 +780,8 @@ pull.twohead:: The default merge strategy to use when pulling a single branch. remote.<name>.url:: - The URL of a remote repository. See gitlink:git-fetch[1] or - gitlink:git-push[1]. + The URL of a remote repository. See linkgit:git-fetch[1] or + linkgit:git-push[1]. remote.<name>.proxy:: For remotes that require curl (http, https and ftp), the URL to @@ -748,24 +789,24 @@ remote.<name>.proxy:: disable proxying for that remote. remote.<name>.fetch:: - The default set of "refspec" for gitlink:git-fetch[1]. See - gitlink:git-fetch[1]. + The default set of "refspec" for linkgit:git-fetch[1]. See + linkgit:git-fetch[1]. remote.<name>.push:: - The default set of "refspec" for gitlink:git-push[1]. See - gitlink:git-push[1]. + The default set of "refspec" for linkgit:git-push[1]. See + linkgit:git-push[1]. remote.<name>.skipDefaultUpdate:: If true, this remote will be skipped by default when updating - using the remote subcommand of gitlink:git-remote[1]. + using the update subcommand of linkgit:git-remote[1]. remote.<name>.receivepack:: The default program to execute on the remote side when pushing. See - option \--exec of gitlink:git-push[1]. + option \--exec of linkgit:git-push[1]. remote.<name>.uploadpack:: The default program to execute on the remote side when fetching. See - option \--exec of gitlink:git-fetch-pack[1]. + option \--exec of linkgit:git-fetch-pack[1]. remote.<name>.tagopt:: Setting this value to --no-tags disables automatic tag following when fetching @@ -773,22 +814,22 @@ remote.<name>.tagopt:: remotes.<group>:: The list of remotes which are fetched by "git remote update - <group>". See gitlink:git-remote[1]. + <group>". See linkgit:git-remote[1]. repack.usedeltabaseoffset:: - Allow gitlink:git-repack[1] to create packs that uses + Allow linkgit:git-repack[1] to create packs that uses delta-base offset. Defaults to false. show.difftree:: - The default gitlink:git-diff-tree[1] arguments to be used - for gitlink:git-show[1]. + The default linkgit:git-diff-tree[1] arguments to be used + for linkgit:git-show[1]. showbranch.default:: - The default set of branches for gitlink:git-show-branch[1]. - See gitlink:git-show-branch[1]. + The default set of branches for linkgit:git-show-branch[1]. + See linkgit:git-show-branch[1]. status.relativePaths:: - By default, gitlink:git-status[1] shows paths relative to the + By default, linkgit:git-status[1] shows paths relative to the current directory. Setting this variable to `false` shows paths relative to the repository root (this was the default for git prior to v1.5.4). @@ -798,32 +839,32 @@ tar.umask:: tar archive entries. The default is 0002, which turns off the world write bit. The special value "user" indicates that the archiving user's umask will be used instead. See umask(2) and - gitlink:git-archive[1]. + linkgit:git-archive[1]. user.email:: Your email address to be recorded in any newly created commits. Can be overridden by the 'GIT_AUTHOR_EMAIL', 'GIT_COMMITTER_EMAIL', and - 'EMAIL' environment variables. See gitlink:git-commit-tree[1]. + 'EMAIL' environment variables. See linkgit:git-commit-tree[1]. user.name:: Your full name to be recorded in any newly created commits. Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME' - environment variables. See gitlink:git-commit-tree[1]. + environment variables. See linkgit:git-commit-tree[1]. user.signingkey:: - If gitlink:git-tag[1] is not selecting the key you want it to + If linkgit:git-tag[1] is not selecting the key you want it to automatically when creating a signed tag, you can override the default selection with this variable. This option is passed unchanged to gpg's --local-user parameter, so you may specify a key using any method that gpg supports. whatchanged.difftree:: - The default gitlink:git-diff-tree[1] arguments to be used - for gitlink:git-whatchanged[1]. + The default linkgit:git-diff-tree[1] arguments to be used + for linkgit:git-whatchanged[1]. imap:: The configuration variables in the 'imap' section are described - in gitlink:git-imap-send[1]. + in linkgit:git-imap-send[1]. receive.unpackLimit:: If the number of objects received in a push is below this @@ -832,7 +873,8 @@ receive.unpackLimit:: exceeds this limit then the received pack will be stored as a pack, after adding any missing delta bases. Storing the pack from a push can make the push operation complete faster, - especially on slow filesystems. + especially on slow filesystems. If not set, the value of + `transfer.unpackLimit` is used instead. receive.denyNonFastForwards:: If set to true, git-receive-pack will deny a ref update which is @@ -843,3 +885,9 @@ receive.denyNonFastForwards:: transfer.unpackLimit:: When `fetch.unpackLimit` or `receive.unpackLimit` are not set, the value of this variable is used instead. + The default value is 100. + +web.browser:: + Specify a web browser that may be used by some commands. + Currently only linkgit:git-instaweb[1] and linkgit:git-help[1] + may use it. diff --git a/Documentation/core-tutorial.txt b/Documentation/core-tutorial.txt index bd6cd41..aa40dfd 100644 --- a/Documentation/core-tutorial.txt +++ b/Documentation/core-tutorial.txt @@ -578,7 +578,7 @@ particular state. You can, for example, do $ git diff my-first-tag ---------------- -to diff your current state against that tag (which at this point will +to diff your current state against that tag which at this point will obviously be an empty diff, but if you continue to develop and commit stuff, you can use your tag as an "anchor-point" to see what has changed since you tagged it. diff --git a/Documentation/cvs-migration.txt b/Documentation/cvs-migration.txt index 3b6b494..ea98900 100644 --- a/Documentation/cvs-migration.txt +++ b/Documentation/cvs-migration.txt @@ -36,12 +36,12 @@ them first before running git pull. ================================ The `pull` command knows where to get updates from because of certain configuration variables that were set by the first `git clone` -command; see `git config -l` and the gitlink:git-config[1] man +command; see `git config -l` and the linkgit:git-config[1] man page for details. ================================ You can update the shared repository with your changes by first committing -your changes, and then using the gitlink:git-push[1] command: +your changes, and then using the linkgit:git-push[1] command: ------------------------------------------------ $ git push origin master @@ -88,7 +88,7 @@ Next, give every team member read/write access to this repository. One easy way to do this is to give all the team members ssh access to the machine where the repository is hosted. If you don't want to give them a full shell on the machine, there is a restricted shell which only allows -users to do git pushes and pulls; see gitlink:git-shell[1]. +users to do git pushes and pulls; see linkgit:git-shell[1]. Put all the committers in the same group, and make the repository writable by that group: @@ -106,7 +106,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 gitlink:git-cvsimport[1]: +of the project you are interested in and run linkgit:git-cvsimport[1]: ------------------------------------------- $ git cvsimport -C <destination> <module> @@ -146,7 +146,7 @@ Providing CVS Access to a git Repository ---------------------------------------- It is also possible to provide true CVS access to a git repository, so -that developers can still use CVS; see gitlink:git-cvsserver[1] for +that developers can still use CVS; see linkgit:git-cvsserver[1] for details. Alternative Development Models diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt index 1a78635..8d35cbd 100644 --- a/Documentation/diff-options.txt +++ b/Documentation/diff-options.txt @@ -205,8 +205,8 @@ endif::git-format-patch[] --ext-diff:: Allow an external diff helper to be executed. If you set an - external diff driver with gitlink:gitattributes[5], you need - to use this option with gitlink:git-log[1] and friends. + external diff driver with linkgit:gitattributes[5], you need + to use this option with linkgit:git-log[1] and friends. --no-ext-diff:: Disallow external diff drivers. diff --git a/Documentation/everyday.txt b/Documentation/everyday.txt index f1993e2..fdbd15a 100644 --- a/Documentation/everyday.txt +++ b/Documentation/everyday.txt @@ -25,12 +25,12 @@ Basic Repository[[Basic Repository]] Everybody uses these commands to maintain git repositories. - * gitlink:git-init[1] or gitlink:git-clone[1] to create a + * linkgit:git-init[1] or linkgit:git-clone[1] to create a new repository. - * gitlink:git-fsck[1] to check the repository for errors. + * linkgit:git-fsck[1] to check the repository for errors. - * gitlink:git-gc[1] to do common housekeeping tasks such as + * linkgit:git-gc[1] to do common housekeeping tasks such as repack and prune. Examples @@ -69,28 +69,28 @@ A standalone individual developer does not exchange patches with other people, and works alone in a single repository, using the following commands. - * gitlink:git-show-branch[1] to see where you are. + * linkgit:git-show-branch[1] to see where you are. - * gitlink:git-log[1] to see what happened. + * linkgit:git-log[1] to see what happened. - * gitlink:git-checkout[1] and gitlink:git-branch[1] to switch + * linkgit:git-checkout[1] and linkgit:git-branch[1] to switch branches. - * gitlink:git-add[1] to manage the index file. + * linkgit:git-add[1] to manage the index file. - * gitlink:git-diff[1] and gitlink:git-status[1] to see what + * linkgit:git-diff[1] and linkgit:git-status[1] to see what you are in the middle of doing. - * gitlink:git-commit[1] to advance the current branch. + * linkgit:git-commit[1] to advance the current branch. - * gitlink:git-reset[1] and gitlink:git-checkout[1] (with + * linkgit:git-reset[1] and linkgit:git-checkout[1] (with pathname parameters) to undo changes. - * gitlink:git-merge[1] to merge between local branches. + * linkgit:git-merge[1] to merge between local branches. - * gitlink:git-rebase[1] to maintain topic branches. + * linkgit:git-rebase[1] to maintain topic branches. - * gitlink:git-tag[1] to mark known point. + * linkgit:git-tag[1] to mark known point. Examples ~~~~~~~~ @@ -156,16 +156,16 @@ A developer working as a participant in a group project needs to learn how to communicate with others, and uses these commands in addition to the ones needed by a standalone developer. - * gitlink:git-clone[1] from the upstream to prime your local + * linkgit:git-clone[1] from the upstream to prime your local repository. - * gitlink:git-pull[1] and gitlink:git-fetch[1] from "origin" + * linkgit:git-pull[1] and linkgit:git-fetch[1] from "origin" to keep up-to-date with the upstream. - * gitlink:git-push[1] to shared repository, if you adopt CVS + * linkgit:git-push[1] to shared repository, if you adopt CVS style shared repository workflow. - * gitlink:git-format-patch[1] to prepare e-mail submission, if + * linkgit:git-format-patch[1] to prepare e-mail submission, if you adopt Linux kernel-style public forum workflow. Examples @@ -258,17 +258,17 @@ project receives changes made by others, reviews and integrates them and publishes the result for others to use, using these commands in addition to the ones needed by participants. - * gitlink:git-am[1] to apply patches e-mailed in from your + * linkgit:git-am[1] to apply patches e-mailed in from your contributors. - * gitlink:git-pull[1] to merge from your trusted lieutenants. + * linkgit:git-pull[1] to merge from your trusted lieutenants. - * gitlink:git-format-patch[1] to prepare and send suggested + * linkgit:git-format-patch[1] to prepare and send suggested alternative to contributors. - * gitlink:git-revert[1] to undo botched commits. + * linkgit:git-revert[1] to undo botched commits. - * gitlink:git-push[1] to publish the bleeding edge. + * linkgit:git-push[1] to publish the bleeding edge. Examples @@ -343,10 +343,10 @@ Repository Administration[[Repository Administration]] A repository administrator uses the following tools to set up and maintain access to the repository by developers. - * gitlink:git-daemon[1] to allow anonymous download from + * linkgit:git-daemon[1] to allow anonymous download from repository. - * gitlink:git-shell[1] can be used as a 'restricted login shell' + * linkgit:git-shell[1] can be used as a 'restricted login shell' for shared central repository users. link:howto/update-hook-example.txt[update hook howto] has a good diff --git a/Documentation/fetch-options.txt b/Documentation/fetch-options.txt index da03422..b675911 100644 --- a/Documentation/fetch-options.txt +++ b/Documentation/fetch-options.txt @@ -23,11 +23,15 @@ fetches is a descendant of `<lbranch>`. This option overrides that check. +ifdef::git-pull[] +\--no-tags:: +endif::git-pull[] +ifndef::git-pull[] -n, \--no-tags:: - By default, `git-fetch` fetches tags that point at - objects that are downloaded from the remote repository - and stores them locally. This option disables this - automatic tag following. +endif::git-pull[] + By default, tags that point at objects that are downloaded + from the remote repository are fetched and stored locally. + This option disables this automatic tag following. -t, \--tags:: Most of the tags are fetched automatically as branch @@ -50,5 +54,5 @@ \--depth=<depth>:: Deepen the history of a 'shallow' repository created by - `git clone` with `--depth=<depth>` option (see gitlink:git-clone[1]) + `git clone` with `--depth=<depth>` option (see linkgit:git-clone[1]) by the specified number of commits. diff --git a/Documentation/git-add.txt b/Documentation/git-add.txt index 721ca99..9d2ac86 100644 --- a/Documentation/git-add.txt +++ b/Documentation/git-add.txt @@ -37,7 +37,7 @@ directory recursion or filename globbing performed by Git (quote your globs before the shell) will be silently ignored. The 'add' command can be used to add ignored files with the `-f` (force) option. -Please see gitlink:git-commit[1] for alternative ways to add content to a +Please see linkgit:git-commit[1] for alternative ways to add content to a commit. @@ -231,12 +231,12 @@ diff:: See Also -------- -gitlink:git-status[1] -gitlink:git-rm[1] -gitlink:git-reset[1] -gitlink:git-mv[1] -gitlink:git-commit[1] -gitlink:git-update-index[1] +linkgit:git-status[1] +linkgit:git-rm[1] +linkgit:git-reset[1] +linkgit:git-mv[1] +linkgit:git-commit[1] +linkgit:git-update-index[1] Author ------ @@ -248,4 +248,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt index e4a6b3a..2ffba21 100644 --- a/Documentation/git-am.txt +++ b/Documentation/git-am.txt @@ -37,10 +37,10 @@ OPTIONS area to store extracted patches. -k, --keep:: - Pass `-k` flag to `git-mailinfo` (see gitlink:git-mailinfo[1]). + Pass `-k` flag to `git-mailinfo` (see linkgit:git-mailinfo[1]). -u, --utf8:: - Pass `-u` flag to `git-mailinfo` (see gitlink:git-mailinfo[1]). + Pass `-u` flag to `git-mailinfo` (see linkgit:git-mailinfo[1]). The proposed commit log message taken from the e-mail is re-coded into UTF-8 encoding (configuration variable `i18n.commitencoding` can be used to specify project's @@ -51,7 +51,7 @@ default. You could use `--no-utf8` to override this. --no-utf8:: Pass `-n` flag to `git-mailinfo` (see - gitlink:git-mailinfo[1]). + linkgit:git-mailinfo[1]). -3, --3way:: When the patch does not apply cleanly, fall back on @@ -61,15 +61,15 @@ default. You could use `--no-utf8` to override this. -b, --binary:: Pass `--allow-binary-replacement` flag to `git-apply` - (see gitlink:git-apply[1]). + (see linkgit:git-apply[1]). --whitespace=<option>:: - This flag is passed to the `git-apply` (see gitlink:git-apply[1]) + This flag is passed to the `git-apply` (see linkgit:git-apply[1]) program that applies the patch. -C<n>, -p<n>:: - These flags are passed to the `git-apply` (see gitlink:git-apply[1]) + These flags are passed to the `git-apply` (see linkgit:git-apply[1]) program that applies the patch. @@ -144,7 +144,7 @@ names. SEE ALSO -------- -gitlink:git-apply[1]. +linkgit:git-apply[1]. Author @@ -157,4 +157,4 @@ Documentation by Petr Baudis, Junio C Hamano and the git-list <git@vger.kernel.o GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-annotate.txt b/Documentation/git-annotate.txt index 02dc474..45a6a72 100644 --- a/Documentation/git-annotate.txt +++ b/Documentation/git-annotate.txt @@ -20,7 +20,7 @@ include::blame-options.txt[] SEE ALSO -------- -gitlink:git-blame[1] +linkgit:git-blame[1] AUTHOR ------ @@ -28,4 +28,4 @@ Written by Ryan Anderson <ryan@michonline.com>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-apply.txt b/Documentation/git-apply.txt index 9ec38f9..2dec2ec 100644 --- a/Documentation/git-apply.txt +++ b/Documentation/git-apply.txt @@ -77,7 +77,7 @@ the information is read from the current index instead. Apply the patch in reverse. --reject:: - For atomicity, gitlink:git-apply[1] by default fails the whole patch and + For atomicity, linkgit:git-apply[1] 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 @@ -101,7 +101,7 @@ the information is read from the current index instead. ever ignored. --unidiff-zero:: - By default, gitlink:git-apply[1] expects that the patch being + By default, linkgit:git-apply[1] 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 @@ -112,7 +112,7 @@ discouraged. --apply:: If you use any of the options marked "Turns off - 'apply'" above, gitlink:git-apply[1] reads and outputs the + 'apply'" above, linkgit:git-apply[1] reads and outputs the information you asked without actually applying the patch. Give this flag after those flags to also apply the patch. @@ -145,7 +145,7 @@ discouraged. considered whitespace errors. + By default, the command outputs warning messages but applies the patch. -When gitlink:git-apply[1] is used for statistics and not applying a +When linkgit:git-apply[1] is used for statistics and not applying a patch, it defaults to `nowarn`. + You can use different `<action>` to control this @@ -183,7 +183,7 @@ apply.whitespace:: Submodules ---------- -If the patch contains any changes to submodules then gitlink:git-apply[1] +If the patch contains any changes to submodules then linkgit:git-apply[1] treats these changes as follows. If --index is specified (explicitly or implicitly), then the submodule @@ -206,4 +206,4 @@ Documentation by Junio C Hamano GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-archimport.txt b/Documentation/git-archimport.txt index 7091b8d..bd20fd8 100644 --- a/Documentation/git-archimport.txt +++ b/Documentation/git-archimport.txt @@ -117,4 +117,4 @@ Documentation by Junio C Hamano, Martin Langhoff and the git-list <git@vger.kern GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-archive.txt b/Documentation/git-archive.txt index 7cd6526..d3eaa16 100644 --- a/Documentation/git-archive.txt +++ b/Documentation/git-archive.txt @@ -118,4 +118,4 @@ Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-bisect.txt b/Documentation/git-bisect.txt index 8b9d61a..96585ae 100644 --- a/Documentation/git-bisect.txt +++ b/Documentation/git-bisect.txt @@ -227,4 +227,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-blame.txt b/Documentation/git-blame.txt index 66f1203..14163b6 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 gitlink:git-diff[1] or the "pickaxe" +replaced; you need to use a tool such as linkgit:git-diff[1] or the "pickaxe" interface briefly mentioned in the following paragraph. Apart from supporting file annotation, git also supports searching the @@ -41,7 +41,7 @@ OPTIONS include::blame-options.txt[] -c:: - Use the same output mode as gitlink:git-annotate[1] (Default: off). + Use the same output mode as linkgit:git-annotate[1] (Default: off). --score-debug:: Include debugging information related to the movement of @@ -184,7 +184,7 @@ commit commentary), a blame viewer won't ever care. SEE ALSO -------- -gitlink:git-annotate[1] +linkgit:git-annotate[1] AUTHOR ------ @@ -192,4 +192,4 @@ Written by Junio C Hamano <junkio@cox.net> GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt index d3f21c7..7e8874a 100644 --- a/Documentation/git-branch.txt +++ b/Documentation/git-branch.txt @@ -34,11 +34,11 @@ Note that this will create the new branch, but it will not switch the 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 can setup the -branch so that gitlink:git-pull[1] will appropriately merge from that -remote branch. If this behavior is desired, it is possible to make it -the default using the global `branch.autosetupmerge` configuration -flag. Otherwise, it can be chosen per-branch using the `--track` +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 that +remote branch. If this behavior is not desired, it is possible to +disable it using the global `branch.autosetupmerge` configuration +flag. That setting can be overridden by using the `--track` and `--no-track` options. With a '-m' or '-M' option, <oldbranch> will be renamed to <newbranch>. @@ -53,8 +53,8 @@ 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 gitlink:git-fetch[1] was configured not to fetch -them again. See also 'prune' subcommand of gitlink:git-remote[1] for way to +in remote repository or if linkgit:git-fetch[1] 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. @@ -108,10 +108,11 @@ OPTIONS Set up configuration so that git-pull will automatically retrieve data from the remote branch. Use this if you always pull from the same remote branch into the new branch, or if you - don't want to use "git pull <repository> <refspec>" explicitly. Set the - branch.autosetupmerge configuration variable to true if you + don't want to use "git pull <repository> <refspec>" explicitly. + This behavior is the default. Set the + branch.autosetupmerge configuration variable to false if you want git-checkout and git-branch to always behave as if - '--track' were given. + '--no-track' were given. --no-track:: When a branch is created off a remote branch, @@ -122,7 +123,7 @@ OPTIONS <branchname>:: The name of the branch to create or delete. The new branch name must pass all checks defined by - gitlink:git-check-ref-format[1]. Some of these checks + linkgit:git-check-ref-format[1]. Some of these checks may restrict the characters allowed in a branch name. <start-point>:: @@ -164,7 +165,7 @@ $ git branch -D test <2> + <1> Delete remote-tracking branches "todo", "html", "man". Next 'fetch' or 'pull' will create them again unless you configure them not to. See -gitlink:git-fetch[1]. +linkgit:git-fetch[1]. <2> Delete "test" branch even if the "master" branch (or whichever branch is currently checked out) does not have all commits from test branch. @@ -187,4 +188,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-bundle.txt b/Documentation/git-bundle.txt index 0cc6511..72f080a 100644 --- a/Documentation/git-bundle.txt +++ b/Documentation/git-bundle.txt @@ -23,7 +23,7 @@ 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 in an archive at the originating machine, then importing those into -another repository using gitlink:git-fetch[1] and gitlink:git-pull[1] +another repository using linkgit:git-fetch[1] and linkgit:git-pull[1] 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 @@ -51,12 +51,12 @@ list-heads <file>:: printed out. unbundle <file>:: - Passes the objects in the bundle to gitlink:git-index-pack[1] + Passes the objects in the bundle to linkgit:git-index-pack[1] 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 - gitlink:git-fetch[1]. + linkgit:git-fetch[1]. [git-rev-list-args...]:: A list of arguments, acceptable to git-rev-parse and @@ -73,7 +73,7 @@ unbundle <file>:: 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 gitlink:git-fetch-pack[1]). + acting like linkgit:git-fetch-pack[1]). SPECIFYING REFERENCES --------------------- @@ -145,4 +145,4 @@ Written by Mark Levedahl <mdl123@verizon.net> GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-cat-file.txt b/Documentation/git-cat-file.txt index afa095c..df42cb1 100644 --- a/Documentation/git-cat-file.txt +++ b/Documentation/git-cat-file.txt @@ -21,7 +21,7 @@ OPTIONS <object>:: The name of the object to show. For a more complete list of ways to spell object names, see - "SPECIFYING REVISIONS" section in gitlink:git-rev-parse[1]. + "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1]. -t:: Instead of the content, show the object type identified by @@ -70,4 +70,4 @@ Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-check-attr.txt b/Documentation/git-check-attr.txt index 856d2af..290f10f 100644 --- a/Documentation/git-check-attr.txt +++ b/Documentation/git-check-attr.txt @@ -23,6 +23,11 @@ OPTIONS be treated as an attribute. +SEE ALSO +-------- +linkgit:gitattributes[5]. + + Author ------ Written by Junio C Hamano <junkio@cox.net> @@ -33,4 +38,4 @@ Documentation by James Bowes. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-check-ref-format.txt b/Documentation/git-check-ref-format.txt index 13a5f43..a676880 100644 --- a/Documentation/git-check-ref-format.txt +++ b/Documentation/git-check-ref-format.txt @@ -35,7 +35,7 @@ imposes the following rules on how refs are named: These rules makes it easy for shell script based tools to parse refnames, pathname expansion by the shell when a refname is used unquoted (by mistake), and also avoids ambiguities in certain -refname expressions (see gitlink:git-rev-parse[1]). Namely: +refname expressions (see linkgit:git-rev-parse[1]). Namely: . double-dot `..` are often used as in `ref1..ref2`, and in some context this notation means `{caret}ref1 ref2` (i.e. not in @@ -47,9 +47,9 @@ refname expressions (see gitlink: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 - gitlink:git-cat-file[1] "git-cat-file blob v1.3.3:refs.c". + linkgit:git-cat-file[1] "git-cat-file blob v1.3.3:refs.c". GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-checkout-index.txt b/Documentation/git-checkout-index.txt index b1a8ce1..cbbb0b5 100644 --- a/Documentation/git-checkout-index.txt +++ b/Documentation/git-checkout-index.txt @@ -181,4 +181,4 @@ Junio C Hamano and the git-list <git@vger.kernel.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt index 2e58481..b4cfa04 100644 --- a/Documentation/git-checkout.txt +++ b/Documentation/git-checkout.txt @@ -44,7 +44,7 @@ OPTIONS -b:: Create a new branch named <new_branch> and start it at <branch>. The new branch name must pass all checks defined - by gitlink:git-check-ref-format[1]. Some of these checks + by linkgit:git-check-ref-format[1]. Some of these checks may restrict the characters allowed in a branch name. --track:: @@ -52,10 +52,11 @@ OPTIONS set up configuration so that git-pull will automatically retrieve data from the remote branch. Use this if you always pull from the same remote branch into the new branch, or if you - don't want to use "git pull <repository> <refspec>" explicitly. Set the - branch.autosetupmerge configuration variable to true if you + don't want to use "git pull <repository> <refspec>" explicitly. + This behavior is the default. Set the + branch.autosetupmerge configuration variable to false if you want git-checkout and git-branch to always behave as if - '--track' were given. + '--no-track' were given. --no-track:: When -b is given and a branch is created off a remote branch, @@ -216,4 +217,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-cherry-pick.txt b/Documentation/git-cherry-pick.txt index 937c4a7..877ab66 100644 --- a/Documentation/git-cherry-pick.txt +++ b/Documentation/git-cherry-pick.txt @@ -20,11 +20,11 @@ OPTIONS <commit>:: Commit to cherry-pick. For a more complete list of ways to spell commits, see - "SPECIFYING REVISIONS" section in gitlink:git-rev-parse[1]. + "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1]. -e|--edit:: With this option, `git-cherry-pick` will let you edit the commit - message prior committing. + message prior to committing. -x:: When recording the commit, append to the original commit @@ -75,4 +75,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-cherry.txt b/Documentation/git-cherry.txt index e694382..b0468aa 100644 --- a/Documentation/git-cherry.txt +++ b/Documentation/git-cherry.txt @@ -66,4 +66,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-citool.txt b/Documentation/git-citool.txt index 5217ab2..aca1d75 100644 --- a/Documentation/git-citool.txt +++ b/Documentation/git-citool.txt @@ -14,10 +14,10 @@ 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 gitlink:git-commit[1] program. +to the less interactive linkgit:git-commit[1] program. git-citool is actually a standard alias for 'git gui citool'. -See gitlink:git-gui[1] for more details. +See linkgit:git-gui[1] for more details. Author ------ @@ -29,4 +29,4 @@ Documentation by Shawn O. Pearce <spearce@spearce.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt index e3252d5..5e9da03 100644 --- a/Documentation/git-clean.txt +++ b/Documentation/git-clean.txt @@ -39,7 +39,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 gitlink:git-reset[1]) to create a pristine + conjunction with linkgit:git-reset[1]) to create a pristine working directory to test a clean build. -X:: @@ -54,4 +54,4 @@ Written by Pavel Roskin <proski@gnu.org> GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt index c90bcec..2341881 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt @@ -62,6 +62,14 @@ OPTIONS .git/objects/info/alternates to share the objects with the source repository. The resulting repository starts out without any object of its own. + *NOTE*: this is a possibly dangerous operation; do *not* use + it unless you understand what it does. If you clone your + repository using this option, then delete branches in the + source repository and then run linkgit:git-gc[1] using the + '--prune' option in the source repository, it may remove + objects which are referenced by the cloned repository. + + --reference <repository>:: If the reference repository is on the local machine @@ -191,4 +199,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-commit-tree.txt b/Documentation/git-commit-tree.txt index a2537e1..170803a 100644 --- a/Documentation/git-commit-tree.txt +++ b/Documentation/git-commit-tree.txt @@ -13,7 +13,7 @@ SYNOPSIS DESCRIPTION ----------- This is usually not what an end user wants to run directly. See -gitlink:git-commit[1] instead. +linkgit:git-commit[1] instead. Creates a new commit object based on the provided tree object and emits the new commit object id on stdout. If no parent is given then @@ -90,7 +90,7 @@ include::i18n.txt[] See Also -------- -gitlink:git-write-tree[1] +linkgit:git-write-tree[1] Author @@ -103,4 +103,4 @@ Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index 4261384..c3725b2 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt @@ -11,7 +11,7 @@ SYNOPSIS 'git-commit' [-a | --interactive] [-s] [-v] [-u] [(-c | -C) <commit> | -F <file> | -m <msg> | --amend] [--allow-empty] [--no-verify] [-e] [--author <author>] - [--] [[-i | -o ]<file>...] + [--cleanup=<mode>] [--] [[-i | -o ]<file>...] DESCRIPTION ----------- @@ -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 gitlink:git-add[1] to incrementally "add" changes to the +1. by using linkgit:git-add[1] to incrementally "add" changes to the index before using the 'commit' command (Note: even modified files must be "added"); -2. by using gitlink:git-rm[1] to remove files from the working tree +2. by using linkgit:git-rm[1] 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 gitlink:git-status[1] command can be used to obtain a +The linkgit:git-status[1] 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 gitlink:git-reset[1]. +that, you can recover from it with linkgit:git-reset[1]. OPTIONS @@ -95,6 +95,16 @@ OPTIONS from making such a commit. This option bypasses the safety, and is primarily for use by foreign scm interface scripts. +--cleanup=<mode>:: + This option sets how the commit message is cleaned up. + The '<mode>' can be one of 'verbatim', 'whitespace', 'strip', + and 'default'. The 'default' mode will strip leading and + trailing empty lines and #commentary from the commit message + only if the message is to be edited. Otherwise only whitespace + removed. The 'verbatim' mode does not change message at all, + 'whitespace' removes just leading/trailing whitespace lines + and 'strip' removes both whitespace and commentary. + -e|--edit:: The message taken from file with `-F`, command line with `-m`, and from file with `-C` are usually used as the @@ -160,7 +170,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 gitlink:git-add[1]. A file can be +called the "index" with linkgit:git-add[1]. 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 @@ -219,13 +229,13 @@ $ git commit this second commit would record the changes to `hello.c` and `hello.h` as expected. -After a merge (initiated by either gitlink:git-merge[1] or -gitlink:git-pull[1]) stops because of conflicts, cleanly merged +After a merge (initiated by either linkgit:git-merge[1] or +linkgit:git-pull[1]) 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 gitlink:git-status[1] +check which paths are conflicting with linkgit:git-status[1] and after fixing them manually in your working tree, you would -stage the result as usual with gitlink:git-add[1]: +stage the result as usual with linkgit:git-add[1]: ------------ $ git status | grep unmerged @@ -277,11 +287,11 @@ information. SEE ALSO -------- -gitlink:git-add[1], -gitlink:git-rm[1], -gitlink:git-mv[1], -gitlink:git-merge[1], -gitlink:git-commit-tree[1] +linkgit:git-add[1], +linkgit:git-rm[1], +linkgit:git-mv[1], +linkgit:git-merge[1], +linkgit:git-commit-tree[1] Author ------ @@ -291,4 +301,4 @@ Junio C Hamano <junkio@cox.net> GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt index 98509b4..fa16171 100644 --- a/Documentation/git-config.txt +++ b/Documentation/git-config.txt @@ -130,7 +130,7 @@ See also <<FILES>>. -z, --null:: For all options that output values and/or keys, always - end values with with the null character (instead of a + end values with the null character (instead of a newline). Use newline instead as a delimiter between key and value. This allows for secure parsing of the output without getting confused e.g. by values that @@ -332,4 +332,4 @@ Documentation by Johannes Schindelin, Petr Baudis and the git-list <git@vger.ker GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-count-objects.txt b/Documentation/git-count-objects.txt index 8161411..7fb08e9 100644 --- a/Documentation/git-count-objects.txt +++ b/Documentation/git-count-objects.txt @@ -34,4 +34,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-cvsexportcommit.txt b/Documentation/git-cvsexportcommit.txt index 3f9d229..9a47b4c 100644 --- a/Documentation/git-cvsexportcommit.txt +++ b/Documentation/git-cvsexportcommit.txt @@ -106,4 +106,4 @@ Documentation by Martin Langhoff <martin@catalyst.net.nz> and others. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-cvsimport.txt b/Documentation/git-cvsimport.txt index fdd7ec7..dbce503 100644 --- a/Documentation/git-cvsimport.txt +++ b/Documentation/git-cvsimport.txt @@ -142,7 +142,7 @@ 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 -gitlink:git-cvsexportcommit[1]. +linkgit:git-cvsexportcommit[1]. -h:: Print a short usage message and exit. @@ -166,4 +166,4 @@ Documentation by Matthias Urlichs <smurf@smurf.noris.de>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-cvsserver.txt b/Documentation/git-cvsserver.txt index 258a62f..d3e9993 100644 --- a/Documentation/git-cvsserver.txt +++ b/Documentation/git-cvsserver.txt @@ -28,7 +28,7 @@ OPTIONS ------- All these options obviously only make sense if enforced by the server side. -They have been implemented to resemble the gitlink:git-daemon[1] options as +They have been implemented to resemble the linkgit:git-daemon[1] options as closely as possible. --base-path <path>:: @@ -183,7 +183,7 @@ 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 database to work reliably (otherwise you need to make sure -that the database if up-to-date all the time git-cvsserver is run). +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 @@ -204,7 +204,7 @@ about `DBI->connect()`. gitcvs.dbname:: Database name. The exact meaning depends on the - used database driver, for SQLite this is a filename. + selected database driver, for SQLite this is a filename. Supports variable substitution (see below). May not contain semicolons (`;`). Default: '%Ggitcvs.%m.sqlite' @@ -215,7 +215,7 @@ gitcvs.dbdriver:: with 'DBD::SQLite', reported to work with 'DBD::Pg', and reported *not* to work with 'DBD::mysql'. Please regard this as an experimental feature. May not - contain double colons (`:`). + contain colons (`:`). Default: 'SQLite' gitcvs.dbuser:: @@ -319,4 +319,4 @@ Documentation by Martyn Smith <martyn@catalyst.net.nz>, Martin Langhoff <martin@ GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-daemon.txt b/Documentation/git-daemon.txt index f1e48dd..fd83bc7 100644 --- a/Documentation/git-daemon.txt +++ b/Documentation/git-daemon.txt @@ -272,4 +272,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt index 9c7a032..1c3dfb4 100644 --- a/Documentation/git-describe.txt +++ b/Documentation/git-describe.txt @@ -127,4 +127,4 @@ Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-diff-files.txt b/Documentation/git-diff-files.txt index d8a0a86..6d2ea16 100644 --- a/Documentation/git-diff-files.txt +++ b/Documentation/git-diff-files.txt @@ -57,4 +57,4 @@ Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-diff-index.txt b/Documentation/git-diff-index.txt index 7bd262c..e867778 100644 --- a/Documentation/git-diff-index.txt +++ b/Documentation/git-diff-index.txt @@ -129,4 +129,4 @@ Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-diff-tree.txt b/Documentation/git-diff-tree.txt index 6b3f74e..58d02c6 100644 --- a/Documentation/git-diff-tree.txt +++ b/Documentation/git-diff-tree.txt @@ -165,4 +165,4 @@ Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt index 2808a5e..57c2862 100644 --- a/Documentation/git-diff.txt +++ b/Documentation/git-diff.txt @@ -21,7 +21,7 @@ tree and the index file, or the index file and the working tree. the index (staging area for the next commit). In other words, the differences are what you _could_ tell git to further add to the index but you still haven't. You can - stage these changes by using gitlink:git-add[1]. + stage these changes by using linkgit:git-add[1]. + If exactly two paths are given, and at least one is untracked, compare the two files / directories. This behavior can be @@ -67,11 +67,11 @@ for the last two forms that use ".." notations, can be any <tree-ish>. For a more complete list of ways to spell <commit>, see -"SPECIFYING REVISIONS" section in gitlink:git-rev-parse[1]. +"SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1]. However, "diff" is about comparing two _endpoints_, not ranges, and the range notations ("<commit>..<commit>" and "<commit>\...<commit>") do not mean a range as defined in the -"SPECIFYING RANGES" section in gitlink:git-rev-parse[1]. +"SPECIFYING RANGES" section in linkgit:git-rev-parse[1]. OPTIONS ------- @@ -168,4 +168,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-fast-export.txt b/Documentation/git-fast-export.txt index fd3d571..6dac475 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 gitlink:git-fast-import[1]. +into linkgit:git-fast-import[1]. You can use it as a human readable bundle replacement (see -gitlink:git-bundle[1]), or as a kind of an interactive -gitlink:git-filter-branch[1]. +linkgit:git-bundle[1]), or as a kind of an interactive +linkgit:git-filter-branch[1]. OPTIONS ------- --progress=<n>:: Insert 'progress' statements every <n> objects, to be shown by - gitlink:git-fast-import[1] during import. + linkgit:git-fast-import[1] during import. --signed-tags=(verbatim|warn|strip|abort):: Specify how to handle signed tags. Since any transformation @@ -65,7 +65,7 @@ referenced by that revision range contains the string Limitations ----------- -Since gitlink:git-fast-import[1] cannot tag trees, you will not be +Since linkgit:git-fast-import[1] 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. @@ -80,4 +80,4 @@ Documentation by Johannes E. Schindelin <johannes.schindelin@gmx.de>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-fast-import.txt b/Documentation/git-fast-import.txt index d511967..bd625ab 100644 --- a/Documentation/git-fast-import.txt +++ b/Documentation/git-fast-import.txt @@ -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 gitlink:git-init[1]) or incrementally +has already been initialized by linkgit:git-init[1]) 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 gitlink:git-pack-objects[1]. + to linkgit:git-pack-objects[1]. --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 gitlink:git-am[1] when applying patches +same parser used by linkgit:git-am[1] 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 -gitlink:git-update-index[1]. +linkgit:git-update-index[1]. + If separate `author` and `committer` commands are used in a `commit` the timestamps may not match, as the system clock will be polled @@ -411,7 +411,7 @@ Marks must be declared (via `mark`) before they can be used. * A complete 40 byte or abbreviated commit SHA-1 in hex. * Any valid Git SHA-1 expression that resolves to a commit. See - ``SPECIFYING REVISIONS'' in gitlink:git-rev-parse[1] for details. + ``SPECIFYING REVISIONS'' in linkgit:git-rev-parse[1] for details. The special case of restarting an incremental import from the current branch value should be written as: @@ -649,7 +649,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 gitlink:git-tag[1] process. +with the standard linkgit:git-tag[1] process. `reset` ~~~~~~~ @@ -863,7 +863,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 gitlink:git-blame[1] to track +Doing so will allow tools such as linkgit:git-blame[1] to track through the real commit history and properly annotate the source files. @@ -892,7 +892,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 gitlink:git-repack[1]. +\--window=50 (or higher) when you run linkgit:git-repack[1]. 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. @@ -1027,4 +1027,4 @@ Documentation by Shawn O. Pearce <spearce@spearce.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-fetch-pack.txt b/Documentation/git-fetch-pack.txt index a99a5b3..2b8ffe5 100644 --- a/Documentation/git-fetch-pack.txt +++ b/Documentation/git-fetch-pack.txt @@ -12,7 +12,7 @@ SYNOPSIS DESCRIPTION ----------- -Usually you would want to use gitlink:git-fetch[1] which is a +Usually you would want to use linkgit:git-fetch[1] which is a higher level wrapper of this command instead. Invokes 'git-upload-pack' on a potentially remote repository, @@ -93,4 +93,4 @@ Documentation by Junio C Hamano. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-fetch.txt b/Documentation/git-fetch.txt index 9003473..d982f96 100644 --- a/Documentation/git-fetch.txt +++ b/Documentation/git-fetch.txt @@ -39,7 +39,7 @@ include::urls-remotes.txt[] SEE ALSO -------- -gitlink:git-pull[1] +linkgit:git-pull[1] Author @@ -53,4 +53,4 @@ Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-filter-branch.txt b/Documentation/git-filter-branch.txt index 895d750..e22dfa5 100644 --- a/Documentation/git-filter-branch.txt +++ b/Documentation/git-filter-branch.txt @@ -72,7 +72,7 @@ OPTIONS This is the filter for modifying the environment in which the commit will be performed. Specifically, you might want to rewrite the author/committer name/email/time environment - variables (see gitlink:git-commit[1] for details). Do not forget + variables (see linkgit:git-commit[1] for details). Do not forget to re-export the variables. --tree-filter <command>:: @@ -86,13 +86,13 @@ OPTIONS --index-filter <command>:: This is the filter for rewriting the index. It is similar to the tree filter but does not check out the tree, which makes it much - faster. For hairy cases, see gitlink:git-update-index[1]. + faster. For hairy cases, see linkgit:git-update-index[1]. --parent-filter <command>:: 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 gitlink:git-commit-tree[1]: empty for + a format accepted by 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. @@ -105,7 +105,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 - gitlink:git-commit-tree[1] command, with arguments of the form + linkgit:git-commit-tree[1] 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. + @@ -116,7 +116,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 gitlink:git-rebase[1] instead). +that, use linkgit:git-rebase[1] instead). --tag-name-filter <command>:: This is the filter for rewriting tag names. When passed, @@ -159,7 +159,7 @@ definition impossible to preserve signatures at any rate.) <rev-list-options>:: When options are given after the new branch name, they will - be passed to gitlink:git-rev-list[1]. Only commits in the resulting + be passed to linkgit:git-rev-list[1]. Only commits in the resulting output will be filtered, although the filtered commits can still reference parents which are outside of that set. @@ -249,7 +249,7 @@ 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 gitlink:git-rebase[1]. +interactive mode of linkgit:git-rebase[1]. Consider this history: @@ -295,4 +295,4 @@ Documentation by Petr Baudis and the git list. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-fmt-merge-msg.txt b/Documentation/git-fmt-merge-msg.txt index 7088ed4..8615ae3 100644 --- a/Documentation/git-fmt-merge-msg.txt +++ b/Documentation/git-fmt-merge-msg.txt @@ -46,7 +46,7 @@ merge.summary:: SEE ALSO -------- -gitlink:git-merge[1] +linkgit:git-merge[1] Author @@ -59,4 +59,4 @@ Documentation by Petr Baudis, Junio C Hamano and the git-list <git@vger.kernel.o GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt index 6fb9429..651efe6 100644 --- a/Documentation/git-format-patch.txt +++ b/Documentation/git-format-patch.txt @@ -25,7 +25,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 gitlink:git-am[1]. +for use with linkgit:git-am[1]. There are two ways to specify which commits to operate on. @@ -34,7 +34,7 @@ There are two ways to specify which commits to operate on. that leads to the <since> to be output. 2. Generic <revision range> expression (see "SPECIFYING - REVISIONS" section in gitlink:git-rev-parse[1]) means the + REVISIONS" section in linkgit:git-rev-parse[1]) means the commits in the specified range. A single commit, when interpreted as a <revision range> @@ -192,7 +192,7 @@ git-format-patch -3:: See Also -------- -gitlink:git-am[1], gitlink:git-send-email[1] +linkgit:git-am[1], linkgit:git-send-email[1] Author @@ -205,4 +205,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-fsck-objects.txt b/Documentation/git-fsck-objects.txt index f21061e..6e9f717 100644 --- a/Documentation/git-fsck-objects.txt +++ b/Documentation/git-fsck-objects.txt @@ -13,5 +13,5 @@ SYNOPSIS DESCRIPTION ----------- -This is a synonym for gitlink:git-fsck[1]. Please refer to the +This is a synonym for linkgit:git-fsck[1]. Please refer to the documentation of that command. diff --git a/Documentation/git-fsck.txt b/Documentation/git-fsck.txt index 45c0bee..f16cb98 100644 --- a/Documentation/git-fsck.txt +++ b/Documentation/git-fsck.txt @@ -150,4 +150,4 @@ Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-gc.txt b/Documentation/git-gc.txt index 872056e..4b2dfef 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 gitlink:git-add[1]. +created from prior invocations of linkgit:git-add[1]. Users are encouraged to run this task on a regular basis within each repository to maintain good disk space utilization and good @@ -90,23 +90,23 @@ how long records of conflicted merge you have not resolved are kept. This defaults to 15 days. The optional configuration variable 'gc.packrefs' determines if -`git gc` runs `git-pack-refs`. Without the configuration, `git-pack-refs` -is not run in bare repositories by default, to allow older dumb-transport -clients fetch from the repository, but this will change in the future. +`git gc` runs `git-pack-refs`. This can be set to "nobare" to enable +it within all non-bare repos or it can be set to a boolean value. +This defaults to true. The optional configuration variable 'gc.aggressiveWindow' controls how much time is spent optimizing the delta compression of the objects in the repository when the --aggressive option is specified. The larger the value, the more time is spent optimizing the delta compression. See -the documentation for the --window' option in gitlink:git-repack[1] for +the documentation for the --window' option in linkgit:git-repack[1] for more details. This defaults to 10. See Also -------- -gitlink:git-prune[1] -gitlink:git-reflog[1] -gitlink:git-repack[1] -gitlink:git-rerere[1] +linkgit:git-prune[1] +linkgit:git-reflog[1] +linkgit:git-repack[1] +linkgit:git-rerere[1] Author ------ @@ -114,4 +114,4 @@ Written by Shawn O. Pearce <spearce@spearce.org> GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-get-tar-commit-id.txt b/Documentation/git-get-tar-commit-id.txt index 60d1c52..dea4149 100644 --- a/Documentation/git-get-tar-commit-id.txt +++ b/Documentation/git-get-tar-commit-id.txt @@ -14,7 +14,7 @@ SYNOPSIS DESCRIPTION ----------- Acts as a filter, extracting the commit ID stored in archives created by -gitlink:git-archive[1]. It reads only the first 1024 bytes of input, thus its +linkgit:git-archive[1]. 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 @@ -33,4 +33,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-grep.txt b/Documentation/git-grep.txt index 97faaa1..f3cb24f 100644 --- a/Documentation/git-grep.txt +++ b/Documentation/git-grep.txt @@ -143,4 +143,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-gui.txt b/Documentation/git-gui.txt index 13252a1..6d6cd5d 100644 --- a/Documentation/git-gui.txt +++ b/Documentation/git-gui.txt @@ -16,7 +16,7 @@ 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 gitlink:gitk[1], git-gui focuses on commit generation +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. @@ -112,4 +112,4 @@ Documentation by Shawn O. Pearce <spearce@spearce.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-hash-object.txt b/Documentation/git-hash-object.txt index 616f196..33030c0 100644 --- a/Documentation/git-hash-object.txt +++ b/Documentation/git-hash-object.txt @@ -42,4 +42,4 @@ Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt index a8ffcbe..fb77ca3 100644 --- a/Documentation/git-help.txt +++ b/Documentation/git-help.txt @@ -58,6 +58,16 @@ is available in PATH. + Note that the script tries, as much as possible, to display the HTML page in a new tab on an already opened browser. ++ +The following browsers are currently supported by 'git-help--browse': ++ +* firefox (this is the default under X Window when not using KDE) +* iceweasel +* konqueror (this is the default under KDE) +* w3m (this is the default outside X Window) +* links +* lynx +* dillo CONFIGURATION VARIABLES ----------------------- @@ -85,7 +95,7 @@ $ git config --global web.browser firefox ------------------------------------------------ as they are probably more user specific than repository specific. -See gitlink:git-config[1] for more information about this. +See linkgit:git-config[1] for more information about this. Author ------ @@ -94,10 +104,10 @@ Written by Junio C Hamano <gitster@pobox.com> and the git-list Documentation ------------- -Initial documentation was part of the gitlink:git[7] man page. +Initial documentation was part of the linkgit:git[7] man page. Christian Couder <chriscool@tuxfamily.org> extracted and rewrote it a little. Maintenance is done by the git-list <git@vger.kernel.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-http-fetch.txt b/Documentation/git-http-fetch.txt index 389c6ed..b784a9d 100644 --- a/Documentation/git-http-fetch.txt +++ b/Documentation/git-http-fetch.txt @@ -53,4 +53,4 @@ Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-http-push.txt b/Documentation/git-http-push.txt index 3a69b71..0b82722 100644 --- a/Documentation/git-http-push.txt +++ b/Documentation/git-http-push.txt @@ -15,6 +15,9 @@ DESCRIPTION Sends missing objects to remote repository, and updates the remote branch. +*NOTE*: This command is temporarily disabled if your cURL +library is older than 7.16, as the combination has been reported +not to work and sometimes corrupts repository. OPTIONS ------- @@ -98,4 +101,4 @@ Documentation by Nick Hengeveld GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-imap-send.txt b/Documentation/git-imap-send.txt index eca9e9c..522b73c 100644 --- a/Documentation/git-imap-send.txt +++ b/Documentation/git-imap-send.txt @@ -59,4 +59,4 @@ Documentation by Mike McCormack GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-index-pack.txt b/Documentation/git-index-pack.txt index bf5c2bd..72b5d00 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 - gitlink::git-repack[1]. + linkgit:git-repack[1]. --fix-thin:: - It is possible for gitlink:git-pack-objects[1] to build + It is possible for linkgit:git-pack-objects[1] 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 gitlink:git-repack[1] process from deleting + simultaneous linkgit:git-repack[1] process from deleting the newly constructed pack and index before refs can be updated to use objects contained in the pack. @@ -83,7 +83,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 gitlink:git-repack[1] +.keep file used as a lock to prevent the race with linkgit:git-repack[1] mentioned above. @@ -97,4 +97,4 @@ Documentation by Sergey Vlasov GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-init-db.txt b/Documentation/git-init-db.txt index d4e01cb..439cabb 100644 --- a/Documentation/git-init-db.txt +++ b/Documentation/git-init-db.txt @@ -14,5 +14,5 @@ SYNOPSIS DESCRIPTION ----------- -This is a synonym for gitlink:git-init[1]. Please refer to the +This is a synonym for linkgit:git-init[1]. Please refer to the documentation of that command. diff --git a/Documentation/git-init.txt b/Documentation/git-init.txt index e51351d..62914da 100644 --- a/Documentation/git-init.txt +++ b/Documentation/git-init.txt @@ -111,4 +111,4 @@ Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-instaweb.txt b/Documentation/git-instaweb.txt index d2ce779..841e8fa 100644 --- a/Documentation/git-instaweb.txt +++ b/Documentation/git-instaweb.txt @@ -84,4 +84,4 @@ Documentation by Eric Wong <normalperson@yhbt.net>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt index 5920d17..ebaee4b 100644 --- a/Documentation/git-log.txt +++ b/Documentation/git-log.txt @@ -14,19 +14,15 @@ DESCRIPTION ----------- Shows the commit logs. -The command takes options applicable to the gitlink:git-rev-list[1] +The command takes options applicable to the linkgit:git-rev-list[1] command to control what is shown and how, and options applicable to -the gitlink:git-diff-tree[1] commands to control how the changes +the linkgit:git-diff-tree[1] commands to control how the changes each commit introduces are shown. -This manual page describes only the most frequently used options. - OPTIONS ------- -include::pretty-options.txt[] - :git-log: 1 include::diff-options.txt[] @@ -39,18 +35,7 @@ include::diff-options.txt[] `HEAD`, i.e. the tip of the current branch. For a more complete list of ways to spell <since> and <until>, see "SPECIFYING REVISIONS" section in - gitlink:git-rev-parse[1]. - ---first-parent:: - Follow only the first parent commit upon seeing a merge - commit. This option gives a better overview of the - evolution of a particular branch. - --g, \--walk-reflogs:: - Show commits as they were recorded in the reflog. The log contains - a record about how the tip of a reference was changed. - Cannot be combined with --reverse. - See also gitlink:git-reflog[1]. + linkgit:git-rev-parse[1]. --decorate:: Print out the ref names of any commits that are shown. @@ -76,6 +61,8 @@ include::diff-options.txt[] Show only commits that affect the specified paths. +include::rev-list-options.txt[] + include::pretty-formats.txt[] include::diff-generate-patch.txt[] @@ -125,4 +112,4 @@ Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-lost-found.txt b/Documentation/git-lost-found.txt index 7f808fc..b1c797f 100644 --- a/Documentation/git-lost-found.txt +++ b/Documentation/git-lost-found.txt @@ -12,7 +12,7 @@ SYNOPSIS DESCRIPTION ----------- -*NOTE*: this command is deprecated. Use gitlink:git-fsck[1] with +*NOTE*: this command is deprecated. Use linkgit:git-fsck[1] with the option '--lost-found' instead. Finds dangling commits and tags from the object database, and @@ -78,4 +78,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-ls-files.txt b/Documentation/git-ls-files.txt index d0c3aa2..da9ebf4 100644 --- a/Documentation/git-ls-files.txt +++ b/Documentation/git-ls-files.txt @@ -106,7 +106,7 @@ OPTIONS -v:: Similar to `-t`, but use lowercase letters for files that are marked as 'assume unchanged' (see - gitlink:git-update-index[1]). + linkgit:git-update-index[1]). --full-name:: When run from a subdirectory, the command usually @@ -152,7 +152,7 @@ Exclude Patterns '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. gitlink:gitignore[5] +flags --others or --ignored are specified. linkgit:gitignore[5] specifies the format of exclude patterns. These exclude patterns come from these places, in order: @@ -179,7 +179,7 @@ pattern file appears in. See Also -------- -gitlink:git-read-tree[1], gitlink:gitignore[5] +linkgit:git-read-tree[1], linkgit:gitignore[5] Author @@ -192,4 +192,4 @@ Documentation by David Greaves, Junio C Hamano, Josh Triplett, and the git-list GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-ls-remote.txt b/Documentation/git-ls-remote.txt index 445beda..c5ba0aa 100644 --- a/Documentation/git-ls-remote.txt +++ b/Documentation/git-ls-remote.txt @@ -27,7 +27,7 @@ OPTIONS displayed. -u <exec>, --upload-pack=<exec>:: - Specify the full path of gitlink:git-upload-pack[1] on the remote + Specify the full path of linkgit:git-upload-pack[1] 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. @@ -69,4 +69,4 @@ Written by Junio C Hamano <junkio@cox.net> GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-ls-tree.txt b/Documentation/git-ls-tree.txt index 7b78599..360c0a1 100644 --- a/Documentation/git-ls-tree.txt +++ b/Documentation/git-ls-tree.txt @@ -91,4 +91,4 @@ Documentation by David Greaves, Junio C Hamano and the git-list GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-mailinfo.txt b/Documentation/git-mailinfo.txt index 64aa6a1..3846f0e 100644 --- a/Documentation/git-mailinfo.txt +++ b/Documentation/git-mailinfo.txt @@ -18,7 +18,7 @@ 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 to create a commit. It is usually not necessary to use this -command directly. See gitlink:git-am[1] instead. +command directly. See linkgit:git-am[1] instead. OPTIONS @@ -66,4 +66,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-mailsplit.txt b/Documentation/git-mailsplit.txt index c4f4cab..8243f69 100644 --- a/Documentation/git-mailsplit.txt +++ b/Documentation/git-mailsplit.txt @@ -55,4 +55,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-merge-base.txt b/Documentation/git-merge-base.txt index 6b71880..07f78b4 100644 --- a/Documentation/git-merge-base.txt +++ b/Documentation/git-merge-base.txt @@ -39,4 +39,4 @@ Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-merge-file.txt b/Documentation/git-merge-file.txt index 31882ab..c513184 100644 --- a/Documentation/git-merge-file.txt +++ b/Documentation/git-merge-file.txt @@ -41,7 +41,7 @@ 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 implements all of RCS merge's functionality which is needed by -gitlink:git[1]. +linkgit:git[1]. OPTIONS @@ -89,4 +89,4 @@ with parts copied from the original documentation of RCS merge. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-merge-index.txt b/Documentation/git-merge-index.txt index b726ddf..5d816d0 100644 --- a/Documentation/git-merge-index.txt +++ b/Documentation/git-merge-index.txt @@ -84,4 +84,4 @@ Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-merge-one-file.txt b/Documentation/git-merge-one-file.txt index f35d0e1..ee95df3 100644 --- a/Documentation/git-merge-one-file.txt +++ b/Documentation/git-merge-one-file.txt @@ -26,4 +26,4 @@ Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-merge-tree.txt b/Documentation/git-merge-tree.txt index 6892fda..4cc0964 100644 --- a/Documentation/git-merge-tree.txt +++ b/Documentation/git-merge-tree.txt @@ -33,4 +33,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt index eabd7ef..0c9ad7f 100644 --- a/Documentation/git-merge.txt +++ b/Documentation/git-merge.txt @@ -42,7 +42,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 -gitlink:git-reset[1]. +linkgit:git-reset[1]. CONFIGURATION ------------- @@ -74,14 +74,14 @@ it happens. In other words, `git-diff --cached HEAD` must report no changes. [NOTE] -This is a bit of lie. In certain special cases, your index are -allowed to be different from the tree of `HEAD` commit. The most +This is a bit of a lie. In certain special cases, your index is +allowed to be different from the tree of the `HEAD` commit. The most notable case is when your `HEAD` commit is already ahead of what is being merged, in which case your index can have arbitrary -difference from your `HEAD` commit. Otherwise, your index entries -are allowed have differences from your `HEAD` commit that match -the result of trivial merge (e.g. you received the same patch -from external source to produce the same result as what you are +differences from your `HEAD` commit. Also, your index entries +may have differences from your `HEAD` commit that match +the result of a trivial merge (e.g. you received the same patch +from an external source to produce the same result as what you are merging). For example, if a path did not exist in the common ancestor and your head commit but exists in the tree you are merging into your repository, and if you already happen to have @@ -163,7 +163,8 @@ After seeing a conflict, you can do two things: SEE ALSO -------- -gitlink:git-fmt-merge-msg[1], gitlink:git-pull[1] +linkgit:git-fmt-merge-msg[1], linkgit:git-pull[1], +linkgit:gitattributes[5] Author @@ -177,4 +178,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-mergetool.txt b/Documentation/git-mergetool.txt index a26c260..50f106e 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 gitlink:git-merge[1]. +merge conflicts. It is typically run after linkgit:git-merge[1]. 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 @@ -48,4 +48,4 @@ Documentation by Theodore Y Ts'o. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-mktag.txt b/Documentation/git-mktag.txt index ea7a752..82db9f5 100644 --- a/Documentation/git-mktag.txt +++ b/Documentation/git-mktag.txt @@ -43,4 +43,4 @@ Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-mktree.txt b/Documentation/git-mktree.txt index 638abc7..f312036 100644 --- a/Documentation/git-mktree.txt +++ b/Documentation/git-mktree.txt @@ -31,4 +31,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-mv.txt b/Documentation/git-mv.txt index 3b8ca76..bff3fbe 100644 --- a/Documentation/git-mv.txt +++ b/Documentation/git-mv.txt @@ -50,4 +50,4 @@ Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-name-rev.txt b/Documentation/git-name-rev.txt index 306e1a4..efcabdc 100644 --- a/Documentation/git-name-rev.txt +++ b/Documentation/git-name-rev.txt @@ -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 gitlink::git-describe[1] more closely. This option + of linkgit:git-describe[1] more closely. This option cannot be combined with --stdin. EXAMPLE @@ -75,4 +75,4 @@ Documentation by Johannes Schindelin. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-pack-objects.txt b/Documentation/git-pack-objects.txt index 5237ab0..8353be1 100644 --- a/Documentation/git-pack-objects.txt +++ b/Documentation/git-pack-objects.txt @@ -58,7 +58,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 gitlink:git-rev-list[1] with `--objects` flag + the same way as linkgit:git-rev-list[1] with `--objects` flag uses its `commit` arguments to build the list of objects it outputs. The objects on the resulting list are packed. @@ -99,7 +99,8 @@ base-name:: --max-pack-size=<n>:: Maximum size of each output packfile, expressed in MiB. If specified, multiple packfiles may be created. - The default is unlimited. + The default is unlimited, unless the config variable + `pack.packSizeLimit` is set. --incremental:: This flag causes an object already in a pack ignored @@ -193,10 +194,10 @@ Documentation by Junio C Hamano See Also -------- -gitlink:git-rev-list[1] -gitlink:git-repack[1] -gitlink:git-prune-packed[1] +linkgit:git-rev-list[1] +linkgit:git-repack[1] +linkgit:git-prune-packed[1] GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-pack-redundant.txt b/Documentation/git-pack-redundant.txt index f2ceeba..af4aa4a 100644 --- a/Documentation/git-pack-redundant.txt +++ b/Documentation/git-pack-redundant.txt @@ -48,10 +48,10 @@ Documentation by Lukas Sandström <lukass@etek.chalmers.se> See Also -------- -gitlink:git-pack-objects[1] -gitlink:git-repack[1] -gitlink:git-prune-packed[1] +linkgit:git-pack-objects[1] +linkgit:git-repack[1] +linkgit:git-prune-packed[1] GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-pack-refs.txt b/Documentation/git-pack-refs.txt index a20fc7d..e4ff934 100644 --- a/Documentation/git-pack-refs.txt +++ b/Documentation/git-pack-refs.txt @@ -63,4 +63,4 @@ Written by Linus Torvalds <torvalds@osdl.org> GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-parse-remote.txt b/Documentation/git-parse-remote.txt index 11b1f4d..deb8b2f 100644 --- a/Documentation/git-parse-remote.txt +++ b/Documentation/git-parse-remote.txt @@ -47,4 +47,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-patch-id.txt b/Documentation/git-patch-id.txt index ad528a9..894852a 100644 --- a/Documentation/git-patch-id.txt +++ b/Documentation/git-patch-id.txt @@ -39,4 +39,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-peek-remote.txt b/Documentation/git-peek-remote.txt index 09b005b..0001710 100644 --- a/Documentation/git-peek-remote.txt +++ b/Documentation/git-peek-remote.txt @@ -47,4 +47,4 @@ Documentation by Junio C Hamano. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-prune-packed.txt b/Documentation/git-prune-packed.txt index 9f85f38..93ee82a 100644 --- a/Documentation/git-prune-packed.txt +++ b/Documentation/git-prune-packed.txt @@ -44,9 +44,9 @@ Documentation by Ryan Anderson <ryan@michonline.com> See Also -------- -gitlink:git-pack-objects[1] -gitlink:git-repack[1] +linkgit:git-pack-objects[1] +linkgit:git-repack[1] GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-prune.txt b/Documentation/git-prune.txt index 9835bdb..f151cff 100644 --- a/Documentation/git-prune.txt +++ b/Documentation/git-prune.txt @@ -60,4 +60,4 @@ Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-pull.txt b/Documentation/git-pull.txt index d4d26af..179bdfc 100644 --- a/Documentation/git-pull.txt +++ b/Documentation/git-pull.txt @@ -25,6 +25,7 @@ OPTIONS ------- include::merge-options.txt[] +:git-pull: 1 include::fetch-options.txt[] include::pull-fetch-param.txt[] @@ -34,11 +35,15 @@ include::urls-remotes.txt[] include::merge-strategies.txt[] \--rebase:: - Instead of a merge, perform a rebase after fetching. - *NOTE:* This is a potentially _dangerous_ mode of operation. - It rewrites history, which does not bode well when you - published that history already. Do *not* use this option - unless you have read gitlink:git-rebase[1] carefully. + Instead of a merge, perform a rebase after fetching. If + there is a remote ref for the upstream branch, and this branch + was rebased since last fetched, the rebase uses that information + to avoid rebasing non-local changes. ++ +*NOTE:* This is a potentially _dangerous_ mode of operation. +It rewrites history, which does not bode well when you +published that history already. Do *not* use this option +unless you have read linkgit:git-rebase[1] carefully. \--no-rebase:: Override earlier \--rebase. @@ -106,7 +111,7 @@ git pull, git pull origin:: current branch. Normally the branch merged in is the HEAD of the remote repository, but the choice is determined by the branch.<name>.remote and - branch.<name>.merge options; see gitlink:git-config[1] + branch.<name>.merge options; see linkgit:git-config[1] for details. git pull origin next:: @@ -153,12 +158,12 @@ 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 -gitlink:git-reset[1]. +linkgit:git-reset[1]. SEE ALSO -------- -gitlink:git-fetch[1], gitlink:git-merge[1], gitlink:git-config[1] +linkgit:git-fetch[1], linkgit:git-merge[1], linkgit:git-config[1] Author @@ -174,4 +179,4 @@ Junio C Hamano and the git-list <git@vger.kernel.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-push.txt b/Documentation/git-push.txt index b8003c6..5f24944 100644 --- a/Documentation/git-push.txt +++ b/Documentation/git-push.txt @@ -20,7 +20,7 @@ necessary to complete the given refs. You can make interesting things happen to a repository every time you push into it, by setting up 'hooks' there. See -documentation for gitlink:git-receive-pack[1]. +documentation for linkgit:git-receive-pack[1]. OPTIONS @@ -145,4 +145,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-quiltimport.txt b/Documentation/git-quiltimport.txt index 1c3ef4c..0fc2b56 100644 --- a/Documentation/git-quiltimport.txt +++ b/Documentation/git-quiltimport.txt @@ -57,4 +57,4 @@ Documentation by Eric Biederman <ebiederm@lnxi.com> GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-read-tree.txt b/Documentation/git-read-tree.txt index 74c5478..8421d1f 100644 --- a/Documentation/git-read-tree.txt +++ b/Documentation/git-read-tree.txt @@ -15,7 +15,7 @@ DESCRIPTION ----------- Reads the tree information given by <tree-ish> into the index, but does not actually *update* any of the files it "caches". (see: -gitlink:git-checkout-index[1]) +linkgit:git-checkout-index[1]) Optionally, it can merge a tree into the index, perform a fast-forward (i.e. 2-way) merge, or a 3-way merge, with the `-m` @@ -347,8 +347,8 @@ have finished your work-in-progress), attempt the merge again. See Also -------- -gitlink:git-write-tree[1]; gitlink:git-ls-files[1]; -gitlink:gitignore[5] +linkgit:git-write-tree[1]; linkgit:git-ls-files[1]; +linkgit:gitignore[5] Author @@ -361,4 +361,4 @@ Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt index e4326d3..c11c645 100644 --- a/Documentation/git-rebase.txt +++ b/Documentation/git-rebase.txt @@ -235,7 +235,7 @@ OPTIONS --whitespace=<nowarn|warn|error|error-all|strip>:: This flag is passed to the `git-apply` program - (see gitlink:git-apply[1]) that applies the patch. + (see linkgit:git-apply[1]) that applies the patch. -i, \--interactive:: Make a list of the commits which are about to be rebased. Let the @@ -374,8 +374,8 @@ add other commits. This can be used to split a commit into two: 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 gitlink:git-add[1] (possibly interactively) and/or - gitlink:git-gui[1] to do that. + commit. You can use linkgit:git-add[1] (possibly interactively) and/or + linkgit:git-gui[1] to do that. - Commit the now-current index with whatever commit message is appropriate now. @@ -386,7 +386,7 @@ add other commits. This can be used to split a commit into two: If you are not absolutely sure that the intermediate revisions are consistent (they compile, pass the testsuite, etc.) you should use -gitlink:git-stash[1] to stash away the not-yet-committed changes +linkgit:git-stash[1] to stash away the not-yet-committed changes after each commit, test, and amend the commit if fixes are necessary. @@ -401,4 +401,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-receive-pack.txt b/Documentation/git-receive-pack.txt index 2633d94..4111434 100644 --- a/Documentation/git-receive-pack.txt +++ b/Documentation/git-receive-pack.txt @@ -149,7 +149,7 @@ if the repository is packed and is served via a dumb transport. SEE ALSO -------- -gitlink:git-send-pack[1] +linkgit:git-send-pack[1] Author @@ -162,4 +162,4 @@ Documentation by Junio C Hamano. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-reflog.txt b/Documentation/git-reflog.txt index 25003c3..f9bba36 100644 --- a/Documentation/git-reflog.txt +++ b/Documentation/git-reflog.txt @@ -28,19 +28,19 @@ The subcommand "expire" is used to prune older reflog entries. Entries older than `expire` time, or entries older than `expire-unreachable` time and are not reachable from the current tip, are removed from the reflog. This is typically not used -directly by the end users -- instead, see gitlink:git-gc[1]. +directly by the end users -- instead, see linkgit:git-gc[1]. The subcommand "show" (which is also the default, in the absence of any subcommands) will take all the normal log options, and show the log of the reference provided in the command-line (or `HEAD`, by default). The reflog will cover all recent actions (HEAD reflog records branch switching as well). It is an alias for 'git log -g --abbrev-commit --pretty=oneline'; -see gitlink:git-log[1]. +see linkgit:git-log[1]. The reflog is useful in various git commands, to specify the old value of a reference. For example, `HEAD@\{2\}` means "where HEAD used to be two moves ago", `master@\{one.week.ago\}` means "where master used to -point to one week ago", and so on. See gitlink:git-rev-parse[1] for +point to one week ago", and so on. See linkgit:git-rev-parse[1] for more details. @@ -88,4 +88,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-relink.txt b/Documentation/git-relink.txt index fe631bb..1b024de 100644 --- a/Documentation/git-relink.txt +++ b/Documentation/git-relink.txt @@ -7,12 +7,13 @@ git-relink - Hardlink common objects in local repositories SYNOPSIS -------- -'git-relink' [--safe] <dir> <dir> [<dir>]\* +'git-relink' [--safe] <dir> [<dir>]\* <master_dir> DESCRIPTION ----------- -This will scan 2 or more object repositories and look for common objects, check -if they are hardlinked, and replace one with a hardlink to the other if not. +This will scan 1 or more object repositories and look for objects in common +with a master repository. Objects not already hardlinked to the master +repository will be replaced with a hardlink to the master repository. OPTIONS ------- @@ -33,4 +34,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-remote.txt b/Documentation/git-remote.txt index 4b263c2..2cbd1f7 100644 --- a/Documentation/git-remote.txt +++ b/Documentation/git-remote.txt @@ -10,7 +10,7 @@ SYNOPSIS -------- [verse] 'git-remote' -'git-remote' add [-t <branch>] [-m <branch>] [-f] [--mirror] <name> <url> +'git-remote' add [-t <branch>] [-m <master>] [-f] [--mirror] <name> <url> 'git-remote' rm <name> 'git-remote' show <name> 'git-remote' prune <name> @@ -81,7 +81,7 @@ remotes.<group>. If a named group is not specified on the command line, the configuration parameter remotes.default will get used; if remotes.default is not defined, all remotes which do not have the configuration parameter remote.<name>.skipDefaultUpdate set to true will -be updated. (See gitlink:git-config[1]). +be updated. (See linkgit:git-config[1]). DISCUSSION @@ -89,7 +89,7 @@ DISCUSSION The remote configuration is achieved using the `remote.origin.url` and `remote.origin.fetch` configuration variables. (See -gitlink:git-config[1]). +linkgit:git-config[1]). Examples -------- @@ -128,9 +128,9 @@ $ git merge origin See Also -------- -gitlink:git-fetch[1] -gitlink:git-branch[1] -gitlink:git-config[1] +linkgit:git-fetch[1] +linkgit:git-branch[1] +linkgit:git-config[1] Author ------ @@ -144,4 +144,4 @@ Documentation by J. Bruce Fields and the git-list <git@vger.kernel.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-repack.txt b/Documentation/git-repack.txt index 12e2079..3d95749 100644 --- a/Documentation/git-repack.txt +++ b/Documentation/git-repack.txt @@ -40,19 +40,19 @@ OPTIONS -d:: After packing, if the newly created packs make some existing packs redundant, remove the redundant packs. - Also runs gitlink:git-prune-packed[1]. + Also runs linkgit:git-prune-packed[1]. -l:: Pass the `--local` option to `git pack-objects`, see - gitlink:git-pack-objects[1]. + linkgit:git-pack-objects[1]. -f:: Pass the `--no-reuse-delta` option to `git pack-objects`, see - gitlink:git-pack-objects[1]. + linkgit:git-pack-objects[1]. -q:: Pass the `-q` option to `git pack-objects`, see - gitlink:git-pack-objects[1]. + linkgit:git-pack-objects[1]. -n:: Do not update the server information with @@ -109,9 +109,9 @@ Documentation by Ryan Anderson <ryan@michonline.com> See Also -------- -gitlink:git-pack-objects[1] -gitlink:git-prune-packed[1] +linkgit:git-pack-objects[1] +linkgit:git-prune-packed[1] GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-repo-config.txt b/Documentation/git-repo-config.txt index 2deba31..2ca3994 100644 --- a/Documentation/git-repo-config.txt +++ b/Documentation/git-repo-config.txt @@ -14,5 +14,5 @@ SYNOPSIS DESCRIPTION ----------- -This is a synonym for gitlink:git-config[1]. Please refer to the +This is a synonym for linkgit:git-config[1]. Please refer to the documentation of that command. diff --git a/Documentation/git-request-pull.txt b/Documentation/git-request-pull.txt index 087eeb7..270df9b 100644 --- a/Documentation/git-request-pull.txt +++ b/Documentation/git-request-pull.txt @@ -36,4 +36,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-rerere.txt b/Documentation/git-rerere.txt index 8ce492c..a53858e 100644 --- a/Documentation/git-rerere.txt +++ b/Documentation/git-rerere.txt @@ -22,6 +22,10 @@ automerge results and corresponding hand-resolve results on the initial manual merge, and later by noticing the same automerge results and applying the previously recorded hand resolution. +[NOTE] +You need to set the configuration variable rerere.enabled to +enable this command. + COMMANDS -------- @@ -33,7 +37,7 @@ its working state. 'clear':: This resets the metadata used by rerere if a merge resolution is to be -is aborted. Calling gitlink:git-am[1] --skip or gitlink:git-rebase[1] +is aborted. Calling linkgit:git-am[1] --skip or linkgit:git-rebase[1] [--skip|--abort] will automatically invoke this command. 'diff':: @@ -204,4 +208,4 @@ Written by Junio C Hamano <junkio@cox.net> GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-reset.txt b/Documentation/git-reset.txt index 050e4ea..a4e0a77 100644 --- a/Documentation/git-reset.txt +++ b/Documentation/git-reset.txt @@ -9,7 +9,7 @@ SYNOPSIS -------- [verse] 'git-reset' [--mixed | --soft | --hard] [-q] [<commit>] -'git-reset' [--mixed] [-q] <commit> [--] <paths>... +'git-reset' [--mixed] [-q] [<commit>] [--] <paths>... DESCRIPTION ----------- @@ -21,7 +21,7 @@ commit (or set of commits) and want to redo that part without showing the undo in the history. If you want to undo a commit other than the latest on a branch, -gitlink:git-revert[1] is your friend. +linkgit:git-revert[1] is your friend. The second form with 'paths' is used to revert selected paths in the index from a given commit, without moving HEAD. @@ -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 "Added but not yet committed", as gitlink:git-status[1] would + files "Added but not yet committed", as linkgit:git-status[1] would put it. --hard:: @@ -49,7 +49,7 @@ OPTIONS Be quiet, only report errors. <commit>:: - Commit to make the current HEAD. + Commit to make the current HEAD. If not given defaults to HEAD. Examples -------- @@ -71,7 +71,7 @@ message, or both. Leaves working tree as it was before "reset". commit by starting with its log message. If you do not need to edit the message further, you can give -C option instead. + -See also the --amend option to gitlink:git-commit[1]. +See also the --amend option to linkgit:git-commit[1]. Undo commits permanently:: + @@ -186,4 +186,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-rev-list.txt b/Documentation/git-rev-list.txt index a03f9fe..5b96eab 100644 --- a/Documentation/git-rev-list.txt +++ b/Documentation/git-rev-list.txt @@ -15,6 +15,7 @@ SYNOPSIS [ \--min-age=timestamp ] [ \--sparse ] [ \--no-merges ] + [ \--first-parent ] [ \--remove-empty ] [ \--full-history ] [ \--not ] @@ -78,363 +79,17 @@ between the two operands. The following two commands are equivalent: $ git-rev-list A...B ----------------------------------------------------------------------- -gitlink:git-rev-list[1] is a very essential git program, since it +linkgit:git-rev-list[1] 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 gitlink:git-bisect[1] and -gitlink:git-repack[1]. +used by commands as different as linkgit:git-bisect[1] and +linkgit:git-repack[1]. OPTIONS ------- -Commit Formatting -~~~~~~~~~~~~~~~~~ - -Using these options, gitlink:git-rev-list[1] will act similar to the -more specialized family of commit log tools: gitlink:git-log[1], -gitlink:git-show[1], and gitlink:git-whatchanged[1] - -include::pretty-options.txt[] - ---relative-date:: - - Synonym for `--date=relative`. - ---date={relative,local,default,iso,rfc}:: - - Only takes effect for dates shown in human-readable format, such - as when using "--pretty". -+ -`--date=relative` shows dates relative to the current time, -e.g. "2 hours ago". -+ -`--date=local` shows timestamps in user's local timezone. -+ -`--date=iso` (or `--date=iso8601`) shows timestamps in ISO 8601 format. -+ -`--date=rfc` (or `--date=rfc2822`) shows timestamps in RFC 2822 -format, often found in E-mail messages. -+ -`--date=short` shows only date but not time, in `YYYY-MM-DD` format. -+ -`--date=default` shows timestamps in the original timezone -(either committer's or author's). - ---header:: - - Print the contents of the commit in raw-format; each record is - separated with a NUL character. - ---parents:: - - Print the parents of the commit. - ---timestamp:: - Print the raw commit timestamp. - ---left-right:: - - Mark which side of a symmetric diff a commit is reachable from. - Commits from the left side are prefixed with `<` and those from - the right with `>`. If combined with `--boundary`, those - commits are prefixed with `-`. -+ -For example, if you have this topology: -+ ------------------------------------------------------------------------ - y---b---b branch B - / \ / - / . - / / \ - o---x---a---a branch A ------------------------------------------------------------------------ -+ -you would get an output line this: -+ ------------------------------------------------------------------------ - $ git rev-list --left-right --boundary --pretty=oneline A...B - - >bbbbbbb... 3rd on b - >bbbbbbb... 2nd on b - <aaaaaaa... 3rd on a - <aaaaaaa... 2nd on a - -yyyyyyy... 1st on b - -xxxxxxx... 1st on a ------------------------------------------------------------------------ - -Diff Formatting -~~~~~~~~~~~~~~~ - -Below are listed options that control the formatting of diff output. -Some of them are specific to gitlink:git-rev-list[1], however other diff -options may be given. See gitlink:git-diff-files[1] for more options. - --c:: - - This flag changes the way a merge commit is displayed. It shows - the differences from each of the parents to the merge result - simultaneously instead of showing pairwise diff between a parent - and the result one at a time. Furthermore, it lists only files - which were modified from all parents. - ---cc:: - - This flag implies the '-c' options and further compresses the - patch output by omitting hunks that show differences from only - one parent, or show the same change from all but one parent for - an Octopus merge. - --r:: - - Show recursive diffs. - --t:: - - Show the tree objects in the diff output. This implies '-r'. - -Commit Limiting -~~~~~~~~~~~~~~~ - -Besides specifying a range of commits that should be listed using the -special notations explained in the description, additional commit -limiting may be applied. - --- - --n 'number', --max-count='number':: - - Limit the number of commits output. - ---skip='number':: - - Skip 'number' commits before starting to show the commit output. - ---since='date', --after='date':: - - Show commits more recent than a specific date. - ---until='date', --before='date':: - - Show commits older than a specific date. - ---max-age='timestamp', --min-age='timestamp':: - - Limit the commits output to specified time range. - ---author='pattern', --committer='pattern':: - - Limit the commits output to ones with author/committer - header lines that match the specified pattern (regular expression). - ---grep='pattern':: - - Limit the commits output to ones with log message that - matches the specified pattern (regular expression). - --i, --regexp-ignore-case:: - - Match the regexp limiting patterns without regard to letters case. - --E, --extended-regexp:: - - Consider the limiting patterns to be extended regular expressions - instead of the default basic regular expressions. - ---remove-empty:: - - Stop when a given path disappears from the tree. - ---full-history:: - - Show also parts of history irrelevant to current state of a given - path. This turns off history simplification, which removed merges - which didn't change anything at all at some child. It will still actually - simplify away merges that didn't change anything at all into either - child. - ---no-merges:: - - Do not print commits with more than one parent. - ---not:: - - Reverses the meaning of the '{caret}' prefix (or lack thereof) - for all following revision specifiers, up to the next '--not'. - ---all:: - - Pretend as if all the refs in `$GIT_DIR/refs/` are listed on the - command line as '<commit>'. - ---stdin:: - - In addition to the '<commit>' listed on the command - line, read them from the standard input. - ---quiet:: - - Don't print anything to standard output. This form of - git-rev-list is primarily meant to allow the caller to - test the exit status to see if a range of objects is fully - connected (or not). It is faster than redirecting stdout - to /dev/null as the output does not have to be formatted. - ---cherry-pick:: - - Omit any commit that introduces the same change as - another commit on the "other side" when the set of - commits are limited with symmetric difference. -+ -For example, if you have two branches, `A` and `B`, a usual way -to list all commits on only one side of them is with -`--left-right`, like the example above in the description of -that option. It however shows the commits that were cherry-picked -from the other branch (for example, "3rd on b" may be cherry-picked -from branch A). With this option, such pairs of commits are -excluded from the output. - --g, --walk-reflogs:: - - Instead of walking the commit ancestry chain, walk - reflog entries from the most recent one to older ones. - When this option is used you cannot specify commits to - exclude (that is, '{caret}commit', 'commit1..commit2', - nor 'commit1...commit2' notations cannot be used). -+ -With '\--pretty' format other than oneline (for obvious reasons), -this causes the output to have two extra lines of information -taken from the reflog. By default, 'commit@\{Nth}' notation is -used in the output. When the starting commit is specified as -'commit@{now}', output also uses 'commit@\{timestamp}' notation -instead. Under '\--pretty=oneline', the commit message is -prefixed with this information on the same line. - -Cannot be combined with '\--reverse'. - ---merge:: - - After a failed merge, show refs that touch files having a - conflict and don't exist on all heads to merge. - ---boundary:: - - Output uninteresting commits at the boundary, which are usually - not shown. - ---dense, --sparse:: - -When optional paths are given, the default behaviour ('--dense') is to -only output commits that changes at least one of them, and also ignore -merges that do not touch the given paths. - -Use the '--sparse' flag to makes the command output all eligible commits -(still subject to count and age limitation), but apply merge -simplification nevertheless. - ---bisect:: - -Limit output to the one commit object which is roughly halfway between -the included and excluded commits. Thus, if - ------------------------------------------------------------------------ - $ git-rev-list --bisect foo ^bar ^baz ------------------------------------------------------------------------ - -outputs 'midpoint', the output of the two commands - ------------------------------------------------------------------------ - $ git-rev-list foo ^midpoint - $ git-rev-list midpoint ^bar ^baz ------------------------------------------------------------------------ - -would be of roughly the same length. Finding the change which -introduces a regression is thus reduced to a binary search: repeatedly -generate and test new 'midpoint's until the commit chain is of length -one. - ---bisect-vars:: - -This calculates the same as `--bisect`, but outputs text ready -to be eval'ed by the shell. These lines will assign the name of -the midpoint revision to the variable `bisect_rev`, and the -expected number of commits to be tested after `bisect_rev` is -tested to `bisect_nr`, the expected number of commits to be -tested if `bisect_rev` turns out to be good to `bisect_good`, -the expected number of commits to be tested if `bisect_rev` -turns out to be bad to `bisect_bad`, and the number of commits -we are bisecting right now to `bisect_all`. - ---bisect-all:: - -This outputs all the commit objects between the included and excluded -commits, ordered by their distance to the included and excluded -commits. The farthest from them is displayed first. (This is the only -one displayed by `--bisect`.) - -This is useful because it makes it easy to choose a good commit to -test when you want to avoid to test some of them for some reason (they -may not compile for example). - -This option can be used along with `--bisect-vars`, in this case, -after all the sorted commit objects, there will be the same text as if -`--bisect-vars` had been used alone. - --- - -Commit Ordering -~~~~~~~~~~~~~~~ - -By default, the commits are shown in reverse chronological order. - ---topo-order:: - - This option makes them appear in topological order (i.e. - descendant commits are shown before their parents). - ---date-order:: - - This option is similar to '--topo-order' in the sense that no - parent comes before all of its children, but otherwise things - are still ordered in the commit timestamp order. - ---reverse:: - - Output the commits in reverse order. - Cannot be combined with '\--walk-reflogs'. - -Object Traversal -~~~~~~~~~~~~~~~~ - -These options are mostly targeted for packing of git repositories. - ---objects:: - - Print the object IDs of any object referenced by the listed - commits. 'git-rev-list --objects foo ^bar' thus means "send me - all object IDs which I need to download if I have the commit - object 'bar', but not 'foo'". - ---objects-edge:: - - Similar to '--objects', but also print the IDs of excluded - commits prefixed with a "-" character. This is used by - gitlink:git-pack-objects[1] to build "thin" pack, which records - objects in deltified form based on objects contained in these - excluded commits to reduce network traffic. - ---unpacked:: - - Only useful with '--objects'; print the object IDs that are not - in packs. - ---no-walk:: - - Only show the given revs, but do not traverse their ancestors. - ---do-walk:: - - Overrides a previous --no-walk. - +:git-rev-list: 1 +include::rev-list-options.txt[] include::pretty-formats.txt[] @@ -450,4 +105,4 @@ and the git-list <git@vger.kernel.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-rev-parse.txt b/Documentation/git-rev-parse.txt index 329fce0..f02f6bb 100644 --- a/Documentation/git-rev-parse.txt +++ b/Documentation/git-rev-parse.txt @@ -70,6 +70,13 @@ OPTIONS possible '{caret}' prefix); this option makes them output in a form as close to the original input as possible. +--symbolic-full-name:: + This is similar to \--symbolic, but it omits input that + are not refs (i.e. branch or tag names; or more + explicitly disambiguating "heads/master" form, when you + want to name the "master" branch when there is an + unfortunately named tag "master"), and show them as full + refnames (e.g. "refs/heads/master"). --all:: Show all refs found in `$GIT_DIR/refs`. @@ -222,13 +229,13 @@ blobs contained in a commit. * A colon, optionally followed by a stage number (0 to 3) and a colon, followed by a path; this names a blob object in the index at the given path. Missing stage number (and the colon - that follows it) names an stage 0 entry. During a merge, stage + that follows it) names a stage 0 entry. During a merge, stage 1 is the common ancestor, stage 2 is the target branch's version (typically the current branch), and stage 3 is the version from the branch being merged. -Here is an illustration, by Jon Loeliger. Both node B and C are -a commit parents of commit node A. Parent commits are ordered +Here is an illustration, by Jon Loeliger. Both commit nodes B +and C are parents of commit node A. Parent commits are ordered left-to-right. G H I J @@ -284,7 +291,7 @@ and its parent commits exists. `r1{caret}@` notation means all parents of `r1`. `r1{caret}!` includes commit `r1` but excludes its all parents. -Here are a handful examples: +Here are a handful of examples: D G H D D F G H I J D F @@ -371,4 +378,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-revert.txt b/Documentation/git-revert.txt index 3457c40..93e20f7 100644 --- a/Documentation/git-revert.txt +++ b/Documentation/git-revert.txt @@ -20,11 +20,11 @@ OPTIONS <commit>:: Commit to revert. For a more complete list of ways to spell commit names, see - "SPECIFYING REVISIONS" section in gitlink:git-rev-parse[1]. + "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1]. -e|--edit:: With this option, `git-revert` will let you edit the commit - message prior committing the revert. This is the default if + message prior to committing the revert. This is the default if you run the command from a terminal. -m parent-number|--mainline parent-number:: @@ -62,4 +62,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-rm.txt b/Documentation/git-rm.txt index 48c1d97..dc36c66 100644 --- a/Documentation/git-rm.txt +++ b/Documentation/git-rm.txt @@ -83,7 +83,7 @@ git-rm -f git-*.sh:: See Also -------- -gitlink:git-add[1] +linkgit:git-add[1] Author ------ @@ -95,4 +95,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt index f0bd285..0554f2b 100644 --- a/Documentation/git-send-email.txt +++ b/Documentation/git-send-email.txt @@ -137,6 +137,8 @@ The --cc option must be repeated for each user you want on the cc list. Specify the primary recipient of the emails generated. Generally, this will be the upstream maintainer of the project involved. + Default is the value of the 'sendemail.to' configuration value; + if that is unspecified, this will be prompted for. + The --to option must be repeated for each user you want on the to list. @@ -196,4 +198,4 @@ Documentation by Ryan Anderson GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-send-pack.txt b/Documentation/git-send-pack.txt index a2d9cb6..777515b 100644 --- a/Documentation/git-send-pack.txt +++ b/Documentation/git-send-pack.txt @@ -12,7 +12,7 @@ SYNOPSIS DESCRIPTION ----------- -Usually you would want to use gitlink:git-push[1] which is a +Usually you would want to use linkgit:git-push[1] which is a higher level wrapper of this command instead. Invokes 'git-receive-pack' on a possibly remote repository, and @@ -86,7 +86,7 @@ and the destination side (after the colon). The ref to be pushed is determined by finding a match that matches the source side, and where it is pushed is determined by using the destination side. The rules used to match a ref are the same -rules used by gitlink:git-rev-parse[1] to resolve a symbolic ref +rules used by linkgit:git-rev-parse[1] to resolve a symbolic ref name. - It is an error if <src> does not match exactly one of the @@ -125,4 +125,4 @@ Documentation by Junio C Hamano. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-sh-setup.txt b/Documentation/git-sh-setup.txt index 1ea1faa..16b8b75 100644 --- a/Documentation/git-sh-setup.txt +++ b/Documentation/git-sh-setup.txt @@ -44,6 +44,11 @@ set_reflog_action:: end-user action in the reflog, when the script updates a ref. +git_editor:: + runs an editor of user's choice (GIT_EDITOR, core.editor, VISUAL or + EDITOR) on a given file, but error out if no editor is specified + and the terminal is dumb. + is_bare_repository:: outputs `true` or `false` to the standard output stream to indicate if the repository is a bare repository @@ -57,6 +62,10 @@ require_work_tree:: if so. Used by scripts that require working tree (e.g. `checkout`). +get_author_ident_from_commit:: + outputs code for use with eval to set the GIT_AUTHOR_NAME, + GIT_AUTHOR_EMAIL and GIT_AUTHOR_DATE variables for a given commit. + Author ------ @@ -68,4 +77,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-shell.txt b/Documentation/git-shell.txt index 48f2d57..bc031e0 100644 --- a/Documentation/git-shell.txt +++ b/Documentation/git-shell.txt @@ -31,4 +31,4 @@ Documentation by Petr Baudis and the git-list <git@vger.kernel.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-shortlog.txt b/Documentation/git-shortlog.txt index e14720b..c775257 100644 --- a/Documentation/git-shortlog.txt +++ b/Documentation/git-shortlog.txt @@ -38,15 +38,16 @@ OPTIONS FILES ----- -.mailmap:: - If this file exists, it will be used for mapping author email - addresses to a real author name. One mapping per line, first - the author name followed by the email address enclosed by - '<' and '>'. Use hash '#' for comments. Example: +If the file `.mailmap` exists, it will be used for mapping author +email addresses to a real author name. One mapping per line, first +the author name followed by the email address enclosed by +'<' and '>'. Use hash '#' for comments. Example: - # Keep alphabetized - Adam Morrow <adam@localhost.localdomain> - Eve Jones <eve@laptop.(none)> +------------ +# Keep alphabetized +Adam Morrow <adam@localhost.localdomain> +Eve Jones <eve@laptop.(none)> +------------ Author ------ @@ -58,4 +59,4 @@ Documentation by Junio C Hamano. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-show-branch.txt b/Documentation/git-show-branch.txt index ba5313d..0bb8250 100644 --- a/Documentation/git-show-branch.txt +++ b/Documentation/git-show-branch.txt @@ -190,4 +190,4 @@ Documentation by Junio C Hamano. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-show-index.txt b/Documentation/git-show-index.txt index 764d993..535a884 100644 --- a/Documentation/git-show-index.txt +++ b/Documentation/git-show-index.txt @@ -31,4 +31,4 @@ Documentation by Junio C Hamano GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-show-ref.txt b/Documentation/git-show-ref.txt index 7893a50..ce0e643 100644 --- a/Documentation/git-show-ref.txt +++ b/Documentation/git-show-ref.txt @@ -130,7 +130,7 @@ When using the '--verify' flag, the command requires an exact path: will only match the exact branch called "master". -If nothing matches, gitlink:git-show-ref[1] will return an error code of 1, +If nothing matches, linkgit:git-show-ref[1] 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 @@ -160,7 +160,7 @@ to get a listing of all tags together with what they dereference. SEE ALSO -------- -gitlink:git-ls-remote[1] +linkgit:git-ls-remote[1] AUTHORS ------- @@ -169,4 +169,4 @@ Man page by Jonas Fonseca <fonseca@diku.dk>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-show.txt b/Documentation/git-show.txt index a42e121..dccf0e2 100644 --- a/Documentation/git-show.txt +++ b/Documentation/git-show.txt @@ -20,12 +20,12 @@ presents the merge commit in a special format as produced by For tags, it shows the tag message and the referenced objects. -For trees, it shows the names (equivalent to gitlink:git-ls-tree[1] +For trees, it shows the names (equivalent to linkgit:git-ls-tree[1] with \--name-only). For plain blobs, it shows the plain contents. -The command takes options applicable to the gitlink:git-diff-tree[1] command to +The command takes options applicable to the linkgit:git-diff-tree[1] command to control how the changes the commit introduces are shown. This manual page describes only the most frequently used options. @@ -36,7 +36,7 @@ OPTIONS <object>:: The name of the object to show. For a more complete list of ways to spell object names, see - "SPECIFYING REVISIONS" section in gitlink:git-rev-parse[1]. + "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1]. include::pretty-options.txt[] @@ -83,4 +83,4 @@ This manual page is a stub. You can help the git documentation by expanding it. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt index c0147b9..cd0dc1b 100644 --- a/Documentation/git-stash.txt +++ b/Documentation/git-stash.txt @@ -9,7 +9,7 @@ SYNOPSIS -------- [verse] 'git-stash' (list | show [<stash>] | apply [<stash>] | clear) -'git-stash' [save] [message...] +'git-stash' [save [<message>]] DESCRIPTION ----------- @@ -36,11 +36,12 @@ is also possible). OPTIONS ------- -save:: +save [<message>]:: Save your local modifications to a new 'stash', and run `git-reset --hard` to revert them. This is the default action when no - subcommand is given. + subcommand is given. The <message> part is optional and gives + the description along with the stashed state. list:: @@ -156,10 +157,10 @@ $ git stash apply SEE ALSO -------- -gitlink:git-checkout[1], -gitlink:git-commit[1], -gitlink:git-reflog[1], -gitlink:git-reset[1] +linkgit:git-checkout[1], +linkgit:git-commit[1], +linkgit:git-reflog[1], +linkgit:git-reset[1] AUTHOR ------ @@ -167,4 +168,4 @@ Written by Nanako Shiraishi <nanako3@bluebottle.com> GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt index 5c5a480..3ea269a 100644 --- a/Documentation/git-status.txt +++ b/Documentation/git-status.txt @@ -15,7 +15,7 @@ DESCRIPTION Displays paths that have differences between the index file and the current HEAD commit, paths that have differences between the working tree and the index file, and paths in the working tree that are not -tracked by git (and are not ignored by gitlink:gitignore[5]). The first +tracked by git (and are not ignored by linkgit:gitignore[5]). The first are what you _would_ commit by running `git commit`; the second and third are what you _could_ commit by running `git add` before running `git commit`. @@ -54,7 +54,7 @@ directory. See Also -------- -gitlink:gitignore[5] +linkgit:gitignore[5] Author ------ @@ -67,4 +67,4 @@ Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-stripspace.txt b/Documentation/git-stripspace.txt index f80526b..fc56875 100644 --- a/Documentation/git-stripspace.txt +++ b/Documentation/git-stripspace.txt @@ -32,4 +32,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt index 3f59705..e818e6e 100644 --- a/Documentation/git-submodule.txt +++ b/Documentation/git-submodule.txt @@ -9,8 +9,9 @@ git-submodule - Initialize, update or inspect submodules SYNOPSIS -------- [verse] -'git-submodule' [--quiet] [-b branch] add <repository> [<path>] -'git-submodule' [--quiet] [--cached] [status|init|update] [--] [<path>...] +'git-submodule' [--quiet] add [-b branch] [--] <repository> [<path>] +'git-submodule' [--quiet] status [--cached] [--] [<path>...] +'git-submodule' [--quiet] [init|update] [--] [<path>...] COMMANDS @@ -28,7 +29,7 @@ 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 gitlink:git-describe[1] for the + submodule path and the output of linkgit:git-describe[1] 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 @@ -67,8 +68,8 @@ FILES ----- When initializing submodules, a .gitmodules file in the top-level directory of the containing repository is used to find the url of each submodule. -This file should be formatted in the same way as $GIR_DIR/config. The key -to each submodule url is "submodule.$name.url". See gitlink:gitmodules[5] +This file should be formatted in the same way as `$GIT_DIR/config`. The key +to each submodule url is "submodule.$name.url". See linkgit:gitmodules[5] for details. @@ -78,4 +79,4 @@ Written by Lars Hjemli <hjemli@gmail.com> GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt index 918a992..340f1be 100644 --- a/Documentation/git-svn.txt +++ b/Documentation/git-svn.txt @@ -12,7 +12,7 @@ SYNOPSIS DESCRIPTION ----------- git-svn is a simple conduit for changesets between Subversion and git. -It is not to be confused with gitlink:git-svnimport[1], which is +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 @@ -161,6 +161,13 @@ New features: + Any other arguments are passed directly to `git log' +'blame':: + Show what revision and author last modified each line of a file. This is + identical to `git blame', but SVN revision numbers are shown instead of git + commit hashes. ++ +All arguments are passed directly to `git blame'. + -- 'find-rev':: When given an SVN revision number of the form 'rN', returns the @@ -208,7 +215,7 @@ OPTIONS --shared[={false|true|umask|group|all|world|everybody}]:: --template=<template_directory>:: Only used with the 'init' command. - These are passed directly to gitlink:git-init[1]. + These are passed directly to linkgit:git-init[1]. -r <ARG>:: --revision <ARG>:: @@ -261,7 +268,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 -gitlink:git-diff-tree[1] for more information. +linkgit:git-diff-tree[1] for more information. [verse] config key: svn.l @@ -299,7 +306,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 gitlink:git-repack[1]. +--repack-flags are passed directly to linkgit:git-repack[1]. [verse] config key: svn.repack @@ -456,10 +463,13 @@ have each person clone that repository with 'git clone': ------------------------------------------------------------------------ # Do the initial import on a server ssh server "cd /pub && git-svn clone http://svn.foo.org/project -# Clone locally - git clone server:/pub/project -# Tell git-svn which branch contains the Subversion commits - git update-ref refs/remotes/git-svn origin/master +# Clone locally - make sure the refs/remotes/ space matches the server + mkdir project + cd project + git-init + git remote add origin server:/pub/project + git config --add remote.origin.fetch=+refs/remotes/*:refs/remotes/* + git fetch # Initialize git-svn locally (be sure to use the same URL and -T/-b/-t options as were used on server) git-svn init http://svn.foo.org/project # Pull the latest changes from Subversion @@ -561,11 +571,11 @@ 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 -gitlink:git-config[1] +linkgit:git-config[1] SEE ALSO -------- -gitlink:git-rebase[1] +linkgit:git-rebase[1] Author ------ diff --git a/Documentation/git-symbolic-ref.txt b/Documentation/git-symbolic-ref.txt index 694caba..a5b40f3 100644 --- a/Documentation/git-symbolic-ref.txt +++ b/Documentation/git-symbolic-ref.txt @@ -58,4 +58,4 @@ Written by Junio C Hamano <junkio@cox.net> GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt index 784ec6d..b62a3d1 100644 --- a/Documentation/git-tag.txt +++ b/Documentation/git-tag.txt @@ -248,4 +248,4 @@ Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-tar-tree.txt b/Documentation/git-tar-tree.txt index 434607b..65c6817 100644 --- a/Documentation/git-tar-tree.txt +++ b/Documentation/git-tar-tree.txt @@ -86,4 +86,4 @@ Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-unpack-file.txt b/Documentation/git-unpack-file.txt index 20bb6a7..1864d13 100644 --- a/Documentation/git-unpack-file.txt +++ b/Documentation/git-unpack-file.txt @@ -32,4 +32,4 @@ Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-unpack-objects.txt b/Documentation/git-unpack-objects.txt index d529a43..b79be3f 100644 --- a/Documentation/git-unpack-objects.txt +++ b/Documentation/git-unpack-objects.txt @@ -51,4 +51,4 @@ Documentation by Junio C Hamano GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-update-index.txt b/Documentation/git-update-index.txt index 0a19538..66be18e 100644 --- a/Documentation/git-update-index.txt +++ b/Documentation/git-update-index.txt @@ -27,7 +27,7 @@ Modifies the index or directory cache. Each file mentioned is updated into the index and any 'unmerged' or 'needs updating' state is cleared. -See also gitlink:git-add[1] for a more user-friendly way to do some of +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 @@ -292,14 +292,14 @@ Configuration The command honors `core.filemode` configuration variable. If your repository is on an filesystem whose executable bits are -unreliable, this should be set to 'false' (see gitlink:git-config[1]). +unreliable, this should be set to 'false' (see linkgit:git-config[1]). This causes the command to ignore differences in file modes recorded in the index and the file mode on the filesystem if they differ only on executable bit. On such an unfortunate filesystem, you may need to use `git-update-index --chmod=`. Quite similarly, if `core.symlinks` configuration variable is set -to 'false' (see gitlink:git-config[1]), symbolic links are checked out +to 'false' (see linkgit:git-config[1]), symbolic links are checked out as plain files, and this command does not modify a recorded file mode from symbolic link to regular file. @@ -309,8 +309,8 @@ The command looks at `core.ignorestat` configuration variable. See See Also -------- -gitlink:git-config[1], -gitlink:git-add[1] +linkgit:git-config[1], +linkgit:git-add[1] Author @@ -323,4 +323,4 @@ Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-update-ref.txt b/Documentation/git-update-ref.txt index f222616..4dc4759 100644 --- a/Documentation/git-update-ref.txt +++ b/Documentation/git-update-ref.txt @@ -90,4 +90,4 @@ Written by Linus Torvalds <torvalds@osdl.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-update-server-info.txt b/Documentation/git-update-server-info.txt index e7e82a3..1cf89fd 100644 --- a/Documentation/git-update-server-info.txt +++ b/Documentation/git-update-server-info.txt @@ -54,4 +54,4 @@ Documentation by Junio C Hamano. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-upload-archive.txt b/Documentation/git-upload-archive.txt index 403871d..c1ef144 100644 --- a/Documentation/git-upload-archive.txt +++ b/Documentation/git-upload-archive.txt @@ -34,4 +34,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-upload-pack.txt b/Documentation/git-upload-pack.txt index fd65192..2330d13 100644 --- a/Documentation/git-upload-pack.txt +++ b/Documentation/git-upload-pack.txt @@ -43,4 +43,4 @@ Documentation by Junio C Hamano. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-var.txt b/Documentation/git-var.txt index 8139423..2980283 100644 --- a/Documentation/git-var.txt +++ b/Documentation/git-var.txt @@ -47,9 +47,9 @@ Your sysadmin must hate you!:: See Also -------- -gitlink:git-commit-tree[1] -gitlink:git-tag[1] -gitlink:git-config[1] +linkgit:git-commit-tree[1] +linkgit:git-tag[1] +linkgit:git-config[1] Author ------ @@ -61,4 +61,4 @@ Documentation by Eric Biederman and the git-list <git@vger.kernel.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-verify-pack.txt b/Documentation/git-verify-pack.txt index f4c540f..db019a2 100644 --- a/Documentation/git-verify-pack.txt +++ b/Documentation/git-verify-pack.txt @@ -50,4 +50,4 @@ Documentation by Junio C Hamano GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-verify-tag.txt b/Documentation/git-verify-tag.txt index ac7fb19..7e9c1ed 100644 --- a/Documentation/git-verify-tag.txt +++ b/Documentation/git-verify-tag.txt @@ -28,4 +28,4 @@ Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-whatchanged.txt b/Documentation/git-whatchanged.txt index 607df48..54947b6 100644 --- a/Documentation/git-whatchanged.txt +++ b/Documentation/git-whatchanged.txt @@ -77,4 +77,4 @@ Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git-write-tree.txt b/Documentation/git-write-tree.txt index cb8d6aa..461c813 100644 --- a/Documentation/git-write-tree.txt +++ b/Documentation/git-write-tree.txt @@ -46,4 +46,4 @@ Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/git.txt b/Documentation/git.txt index 37235b9..17aee93 100644 --- a/Documentation/git.txt +++ b/Documentation/git.txt @@ -28,7 +28,7 @@ link:user-manual.html[Git User's Manual] for a more in-depth introduction. The COMMAND is either a name of a Git command (see below) or an alias -as defined in the configuration file (see gitlink:git-config[1]). +as defined in the configuration file (see linkgit:git-config[1]). Formatted and hyperlinked version of the latest git documentation can be viewed at @@ -43,9 +43,15 @@ unreleased) version of git, that is available from 'master' branch of the `git.git` repository. Documentation for older releases are available here: -* link:v1.5.3/git.html[documentation for release 1.5.3] +* link:v1.5.4/git.html[documentation for release 1.5.4] * release notes for + link:RelNotes-1.5.4.txt[1.5.4]. + +* link:v1.5.3.8/git.html[documentation for release 1.5.3.8] + +* release notes for + link:RelNotes-1.5.3.8.txt[1.5.3.8], link:RelNotes-1.5.3.7.txt[1.5.3.7], link:RelNotes-1.5.3.6.txt[1.5.3.6], link:RelNotes-1.5.3.5.txt[1.5.3.5], @@ -106,7 +112,7 @@ OPTIONS option will bring up the manual page for that command. + Other options are available to control how the manual page is -displayed. See gitlink:git-help[1] for more information, +displayed. See linkgit:git-help[1] for more information, because 'git --help ...' is converted internally into 'git help ...'. @@ -198,8 +204,8 @@ Low-level commands (plumbing) Although git includes its own porcelain layer, its low-level commands are sufficient to support development of alternative porcelains. Developers of such porcelains -might start by reading about gitlink:git-update-index[1] and -gitlink:git-read-tree[1]. +might start by reading about linkgit:git-update-index[1] and +linkgit:git-read-tree[1]. The interface (input, output, set of options and the semantics) to these low-level commands are meant to be a lot more stable @@ -331,7 +337,7 @@ HEAD:: (i.e. the contents of `$GIT_DIR/refs/heads/<head>`). For a more complete list of ways to spell object names, see -"SPECIFYING REVISIONS" section in gitlink:git-rev-parse[1]. +"SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1]. File/Directory Structure @@ -399,7 +405,7 @@ git Commits 'GIT_COMMITTER_EMAIL':: 'GIT_COMMITTER_DATE':: 'EMAIL':: - see gitlink:git-commit-tree[1] + see linkgit:git-commit-tree[1] git Diffs ~~~~~~~~~ @@ -439,7 +445,7 @@ other 'GIT_MERGE_VERBOSITY':: A number controlling the amount of output shown by the recursive merge strategy. Overrides merge.verbosity. - See gitlink:git-merge[1] + See linkgit:git-merge[1] 'GIT_PAGER':: This environment variable overrides `$PAGER`. If it is set @@ -447,8 +453,8 @@ other a pager. 'GIT_SSH':: - If this environment variable is set then gitlink:git-fetch[1] - and gitlink:git-push[1] will use this command instead + If this environment variable is set then linkgit:git-fetch[1] + and linkgit:git-push[1] will use this command instead of `ssh` when they need to connect to a remote system. The 'GIT_SSH' command will be given exactly two arguments: the 'username@host' (or just 'host') from the URL and the @@ -554,4 +560,4 @@ contributors on the git-list <git@vger.kernel.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/gitattributes.txt b/Documentation/gitattributes.txt index 71c7ad7..35a29fd 100644 --- a/Documentation/gitattributes.txt +++ b/Documentation/gitattributes.txt @@ -238,7 +238,7 @@ When git needs to show you a diff for the path with `diff` attribute set to `jcdiff`, it calls the command you specified with the above configuration, i.e. `j-c-diff`, with 7 parameters, just like `GIT_EXTERNAL_DIFF` program is called. -See gitlink:git[7] for details. +See linkgit:git[7] for details. Defining a custom hunk-header @@ -322,12 +322,43 @@ String:: requested with "binary". +Built-in merge drivers +^^^^^^^^^^^^^^^^^^^^^^ + +There are a few built-in low-level merge drivers defined that +can be asked for via the `merge` attribute. + +text:: + + Usual 3-way file level merge for text files. Conflicted + regions are marked with conflict markers `<<<<<<<`, + `=======` and `>>>>>>>`. The version from your branch + appears before the `=======` marker, and the version + from the merged branch appears after the `=======` + marker. + +binary:: + + Keep the version from your branch in the work tree, but + leave the path in the conflicted state for the user to + sort out. + +union:: + + Run 3-way file level merge for text files, but take + lines from both versions, instead of leaving conflict + markers. This tends to leave the added lines in the + resulting file in random order and the user should + verify the result. Do not use this if you do not + understand the implications. + + Defining a custom merge driver ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The definition of a merge driver is done in `gitconfig` not -`gitattributes` file, so strictly speaking this manual page is a -wrong place to talk about it. However... +The definition of a merge driver is done in the `.git/config` +file, not in the `gitattributes` file, so strictly speaking this +manual page is a wrong place to talk about it. However... To define a custom merge driver `filfre`, add a section to your `$GIT_DIR/config` file (or `$HOME/.gitconfig` file) like this: @@ -369,7 +400,7 @@ Checking whitespace errors The `core.whitespace` configuration variable allows you to define what `diff` and `apply` should consider whitespace errors for all paths in -the project (See gitlink:git-config[1]). This attribute gives you finer +the project (See linkgit:git-config[1]). This attribute gives you finer control per path. Set:: @@ -450,9 +481,9 @@ Creating an archive 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 -gitlink:git-archive[1] has been given a tree instead of a commit or a +linkgit:git-archive[1] 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 gitlink:git-log[1], +as those for the option `--pretty=format:` of linkgit:git-log[1], except that they need to be wrapped like this: `$Format:PLACEHOLDERS$` in the file. E.g. the string `$Format:%H$` will be replaced by the commit hash. @@ -460,4 +491,4 @@ commit hash. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/gitcli.txt b/Documentation/gitcli.txt index b7dcf9c..7ee5ce3 100644 --- a/Documentation/gitcli.txt +++ b/Documentation/gitcli.txt @@ -95,7 +95,7 @@ $ git foo -oArg $ git foo -o Arg ---------------------------- -However, this is *NOT* allowed for switches with an optionnal value, where the +However, this is *NOT* allowed for switches with an optional value, where the 'sticked' form must be used: ---------------------------- $ git describe --abbrev HEAD # correct @@ -110,4 +110,4 @@ Documentation by Pierre Habouzit. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/gitignore.txt b/Documentation/gitignore.txt index e8b8581..08373f5 100644 --- a/Documentation/gitignore.txt +++ b/Documentation/gitignore.txt @@ -39,10 +39,10 @@ precedence, the last matching pattern decides the outcome): variable 'core.excludesfile'. The underlying git plumbing tools, such as -gitlink:git-ls-files[1] and gitlink:git-read-tree[1], read +linkgit:git-ls-files[1] and linkgit:git-read-tree[1], read `gitignore` patterns specified by command-line options, or from files specified by command-line options. Higher-level git -tools, such as gitlink:git-status[1] and gitlink:git-add[1], +tools, such as linkgit:git-status[1] and linkgit:git-add[1], use patterns from the sources specified above. Patterns have the following format: @@ -119,4 +119,4 @@ Frank Lichtenheld, and the git-list <git@vger.kernel.org>. GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/gitk.txt b/Documentation/gitk.txt index 8dbfb0d..29edafc 100644 --- a/Documentation/gitk.txt +++ b/Documentation/gitk.txt @@ -22,7 +22,7 @@ git repository. OPTIONS ------- To control which revisions to shown, the command takes options applicable to -the gitlink:git-rev-list[1] command. This manual page describes only the most +the linkgit:git-rev-list[1] command. This manual page describes only the most frequently used options. -n <number>, --max-count=<number>:: @@ -48,7 +48,7 @@ frequently used options. the form "'<from>'..'<to>'" to show all revisions between '<from>' and back to '<to>'. Note, more advanced revision selection can be applied. For a more complete list of ways to spell object names, see - "SPECIFYING REVISIONS" section in gitlink:git-rev-parse[1]. + "SPECIFYING REVISIONS" section in linkgit:git-rev-parse[1]. <path>:: @@ -98,4 +98,4 @@ Documentation by Junio C Hamano, Jonas Fonseca, and the git-list GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/gitmodules.txt b/Documentation/gitmodules.txt index 035294e..cc95b69 100644 --- a/Documentation/gitmodules.txt +++ b/Documentation/gitmodules.txt @@ -15,7 +15,7 @@ DESCRIPTION The `.gitmodules` file, located in the top-level directory of a git working tree, is a text file with a syntax matching the requirements -of gitlink:git-config[1]. +of linkgit:git-config[1]. The file contains one subsection per submodule, and the subsection value is the name of the submodule. Each submodule section also contains the @@ -51,7 +51,7 @@ submodules an url is specified which can be used for cloning the submodules. SEE ALSO -------- -gitlink:git-submodule[1] gitlink:git-config[1] +linkgit:git-submodule[1] linkgit:git-config[1] DOCUMENTATION ------------- @@ -59,4 +59,4 @@ Documentation by Lars Hjemli <hjemli@gmail.com> GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite diff --git a/Documentation/glossary.txt b/Documentation/glossary.txt index 65f55e4..ab4caf4 100644 --- a/Documentation/glossary.txt +++ b/Documentation/glossary.txt @@ -140,7 +140,7 @@ to point at the new commit. branch's <<def_head_ref,head ref>> from a remote <<def_repository,repository>>, to find out which objects are missing from the local <<def_object_database,object database>>, - and to get them, too. See also gitlink:git-fetch[1]. + and to get them, too. See also linkgit:git-fetch[1]. [[def_file_system]]file system:: Linus Torvalds originally designed git to be a user space file system, @@ -164,7 +164,7 @@ to point at the new commit. A <<def_ref,named reference>> to the <<def_commit,commit>> at the tip of a <<def_branch,branch>>. Heads are stored in `$GIT_DIR/refs/heads/`, except when using packed refs. (See - gitlink:git-pack-refs[1].) + linkgit:git-pack-refs[1].) [[def_HEAD]]HEAD:: The current <<def_branch,branch>>. In more detail: Your <<def_working_tree, @@ -282,7 +282,7 @@ This commit is referred to as a "merge commit", or sometimes just a routines that help select changes that add or delete a given text string. With the `--pickaxe-all` option, it can be used to view the full <<def_changeset,changeset>> that introduced or removed, say, a - particular line of text. See gitlink:git-diff[1]. + particular line of text. See linkgit:git-diff[1]. [[def_plumbing]]plumbing:: Cute name for <<def_core_git,core git>>. @@ -295,7 +295,7 @@ This commit is referred to as a "merge commit", or sometimes just a [[def_pull]]pull:: Pulling a <<def_branch,branch>> means to <<def_fetch,fetch>> it and - <<def_merge,merge>> it. See also gitlink:git-pull[1]. + <<def_merge,merge>> it. See also linkgit:git-pull[1]. [[def_push]]push:: Pushing a <<def_branch,branch>> means to get the branch's @@ -333,7 +333,7 @@ This commit is referred to as a "merge commit", or sometimes just a A reflog shows the local "history" of a ref. In other words, it can tell you what the 3rd last revision in _this_ repository was, and what was the current state in _this_ repository, - yesterday 9:14pm. See gitlink:git-reflog[1] for details. + yesterday 9:14pm. See linkgit:git-reflog[1] for details. [[def_refspec]]refspec:: A "refspec" is used by <<def_fetch,fetch>> and @@ -346,7 +346,7 @@ This commit is referred to as a "merge commit", or sometimes just a it as my origin branch head". And `git push $URL refs/heads/master:refs/heads/to-upstream` means "publish my master branch head as to-upstream branch at $URL". See also - gitlink:git-push[1]. + linkgit:git-push[1]. [[def_repository]]repository:: A collection of <<def_ref,refs>> together with an @@ -383,15 +383,15 @@ This commit is referred to as a "merge commit", or sometimes just a object>>). This is sometimes useful when you are interested only in the recent history of a project even though the real history recorded in the upstream is much larger. A shallow repository - is created by giving the `--depth` option to gitlink:git-clone[1], and - its history can be later deepened with gitlink:git-fetch[1]. + is created by giving the `--depth` option to linkgit:git-clone[1], and + its history can be later deepened with linkgit:git-fetch[1]. [[def_symref]]symref:: Symbolic reference: instead of containing the <<def_SHA1,SHA1>> id itself, it is of the format 'ref: refs/some/thing' and when referenced, it recursively dereferences to this reference. '<<def_HEAD,HEAD>>' is a prime example of a symref. Symbolic - references are manipulated with the gitlink:git-symbolic-ref[1] + references are manipulated with the linkgit:git-symbolic-ref[1] command. [[def_tag]]tag:: diff --git a/Documentation/howto/using-merge-subtree.txt b/Documentation/howto/using-merge-subtree.txt new file mode 100644 index 0000000..0953a50 --- /dev/null +++ b/Documentation/howto/using-merge-subtree.txt @@ -0,0 +1,75 @@ +Date: Sat, 5 Jan 2008 20:17:40 -0500 +From: Sean <seanlkml@sympatico.ca> +To: Miklos Vajna <vmiklos@frugalware.org> +Cc: git@vger.kernel.org +Subject: how to use git merge -s subtree? +Abstract: In this article, Sean demonstrates how one can use the subtree merge + strategy. +Content-type: text/asciidoc +Message-ID: <BAYC1-PASMTP12374B54BA370A1E1C6E78AE4E0@CEZ.ICE> + +How to use the subtree merge strategy +===================================== + +There are situations where you want to include contents in your project +from an independently developed project. You can just pull from the +other project as long as there are no conflicting paths. + +The problematic case is when there are conflicting files. Potential +candidates are Makefiles and other standard filenames. You could merge +these files but probably you do not want to. A better solution for this +problem can be to merge the project as its own subdirectory. This is not +supported by the 'recursive' merge strategy, so just pulling won't work. + +What you want is the 'subtree' merge strategy, which helps you in such a +situation. + +In this example, let's say you have the repository at `/path/to/B` (but +it can be an URL as well, if you want). You want to merge the 'master' +branch of that repository to the `dir-B` subdirectory in your current +branch. + +Here is the command sequence you need: + +---------------- +$ git remote add -f Bproject /path/to/B <1> +$ git merge -s ours --no-commit Bproject/master <2> +$ git read-tree --prefix=dir-B/ -u Bproject/master <3> +$ git commit -m "Merge B project as our subdirectory" <4> + +$ git pull -s subtree Bproject master <5> +---------------- +<1> name the other project "Bproject", and fetch. +<2> prepare for the later step to record the result as a merge. +<3> read "master" branch of Bproject to the subdirectory "dir-B". +<4> record the merge result. +<5> maintain the result with subsequent merges using "subtree" + +The first four commands are used for the initial merge, while the last +one is to merge updates from 'B project'. + +Comparing 'subtree' merge with submodules +----------------------------------------- + +- The benefit of using subtree merge is that it requires less + administrative burden from the users of your repository. It works with + older (before Git v1.5.2) clients and you have the code right after + clone. + +- However if you use submodules then you can choose not to transfer the + submodule objects. This may be a problem with the subtree merge. + +- Also, in case you make changes to the other project, it is easier to + submit changes if you just use submodules. + +Additional tips +--------------- + +- If you made changes to the other project in your repository, they may + want to merge from your project. This is possible using subtree -- it + can shift up the paths in your tree and then they can merge only the + relevant parts of your tree. + +- Please note that if the other project merges from you, then it will + connects its history to yours, which can be something they don't want + to. diff --git a/Documentation/i18n.txt b/Documentation/i18n.txt index b95f99b..1e188e6 100644 --- a/Documentation/i18n.txt +++ b/Documentation/i18n.txt @@ -22,7 +22,7 @@ does not forbid it. However, there are a few things to keep in mind. . `git-commit-tree` (hence, `git-commit` which uses it) issues - an warning if the commit log message given to it does not look + a warning if the commit log message given to it does not look like a valid UTF-8 string, unless you explicitly say your project uses a legacy encoding. The way to say this is to have i18n.commitencoding in `.git/config` file, like this: diff --git a/Documentation/manpage-1.72.xsl b/Documentation/manpage-1.72.xsl new file mode 100644 index 0000000..fe3cd72 --- /dev/null +++ b/Documentation/manpage-1.72.xsl @@ -0,0 +1,17 @@ +<!-- callout.xsl: converts asciidoc callouts to man page format --> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"> +<xsl:template match="co"> + <xsl:value-of select="concat('▓fB(',substring-after(@id,'-'),')▓fR')"/> +</xsl:template> +<xsl:template match="calloutlist"> + <xsl:text>⌂sp </xsl:text> + <xsl:apply-templates/> + <xsl:text> </xsl:text> +</xsl:template> +<xsl:template match="callout"> + <xsl:value-of select="concat('▓fB',substring-after(@arearefs,'-'),'. ▓fR')"/> + <xsl:apply-templates/> + <xsl:text>⌂br </xsl:text> +</xsl:template> + +</xsl:stylesheet> diff --git a/Documentation/repository-layout.txt b/Documentation/repository-layout.txt index 4c92e37..6939130 100644 --- a/Documentation/repository-layout.txt +++ b/Documentation/repository-layout.txt @@ -19,7 +19,7 @@ trees this way, for example. A repository with this kind of incomplete object store is not suitable to be published to the outside world but sometimes useful for private repository. . You also could have an incomplete but locally usable repository -by cloning shallowly. See gitlink:git-clone[1]. +by cloning shallowly. See linkgit:git-clone[1]. . You can be using `objects/info/alternates` mechanism, or `$GIT_ALTERNATE_OBJECT_DIRECTORIES` mechanism to 'borrow' objects from other object stores. A repository with this kind @@ -89,7 +89,7 @@ refs/remotes/`name`:: packed-refs:: records the same information as refs/heads/, refs/tags/, and friends record in a more efficient way. See - gitlink:git-pack-refs[1]. + linkgit:git-pack-refs[1]. HEAD:: A symref (see glossary) to the `refs/heads/` namespace @@ -106,7 +106,7 @@ HEAD:: HEAD can also record a specific commit directly, instead of being a symref to point at the current branch. Such a state is often called 'detached HEAD', and almost all commands work -identically as normal. See gitlink:git-checkout[1] for +identically as normal. See linkgit:git-checkout[1] for details. branches:: @@ -155,7 +155,7 @@ info/exclude:: exclude pattern list. `.gitignore` is the per-directory ignore file. `git status`, `git add`, `git rm` and `git clean` look at it but the core git commands do not look - at it. See also: gitlink:gitignore[5]. + at it. See also: linkgit:gitignore[5]. remotes:: Stores shorthands to be used to give URL and default @@ -176,4 +176,4 @@ logs/refs/tags/`name`:: shallow:: This is similar to `info/grafts` but is internally used and maintained by shallow clone mechanism. See `--depth` - option to gitlink:git-clone[1] and gitlink:git-fetch[1]. + option to linkgit:git-clone[1] and linkgit:git-fetch[1]. diff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt new file mode 100644 index 0000000..a8138e2 --- /dev/null +++ b/Documentation/rev-list-options.txt @@ -0,0 +1,361 @@ +Commit Formatting +~~~~~~~~~~~~~~~~~ + +ifdef::git-rev-list[] +Using these options, linkgit:git-rev-list[1] will act similar to the +more specialized family of commit log tools: linkgit:git-log[1], +linkgit:git-show[1], and linkgit:git-whatchanged[1] +endif::git-rev-list[] + +include::pretty-options.txt[] + +--relative-date:: + + Synonym for `--date=relative`. + +--date={relative,local,default,iso,rfc}:: + + Only takes effect for dates shown in human-readable format, such + as when using "--pretty". ++ +`--date=relative` shows dates relative to the current time, +e.g. "2 hours ago". ++ +`--date=local` shows timestamps in user's local timezone. ++ +`--date=iso` (or `--date=iso8601`) shows timestamps in ISO 8601 format. ++ +`--date=rfc` (or `--date=rfc2822`) shows timestamps in RFC 2822 +format, often found in E-mail messages. ++ +`--date=short` shows only date but not time, in `YYYY-MM-DD` format. ++ +`--date=default` shows timestamps in the original timezone +(either committer's or author's). + +--header:: + + Print the contents of the commit in raw-format; each record is + separated with a NUL character. + +--parents:: + + Print the parents of the commit. + +--timestamp:: + Print the raw commit timestamp. + +--left-right:: + + Mark which side of a symmetric diff a commit is reachable from. + Commits from the left side are prefixed with `<` and those from + the right with `>`. If combined with `--boundary`, those + commits are prefixed with `-`. ++ +For example, if you have this topology: ++ +----------------------------------------------------------------------- + y---b---b branch B + / \ / + / . + / / \ + o---x---a---a branch A +----------------------------------------------------------------------- ++ +you would get an output line this: ++ +----------------------------------------------------------------------- + $ git rev-list --left-right --boundary --pretty=oneline A...B + + >bbbbbbb... 3rd on b + >bbbbbbb... 2nd on b + <aaaaaaa... 3rd on a + <aaaaaaa... 2nd on a + -yyyyyyy... 1st on b + -xxxxxxx... 1st on a +----------------------------------------------------------------------- + +Diff Formatting +~~~~~~~~~~~~~~~ + +Below are listed options that control the formatting of diff output. +Some of them are specific to linkgit:git-rev-list[1], however other diff +options may be given. See linkgit:git-diff-files[1] for more options. + +-c:: + + This flag changes the way a merge commit is displayed. It shows + the differences from each of the parents to the merge result + simultaneously instead of showing pairwise diff between a parent + and the result one at a time. Furthermore, it lists only files + which were modified from all parents. + +--cc:: + + This flag implies the '-c' options and further compresses the + patch output by omitting hunks that show differences from only + one parent, or show the same change from all but one parent for + an Octopus merge. + +-r:: + + Show recursive diffs. + +-t:: + + Show the tree objects in the diff output. This implies '-r'. + +Commit Limiting +~~~~~~~~~~~~~~~ + +Besides specifying a range of commits that should be listed using the +special notations explained in the description, additional commit +limiting may be applied. + +-- + +-n 'number', --max-count='number':: + + Limit the number of commits output. + +--skip='number':: + + Skip 'number' commits before starting to show the commit output. + +--since='date', --after='date':: + + Show commits more recent than a specific date. + +--until='date', --before='date':: + + Show commits older than a specific date. + +--max-age='timestamp', --min-age='timestamp':: + + Limit the commits output to specified time range. + +--author='pattern', --committer='pattern':: + + Limit the commits output to ones with author/committer + header lines that match the specified pattern (regular expression). + +--grep='pattern':: + + Limit the commits output to ones with log message that + matches the specified pattern (regular expression). + +-i, --regexp-ignore-case:: + + Match the regexp limiting patterns without regard to letters case. + +-E, --extended-regexp:: + + Consider the limiting patterns to be extended regular expressions + instead of the default basic regular expressions. + +--remove-empty:: + + Stop when a given path disappears from the tree. + +--full-history:: + + Show also parts of history irrelevant to current state of a given + path. This turns off history simplification, which removed merges + which didn't change anything at all at some child. It will still actually + simplify away merges that didn't change anything at all into either + child. + +--no-merges:: + + Do not print commits with more than one parent. + +--first-parent:: + Follow only the first parent commit upon seeing a merge + commit. This option can give a better overview when + viewing the evolution of a particular topic branch, + because merges into a topic branch tend to be only about + adjusting to updated upstream from time to time, and + this option allows you to ignore the individual commits + brought in to your history by such a merge. + +--not:: + + Reverses the meaning of the '{caret}' prefix (or lack thereof) + for all following revision specifiers, up to the next '--not'. + +--all:: + + Pretend as if all the refs in `$GIT_DIR/refs/` are listed on the + command line as '<commit>'. + +--stdin:: + + In addition to the '<commit>' listed on the command + line, read them from the standard input. + +--quiet:: + + Don't print anything to standard output. This form + is primarily meant to allow the caller to + test the exit status to see if a range of objects is fully + connected (or not). It is faster than redirecting stdout + to /dev/null as the output does not have to be formatted. + +--cherry-pick:: + + Omit any commit that introduces the same change as + another commit on the "other side" when the set of + commits are limited with symmetric difference. ++ +For example, if you have two branches, `A` and `B`, a usual way +to list all commits on only one side of them is with +`--left-right`, like the example above in the description of +that option. It however shows the commits that were cherry-picked +from the other branch (for example, "3rd on b" may be cherry-picked +from branch A). With this option, such pairs of commits are +excluded from the output. + +-g, --walk-reflogs:: + + Instead of walking the commit ancestry chain, walk + reflog entries from the most recent one to older ones. + When this option is used you cannot specify commits to + exclude (that is, '{caret}commit', 'commit1..commit2', + nor 'commit1...commit2' notations cannot be used). ++ +With '\--pretty' format other than oneline (for obvious reasons), +this causes the output to have two extra lines of information +taken from the reflog. By default, 'commit@\{Nth}' notation is +used in the output. When the starting commit is specified as +'commit@{now}', output also uses 'commit@\{timestamp}' notation +instead. Under '\--pretty=oneline', the commit message is +prefixed with this information on the same line. + +Cannot be combined with '\--reverse'. +See also linkgit:git-reflog[1]. + +--merge:: + + After a failed merge, show refs that touch files having a + conflict and don't exist on all heads to merge. + +--boundary:: + + Output uninteresting commits at the boundary, which are usually + not shown. + +--dense, --sparse:: + +When optional paths are given, the default behaviour ('--dense') is to +only output commits that changes at least one of them, and also ignore +merges that do not touch the given paths. + +Use the '--sparse' flag to makes the command output all eligible commits +(still subject to count and age limitation), but apply merge +simplification nevertheless. + +ifdef::git-rev-list[] +--bisect:: + +Limit output to the one commit object which is roughly halfway between +the included and excluded commits. Thus, if + +----------------------------------------------------------------------- + $ git-rev-list --bisect foo ^bar ^baz +----------------------------------------------------------------------- + +outputs 'midpoint', the output of the two commands + +----------------------------------------------------------------------- + $ git-rev-list foo ^midpoint + $ git-rev-list midpoint ^bar ^baz +----------------------------------------------------------------------- + +would be of roughly the same length. Finding the change which +introduces a regression is thus reduced to a binary search: repeatedly +generate and test new 'midpoint's until the commit chain is of length +one. + +--bisect-vars:: + +This calculates the same as `--bisect`, but outputs text ready +to be eval'ed by the shell. These lines will assign the name of +the midpoint revision to the variable `bisect_rev`, and the +expected number of commits to be tested after `bisect_rev` is +tested to `bisect_nr`, the expected number of commits to be +tested if `bisect_rev` turns out to be good to `bisect_good`, +the expected number of commits to be tested if `bisect_rev` +turns out to be bad to `bisect_bad`, and the number of commits +we are bisecting right now to `bisect_all`. + +--bisect-all:: + +This outputs all the commit objects between the included and excluded +commits, ordered by their distance to the included and excluded +commits. The farthest from them is displayed first. (This is the only +one displayed by `--bisect`.) + +This is useful because it makes it easy to choose a good commit to +test when you want to avoid to test some of them for some reason (they +may not compile for example). + +This option can be used along with `--bisect-vars`, in this case, +after all the sorted commit objects, there will be the same text as if +`--bisect-vars` had been used alone. +endif::git-rev-list[] + +-- + +Commit Ordering +~~~~~~~~~~~~~~~ + +By default, the commits are shown in reverse chronological order. + +--topo-order:: + + This option makes them appear in topological order (i.e. + descendant commits are shown before their parents). + +--date-order:: + + This option is similar to '--topo-order' in the sense that no + parent comes before all of its children, but otherwise things + are still ordered in the commit timestamp order. + +--reverse:: + + Output the commits in reverse order. + Cannot be combined with '\--walk-reflogs'. + +Object Traversal +~~~~~~~~~~~~~~~~ + +These options are mostly targeted for packing of git repositories. + +--objects:: + + Print the object IDs of any object referenced by the listed + commits. '--objects foo ^bar' thus means "send me + all object IDs which I need to download if I have the commit + object 'bar', but not 'foo'". + +--objects-edge:: + + Similar to '--objects', but also print the IDs of excluded + commits prefixed with a "-" character. This is used by + linkgit:git-pack-objects[1] to build "thin" pack, which records + objects in deltified form based on objects contained in these + excluded commits to reduce network traffic. + +--unpacked:: + + Only useful with '--objects'; print the object IDs that are not + in packs. + +--no-walk:: + + Only show the given revs, but do not traverse their ancestors. + +--do-walk:: + + Overrides a previous --no-walk. diff --git a/Documentation/technical/api-diff.txt b/Documentation/technical/api-diff.txt index 822609b..83b007e 100644 --- a/Documentation/technical/api-diff.txt +++ b/Documentation/technical/api-diff.txt @@ -102,13 +102,13 @@ Notable members are: and copies. `abbrev`:: - Number of hexdigits to abbrevate raw format output to. + Number of hexdigits to abbreviate raw format output to. `pickaxe`:: A constant string (can and typically does contain newlines to look for a block of text, not just a single line) to filter out the filepairs that do not change the number of strings contained - in its preimage and postmage of the diff_queue. + in its preimage and postimage of the diff_queue. `flags`:: This is mostly a collection of boolean options that affects the @@ -149,7 +149,7 @@ REVERSE_DIFF;; EXIT_WITH_STATUS;; For communication between the calling program and the options - parser; tell the calling program to signal the presense of + parser; tell the calling program to signal the presence of difference using program exit code. HAS_CHANGES;; diff --git a/Documentation/technical/api-lockfile.txt b/Documentation/technical/api-lockfile.txt index 73ac102..dd89404 100644 --- a/Documentation/technical/api-lockfile.txt +++ b/Documentation/technical/api-lockfile.txt @@ -1,12 +1,74 @@ lockfile API ============ -Talk about <lockfile.c>, things like: +The lockfile API serves two purposes: -* lockfile lifetime -- atexit(3) looks at them, do not put them on the - stack; -* hold_lock_file_for_update() -* commit_lock_file() -* rollback_rock_file() +* Mutual exclusion. When we write out a new index file, first + we create a new file `$GIT_DIR/index.lock`, write the new + contents into it, and rename it to the final destination + `$GIT_DIR/index`. We try to create the `$GIT_DIR/index.lock` + file with O_EXCL so that we can notice and fail when somebody + else is already trying to update the index file. -(JC, Dscho, Shawn) +* Automatic cruft removal. After we create the "lock" file, we + may decide to `die()`, and we would want to make sure that we + remove the file that has not been committed to its final + destination. This is done by remembering the lockfiles we + created in a linked list and cleaning them up from an + `atexit(3)` handler. Outstanding lockfiles are also removed + when the program dies on a signal. + + +The functions +------------- + +hold_lock_file_for_update:: + + Take a pointer to `struct lock_file`, the filename of + the final destination (e.g. `$GIT_DIR/index`) and a flag + `die_on_error`. Attempt to create a lockfile for the + destination and return the file descriptor for writing + to the file. If `die_on_error` flag is true, it dies if + a lock is already taken for the file; otherwise it + returns a negative integer to the caller on failure. + +commit_lock_file:: + + Take a pointer to the `struct lock_file` initialized + with an earlier call to `hold_lock_file_for_update()`, + close the file descriptor and rename the lockfile to its + final destination. Returns 0 upon success, a negative + value on failure to close(2) or rename(2). + +rollback_lock_file:: + + Take a pointer to the `struct lock_file` initialized + with an earlier call to `hold_lock_file_for_update()`, + close the file descriptor and remove the lockfile. + +close_lock_file:: + Take a pointer to the `struct lock_file` initialized + with an earlier call to `hold_lock_file_for_update()`, + and close the file descriptor. Returns 0 upon success, + a negative value on failure to close(2). + +Because the structure is used in an `atexit(3)` handler, its +storage has to stay throughout the life of the program. It +cannot be an auto variable allocated on the stack. + +Call `commit_lock_file()` or `rollback_lock_file()` when you are +done writing to the file descriptor. If you do not call either +and simply `exit(3)` from the program, an `atexit(3)` handler +will close and remove the lockfile. + +If you need to close the file descriptor you obtained from +`hold_lock_file_for_update` function yourself, do so by calling +`close_lock_file()`. You should never call `close(2)` yourself! +Otherwise the `struct +lock_file` structure still remembers that the file descriptor +needs to be closed, and a later call to `commit_lock_file()` or +`rollback_lock_file()` will result in duplicate calls to +`close(2)`. Worse yet, if you `close(2)`, open another file +descriptor for completely different purpose, and then call +`commit_lock_file()` or `rollback_lock_file()`, they may close +that unrelated file descriptor. diff --git a/Documentation/technical/pack-format.txt b/Documentation/technical/pack-format.txt index a80baa4..aa87756 100644 --- a/Documentation/technical/pack-format.txt +++ b/Documentation/technical/pack-format.txt @@ -125,7 +125,7 @@ Pack file entry: <+ - A table of 4-byte CRC32 values of the packed object data. This is new in v2 so compressed data can be copied directly - from pack to pack during repacking withough undetected + from pack to pack during repacking without undetected data corruption. - A table of 4-byte offset values (in network byte order). diff --git a/Documentation/technical/racy-git.txt b/Documentation/technical/racy-git.txt index 5030d9f..6bdf034 100644 --- a/Documentation/technical/racy-git.txt +++ b/Documentation/technical/racy-git.txt @@ -184,7 +184,7 @@ In a large project where raciness avoidance cost really matters, however, the initial computation of all object names in the index takes more than one second, and the index file is written out after all that happens. Therefore the timestamp of the -index file will be more than one seconds later than the the +index file will be more than one seconds later than the youngest file in the working tree. This means that in these cases there actually will not be any racily clean entry in the resulting index. diff --git a/Documentation/tutorial-2.txt b/Documentation/tutorial-2.txt index 5c39a16..7fac47d 100644 --- a/Documentation/tutorial-2.txt +++ b/Documentation/tutorial-2.txt @@ -172,7 +172,7 @@ merge, with the parent references pointing to the heads of the merged branches. Besides blobs, trees, and commits, the only remaining type of object -is a "tag", which we won't discuss here; refer to gitlink:git-tag[1] +is a "tag", which we won't discuss here; refer to linkgit:git-tag[1] for details. So now we know how git uses the object database to represent a diff --git a/Documentation/tutorial.txt b/Documentation/tutorial.txt index fff1068..e2bbda5 100644 --- a/Documentation/tutorial.txt +++ b/Documentation/tutorial.txt @@ -47,7 +47,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 gitlink:git-add[1]: +current directory (note the '.'), with linkgit:git-add[1]: ------------------------------------------------ $ git add . @@ -55,7 +55,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 gitlink:git-commit[1]: +repository with linkgit:git-commit[1]: ------------------------------------------------ $ git commit @@ -74,15 +74,15 @@ $ git add file1 file2 file3 ------------------------------------------------ You are now ready to commit. You can see what is about to be committed -using gitlink:git-diff[1] with the --cached option: +using linkgit:git-diff[1] with the --cached option: ------------------------------------------------ $ git diff --cached ------------------------------------------------ -(Without --cached, gitlink:git-diff[1] will show you any changes that +(Without --cached, linkgit:git-diff[1] 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 gitlink:git-status[1]: +summary of the situation with linkgit:git-status[1]: ------------------------------------------------ $ git status @@ -358,7 +358,7 @@ $ git config --get remote.origin.url ------------------------------------- (The complete configuration created by git-clone is visible using -"git config -l", and the gitlink:git-config[1] man page +"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 @@ -377,10 +377,10 @@ $ git clone alice.org:/home/alice/project myrepo ------------------------------------- Alternatively, git has a native protocol, or can use rsync or http; -see gitlink:git-pull[1] for details. +see linkgit:git-pull[1] for details. Git can also be used in a CVS-like mode, with a central repository -that various users push changes to; see gitlink:git-push[1] and +that various users push changes to; see linkgit:git-push[1] and link:cvs-migration.html[git for CVS users]. Exploring history @@ -442,7 +442,7 @@ $ git-tag v2.5 1b2e1d63ff you can refer to 1b2e1d63ff by the name "v2.5". If you intend to share this name with other people (for example, to identify a release version), you should create a "tag" object, and perhaps sign it; see -gitlink:git-tag[1] for details. +linkgit:git-tag[1] for details. Any git command that needs to know a commit can take any of these names. For example: @@ -461,7 +461,7 @@ this branch. If this branch is the only branch containing those 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 gitlink:git-revert[1] +If you need to undo changes that you have pushed, use linkgit:git-revert[1] instead. The git grep command can search for strings in any version of your @@ -567,12 +567,12 @@ need to make the most of git. If you don't want to continue with that right away, a few other digressions that may be interesting at this point are: - * gitlink:git-format-patch[1], gitlink:git-am[1]: These convert + * linkgit:git-format-patch[1], linkgit:git-am[1]: These convert series of git commits into emailed patches, and vice versa, useful for projects such as the linux kernel which rely heavily on emailed patches. - * gitlink:git-bisect[1]: When there is a regression in your + * linkgit:git-bisect[1]: When there is a regression in your project, one way to track down the bug is by searching through the history to find the exact commit that's to blame. Git bisect can help you perform a binary search for that commit. It is diff --git a/Documentation/urls.txt b/Documentation/urls.txt index 4f66738..81ac17f 100644 --- a/Documentation/urls.txt +++ b/Documentation/urls.txt @@ -38,7 +38,7 @@ To sync with a local directory, you can use: ifndef::git-clone[] They are mostly equivalent, except when cloning. See -gitlink:git-clone[1] for details. +linkgit:git-clone[1] for details. endif::git-clone[] ifdef::git-clone[] diff --git a/Documentation/user-manual.conf b/Documentation/user-manual.conf index 92b01ecf..339b309 100644 --- a/Documentation/user-manual.conf +++ b/Documentation/user-manual.conf @@ -7,7 +7,7 @@ startsb=[ endsb=] tilde=~ -[gitlink-inlinemacro] +[linkgit-inlinemacro] <ulink url="{target}.html">{target}{0?({0})}</ulink> ifdef::backend-docbook[] diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt index f2b4206..40b0de0 100644 --- a/Documentation/user-manual.txt +++ b/Documentation/user-manual.txt @@ -42,7 +42,7 @@ How to get a git repository It will be useful to have a git repository to experiment with as you read this manual. -The best way to get one is by using the gitlink:git-clone[1] command to +The best way to get one is by using the linkgit:git-clone[1] command to download a copy of an existing repository. If you don't already have a project in mind, here are some interesting examples: @@ -74,12 +74,12 @@ version is called a <<def_commit,commit>>. Those snapshots aren't necessarily all arranged in a single line from oldest to newest; instead, work may simultaneously proceed along -parallel lines of development, called <def_branch,branches>>, which may +parallel lines of development, called <<def_branch,branches>>, which may merge and diverge. A single git repository can track development on multiple branches. It does this by keeping a list of <<def_head,heads>> which reference the -latest commit on each branch; the gitlink:git-branch[1] command shows +latest commit on each branch; the linkgit:git-branch[1] command shows you the list of branch heads: ------------------------------------------------ @@ -93,7 +93,7 @@ the project referred to by that branch head. Most projects also use <<def_tag,tags>>. Tags, like heads, are references into the project's history, and can be listed using the -gitlink:git-tag[1] command: +linkgit:git-tag[1] command: ------------------------------------------------ $ git tag -l @@ -113,14 +113,14 @@ Tags are expected to always point at the same version of a project, while heads are expected to advance as development progresses. Create a new branch head pointing to one of these versions and check it -out using gitlink:git-checkout[1]: +out using linkgit:git-checkout[1]: ------------------------------------------------ $ git checkout -b new v2.6.13 ------------------------------------------------ The working directory then reflects the contents that the project had -when it was tagged v2.6.13, and gitlink:git-branch[1] shows two +when it was tagged v2.6.13, and linkgit:git-branch[1] shows two branches, with an asterisk marking the currently checked-out branch: ------------------------------------------------ @@ -146,7 +146,7 @@ Understanding History: Commits ------------------------------ Every change in the history of a project is represented by a commit. -The gitlink:git-show[1] command shows the most recent commit on the +The linkgit:git-show[1] command shows the most recent commit on the current branch: ------------------------------------------------ @@ -208,7 +208,7 @@ representing a merge can therefore have more than one parent, with each parent representing the most recent commit on one of the lines of development leading to that point. -The best way to see how this works is using the gitlink:gitk[1] +The best way to see how this works is using the linkgit:gitk[1] command; running gitk now on a git repository and looking for merge commits will help understand how the git organizes history. @@ -335,7 +335,7 @@ The "master" branch that was created at the time you cloned is a copy of the HEAD in the repository that you cloned from. That repository may also have had other branches, though, and your local repository keeps branches which track each of those remote branches, which you -can view using the "-r" option to gitlink:git-branch[1]: +can view using the "-r" option to linkgit:git-branch[1]: ------------------------------------------------ $ git branch -r @@ -378,7 +378,7 @@ exists a tag and a branch with the same name. (Newly created refs are actually stored in the .git/refs directory, under the path given by their name. However, for efficiency reasons they may also be packed together in a single file; see -gitlink:git-pack-refs[1]). +linkgit:git-pack-refs[1]). As another useful shortcut, the "HEAD" of a repository can be referred to just using the name of that repository. So, for example, "origin" @@ -387,7 +387,7 @@ is usually a shortcut for the HEAD branch in the repository "origin". For the complete list of paths which git checks for references, and the order it uses to decide which to choose when there are multiple references with the same shorthand name, see the "SPECIFYING -REVISIONS" section of gitlink:git-rev-parse[1]. +REVISIONS" section of linkgit:git-rev-parse[1]. [[Updating-a-repository-with-git-fetch]] Updating a repository with git fetch @@ -407,7 +407,7 @@ Fetching branches from other repositories ----------------------------------------- You can also track branches from repositories other than the one you -cloned from, using gitlink:git-remote[1]: +cloned from, using linkgit:git-remote[1]: ------------------------------------------------- $ git remote add linux-nfs git://linux-nfs.org/pub/nfs-2.6.git @@ -443,7 +443,7 @@ $ cat .git/config This is what causes git to track the remote's branches; you may modify or delete these configuration options by editing .git/config with a text editor. (See the "CONFIGURATION FILE" section of -gitlink:git-config[1] for details.) +linkgit:git-config[1] for details.) [[exploring-git-history]] Exploring git history @@ -468,7 +468,7 @@ Suppose version 2.6.18 of your project worked, but the version at "master" crashes. Sometimes the best way to find the cause of such a regression is to perform a brute-force search through the project's history to find the particular commit that caused the problem. The -gitlink:git-bisect[1] command can help you do this: +linkgit:git-bisect[1] command can help you do this: ------------------------------------------------- $ git bisect start @@ -497,7 +497,7 @@ half each time. After about 13 tests (in this case), it will output the commit id of the guilty commit. You can then examine the commit with -gitlink:git-show[1], find out who wrote it, and mail them your bug +linkgit:git-show[1], find out who wrote it, and mail them your bug report with the commit id. Finally, run ------------------------------------------------- @@ -543,7 +543,7 @@ We have seen several ways of naming commits already: - HEAD: refers to the head of the current branch There are many more; see the "SPECIFYING REVISIONS" section of the -gitlink:git-rev-parse[1] man page for the complete list of ways to +linkgit:git-rev-parse[1] man page for the complete list of ways to name revisions. Some examples: ------------------------------------------------- @@ -584,7 +584,7 @@ When we discuss merges we'll also see the special name MERGE_HEAD, which refers to the other branch that we're merging in to the current branch. -The gitlink:git-rev-parse[1] command is a low-level command that is +The linkgit:git-rev-parse[1] command is a low-level command that is occasionally useful for translating some name for a commit to the object name for that commit: @@ -608,14 +608,14 @@ You can use stable-1 to refer to the commit 1b2e1d63ff. This creates a "lightweight" tag. If you would also like to include a comment with the tag, and possibly sign it cryptographically, then you -should create a tag object instead; see the gitlink:git-tag[1] man page +should create a tag object instead; see the linkgit:git-tag[1] man page for details. [[browsing-revisions]] Browsing revisions ------------------ -The gitlink:git-log[1] command can show lists of commits. On its +The linkgit:git-log[1] command can show lists of commits. On its own, it shows all commits reachable from the parent commit; but you can also make more specific requests: @@ -645,7 +645,7 @@ You can also ask git log to show patches: $ git log -p ------------------------------------------------- -See the "--pretty" option in the gitlink:git-log[1] man page for more +See the "--pretty" option in the linkgit:git-log[1] man page for more display options. Note that git log starts with the most recent commit and works @@ -658,7 +658,7 @@ Generating diffs ---------------- You can generate diffs between any two versions using -gitlink:git-diff[1]: +linkgit:git-diff[1]: ------------------------------------------------- $ git diff master..test @@ -673,7 +673,7 @@ $ git diff master...test ------------------------------------------------- Sometimes what you want instead is a set of patches; for this you can -use gitlink:git-format-patch[1]: +use linkgit:git-format-patch[1]: ------------------------------------------------- $ git format-patch master..test @@ -714,7 +714,7 @@ $ git log --pretty=oneline origin..mybranch | wc -l ------------------------------------------------- Alternatively, you may often see this sort of thing done with the -lower-level command gitlink:git-rev-list[1], which just lists the SHA1's +lower-level command linkgit:git-rev-list[1], which just lists the SHA1's of all the given commits: ------------------------------------------------- @@ -772,7 +772,7 @@ You could just visually inspect the commits since e05db0fd: $ gitk e05db0fd.. ------------------------------------------------- -Or you can use gitlink:git-name-rev[1], which will give the commit a +Or you can use linkgit:git-name-rev[1], which will give the commit a name based on any tag it finds pointing to one of the commit's descendants: @@ -781,7 +781,7 @@ $ git name-rev --tags e05db0fd e05db0fd tags/v1.5.0-rc1^0~23 ------------------------------------------------- -The gitlink:git-describe[1] command does the opposite, naming the +The linkgit:git-describe[1] command does the opposite, naming the revision using a tag on which the given commit is based: ------------------------------------------------- @@ -793,7 +793,7 @@ but that may sometimes help you guess which tags might come after the given commit. If you just want to verify whether a given tagged version contains a -given commit, you could use gitlink:git-merge-base[1]: +given commit, you could use linkgit:git-merge-base[1]: ------------------------------------------------- $ git merge-base e05db0fd v1.5.0-rc1 @@ -814,7 +814,7 @@ $ git log v1.5.0-rc1..e05db0fd will produce empty output if and only if v1.5.0-rc1 includes e05db0fd, because it outputs only commits that are not reachable from v1.5.0-rc1. -As yet another alternative, the gitlink:git-show-branch[1] command lists +As yet another alternative, the linkgit:git-show-branch[1] command lists the commits reachable from its arguments with a display on the left-hand side that indicates which arguments that commit is reachable from. So, you can run something like @@ -847,7 +847,7 @@ Suppose you would like to see all the commits reachable from the branch head named "master" but not from any other head in your repository. We can list all the heads in this repository with -gitlink:git-show-ref[1]: +linkgit:git-show-ref[1]: ------------------------------------------------- $ git show-ref --heads @@ -884,14 +884,14 @@ commits reachable from some head but not from any tag in the repository: $ gitk $( git show-ref --heads ) --not $( git show-ref --tags ) ------------------------------------------------- -(See gitlink:git-rev-parse[1] for explanations of commit-selecting +(See linkgit:git-rev-parse[1] for explanations of commit-selecting syntax such as `--not`.) [[making-a-release]] Creating a changelog and tarball for a software release ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The gitlink:git-archive[1] command can create a tar or zip archive from +The linkgit:git-archive[1] command can create a tar or zip archive from any version of a project; for example: ------------------------------------------------- @@ -944,8 +944,8 @@ $ git log --raw --abbrev=40 --pretty=oneline | ------------------------------------------------- Figuring out why this works is left as an exercise to the (advanced) -student. The gitlink:git-log[1], gitlink:git-diff-tree[1], and -gitlink:git-hash-object[1] man pages may prove helpful. +student. The linkgit:git-log[1], linkgit:git-diff-tree[1], and +linkgit:git-hash-object[1] man pages may prove helpful. [[Developing-with-git]] Developing with git @@ -965,7 +965,7 @@ file named .gitconfig in your home directory: email = you@yourdomain.example.com ------------------------------------------------ -(See the "CONFIGURATION FILE" section of gitlink:git-config[1] for +(See the "CONFIGURATION FILE" section of linkgit:git-config[1] for details on the configuration file.) @@ -1088,7 +1088,7 @@ $ git diff HEAD # difference between HEAD and working tree; what $ git status # a brief per-file summary of the above. ------------------------------------------------- -You can also use gitlink:git-gui[1] to create commits, view changes in +You can also use linkgit:git-gui[1] to create commits, view changes in the index and the working tree files, and individually select diff hunks for inclusion in the index (by right-clicking on the diff hunk and choosing "Stage Hunk For Commit"). @@ -1131,7 +1131,7 @@ foo.txt *.[oa] ------------------------------------------------- -See gitlink:gitignore[5] for a detailed explanation of the syntax. You can +See linkgit:gitignore[5] for a detailed explanation of the syntax. You can also place .gitignore files in other directories in your working tree, and they will apply to those directories and their subdirectories. The `.gitignore` files can be added to your repository like any other files (just run `git add @@ -1144,14 +1144,14 @@ If you wish the exclude patterns to affect only certain repositories them in a file in your repository named .git/info/exclude, or in any file specified by the `core.excludesfile` configuration variable. Some git commands can also take exclude patterns directly on the command line. -See gitlink:gitignore[5] for the details. +See linkgit:gitignore[5] for the details. [[how-to-merge]] How to merge ------------ You can rejoin two diverging branches of development using -gitlink:git-merge[1]: +linkgit:git-merge[1]: ------------------------------------------------- $ git merge branchname @@ -1188,7 +1188,7 @@ the working tree in a special state that gives you all the information you need to help resolve the merge. Files with conflicts are marked specially in the index, so until you -resolve the problem and update the index, gitlink:git-commit[1] will +resolve the problem and update the index, linkgit:git-commit[1] will fail: ------------------------------------------------- @@ -1196,7 +1196,7 @@ $ git commit file.txt: needs merge ------------------------------------------------- -Also, gitlink:git-status[1] will list those files as "unmerged", and the +Also, linkgit:git-status[1] will list those files as "unmerged", and the files with conflicts will have conflict markers added, like this: ------------------------------------------------- @@ -1227,7 +1227,7 @@ Getting conflict-resolution help during a merge ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ All of the changes that git was able to merge automatically are -already added to the index file, so gitlink:git-diff[1] shows only +already added to the index file, so linkgit:git-diff[1] shows only the conflicts. It uses an unusual syntax: ------------------------------------------------- @@ -1262,7 +1262,7 @@ $ git show :3:file.txt # the version from MERGE_HEAD, but including any Since the stage 2 and stage 3 versions have already been updated with nonconflicting changes, the only remaining differences between them are -the important ones; thus gitlink:git-diff[1] can use the information in +the important ones; thus linkgit:git-diff[1] can use the information in the index to show only those conflicts. The diff above shows the differences between the working-tree version of @@ -1271,7 +1271,7 @@ each line by a single "+" or "-", it now uses two columns: the first column is used for differences between the first parent and the working directory copy, and the second for differences between the second parent and the working directory copy. (See the "COMBINED DIFF FORMAT" section -of gitlink:git-diff-files[1] for a details of the format.) +of linkgit:git-diff-files[1] for a details of the format.) After resolving the conflict in the obvious way (but before updating the index), the diff will look like: @@ -1304,7 +1304,7 @@ $ git diff -3 file.txt # diff against stage 3 $ git diff --theirs file.txt # same as the above. ------------------------------------------------- -The gitlink:git-log[1] and gitk[1] commands also provide special help +The linkgit:git-log[1] and gitk[1] commands also provide special help for merges: ------------------------------------------------- @@ -1315,7 +1315,7 @@ $ gitk --merge These will display all commits which exist only on HEAD or on MERGE_HEAD, and which touch an unmerged file. -You may also use gitlink:git-mergetool[1], which lets you merge the +You may also use linkgit:git-mergetool[1], which lets you merge the unmerged files using external tools such as emacs or kdiff3. Each time you resolve the conflicts in a file and update the index: @@ -1394,7 +1394,7 @@ Fixing a mistake with a new commit ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Creating a new commit that reverts an earlier change is very easy; -just pass the gitlink:git-revert[1] command a reference to the bad +just pass the linkgit:git-revert[1] command a reference to the bad commit; for example, to revert the most recent commit: ------------------------------------------------- @@ -1437,7 +1437,7 @@ which will replace the old commit by a new commit incorporating your changes, giving you a chance to edit the old commit message first. Again, you should never do this to a commit that may already have -been merged into another branch; use gitlink:git-revert[1] instead in +been merged into another branch; use linkgit:git-revert[1] instead in that case. It is also possible to replace commits further back in the history, but @@ -1450,7 +1450,7 @@ Checking out an old version of a file In the process of undoing a previous bad change, you may find it useful to check out an older version of a particular file using -gitlink:git-checkout[1]. We've used git checkout before to switch +linkgit:git-checkout[1]. We've used git checkout before to switch branches, but it has quite different behavior if it is given a path name: the command @@ -1463,7 +1463,7 @@ also updates the index to match. It does not change branches. If you just want to look at an old version of the file, without modifying the working directory, you can do that with -gitlink:git-show[1]: +linkgit:git-show[1]: ------------------------------------------------- $ git show HEAD^:path/to/file @@ -1477,7 +1477,7 @@ Temporarily setting aside work in progress While you are in the middle of working on something complicated, you find an unrelated but obvious and trivial bug. You would like to fix it -before continuing. You can use gitlink:git-stash[1] to save the current +before continuing. You can use linkgit:git-stash[1] to save the current state of your work, and after fixing the bug (or, optionally after doing so on a different branch and then coming back), unstash the work-in-progress changes. @@ -1511,7 +1511,7 @@ On large repositories, git depends on compression to keep the history information from taking up too much space on disk or in memory. This compression is not performed automatically. Therefore you -should occasionally run gitlink:git-gc[1]: +should occasionally run linkgit:git-gc[1]: ------------------------------------------------- $ git gc @@ -1529,7 +1529,7 @@ Ensuring reliability Checking the repository for corruption ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The gitlink:git-fsck[1] command runs a number of self-consistency checks +The linkgit:git-fsck[1] command runs a number of self-consistency checks on the repository, and reports on any problems. This may take some time. The most common warning by far is about "dangling" objects: @@ -1549,8 +1549,8 @@ dangling tree b24c2473f1fd3d91352a624795be026d64c8841f Dangling objects are not a problem. At worst they may take up a little extra disk space. They can sometimes provide a last-resort method for recovering lost work--see <<dangling-objects>> for details. However, if -you wish, you can remove them with gitlink:git-prune[1] or the `--prune` -option to gitlink:git-gc[1]: +you wish, you can remove them with linkgit:git-prune[1] or the `--prune` +option to linkgit:git-gc[1]: ------------------------------------------------- $ git gc --prune @@ -1560,7 +1560,7 @@ This may be time-consuming. Unlike most other git operations (including git-gc when run without any options), it is not safe to prune while other git operations are in progress in the same repository. -If gitlink:git-fsck[1] complains about sha1 mismatches or missing +If linkgit:git-fsck[1] complains about sha1 mismatches or missing objects, you may have a much more serious problem; your best option is probably restoring from backups. See <<recovering-from-repository-corruption>> for a detailed discussion. @@ -1573,7 +1573,7 @@ Recovering lost changes Reflogs ^^^^^^^ -Say you modify a branch with `gitlink:git-reset[1] --hard`, and then +Say you modify a branch with `linkgit:git-reset[1] --hard`, and then realize that the branch was the only reference you had to that point in history. @@ -1608,9 +1608,9 @@ pointed to one week ago. This allows you to see the history of what you've checked out. The reflogs are kept by default for 30 days, after which they may be -pruned. See gitlink:git-reflog[1] and gitlink:git-gc[1] to learn +pruned. See linkgit:git-reflog[1] and linkgit:git-gc[1] to learn how to control this pruning, and see the "SPECIFYING REVISIONS" -section of gitlink:git-rev-parse[1] for details. +section of linkgit:git-rev-parse[1] for details. Note that the reflog history is very different from normal git history. While normal history is shared by every repository that works on the @@ -1675,7 +1675,7 @@ may wish to check the original repository for updates and merge them into your own work. We have already seen <<Updating-a-repository-with-git-fetch,how to -keep remote tracking branches up to date>> with gitlink:git-fetch[1], +keep remote tracking branches up to date>> with linkgit:git-fetch[1], and how to merge two branches. So you can merge in changes from the original repository's master branch with: @@ -1684,7 +1684,7 @@ $ git fetch $ git merge origin/master ------------------------------------------------- -However, the gitlink:git-pull[1] command provides a way to do this in +However, the linkgit:git-pull[1] command provides a way to do this in one step: ------------------------------------------------- @@ -1702,8 +1702,8 @@ $ git pull More generally, a branch that is created from a remote branch will pull by default from that branch. See the descriptions of the branch.<name>.remote and branch.<name>.merge options in -gitlink:git-config[1], and the discussion of the `--track` option in -gitlink:git-checkout[1], to learn how to control these defaults. +linkgit:git-config[1], and the discussion of the `--track` option in +linkgit:git-checkout[1], to learn how to control these defaults. In addition to saving you keystrokes, "git pull" also helps you by producing a default commit message documenting the branch and @@ -1731,7 +1731,7 @@ Submitting patches to a project If you just have a few changes, the simplest way to submit them may just be to send them as patches in email: -First, use gitlink:git-format-patch[1]; for example: +First, use linkgit:git-format-patch[1]; for example: ------------------------------------------------- $ git format-patch origin @@ -1742,7 +1742,7 @@ for each patch in the current branch but not in origin/HEAD. You can then import these into your mail client and send them by hand. However, if you have a lot to send at once, you may prefer to -use the gitlink:git-send-email[1] script to automate the process. +use the linkgit:git-send-email[1] script to automate the process. Consult the mailing list for your project first to determine how they prefer such patches be handled. @@ -1750,7 +1750,7 @@ prefer such patches be handled. Importing patches to a project ------------------------------ -Git also provides a tool called gitlink:git-am[1] (am stands for +Git also provides a tool called linkgit:git-am[1] (am stands for "apply mailbox"), for importing such an emailed series of patches. Just save all of the patch-containing messages, in order, into a single mailbox file, say "patches.mbox", then run @@ -1785,7 +1785,7 @@ Public git repositories Another way to submit changes to a project is to tell the maintainer of that project to pull the changes from your repository using -gitlink:git-pull[1]. In the section "<<getting-updates-with-git-pull, +linkgit:git-pull[1]. In the section "<<getting-updates-with-git-pull, Getting updates with git pull>>" we described this as a way to get updates from the "main" repository, but it works just as well in the other direction. @@ -1866,14 +1866,14 @@ at. You can then skip to the section "<<pushing-changes-to-a-public-repository,Pushing changes to a public repository>>", below. -Otherwise, all you need to do is start gitlink:git-daemon[1]; it will +Otherwise, all you need to do is start linkgit:git-daemon[1]; it will listen on port 9418. By default, it will allow access to any directory that looks like a git directory and contains the magic file git-daemon-export-ok. Passing some directory paths as git-daemon arguments will further restrict the exports to those paths. You can also run git-daemon as an inetd service; see the -gitlink:git-daemon[1] man page for details. (See especially the +linkgit:git-daemon[1] man page for details. (See especially the examples section.) [[exporting-via-http]] @@ -1895,7 +1895,7 @@ $ chmod a+x hooks/post-update ------------------------------------------------- (For an explanation of the last two lines, see -gitlink:git-update-server-info[1], and the documentation +linkgit:git-update-server-info[1], and the documentation link:hooks.html[Hooks used by git].) Advertise the URL of proj.git. Anybody else should then be able to @@ -1920,7 +1920,7 @@ maintainers to fetch your latest changes, but they do not allow write access, which you will need to update the public repository with the latest changes created in your private repository. -The simplest way to do this is using gitlink:git-push[1] and ssh; to +The simplest way to do this is using linkgit:git-push[1] and ssh; to update the remote branch named "master" with the latest state of your branch named "master", run @@ -1961,7 +1961,7 @@ $ git push public-repo master ------------------------------------------------- See the explanations of the remote.<name>.url, branch.<name>.remote, -and remote.<name>.push options in gitlink:git-config[1] for +and remote.<name>.push options in linkgit:git-config[1] for details. [[forcing-push]] @@ -2083,14 +2083,14 @@ $ cd work ------------------------------------------------- Linus's tree will be stored in the remote branch named origin/master, -and can be updated using gitlink:git-fetch[1]; you can track other -public trees using gitlink:git-remote[1] to set up a "remote" and -gitlink:git-fetch[1] to keep them up-to-date; see +and can be updated using linkgit:git-fetch[1]; you can track other +public trees using linkgit:git-remote[1] to set up a "remote" and +linkgit:git-fetch[1] to keep them up-to-date; see <<repositories-and-branches>>. Now create the branches in which you are going to work; these start out at the current tip of origin/master branch, and should be set up (using -the --track option to gitlink:git-branch[1]) to merge changes in from +the --track option to linkgit:git-branch[1]) to merge changes in from Linus by default. ------------------------------------------------- @@ -2098,7 +2098,7 @@ $ git branch --track test origin/master $ git branch --track release origin/master ------------------------------------------------- -These can be easily kept up to date using gitlink:git-pull[1]. +These can be easily kept up to date using linkgit:git-pull[1]. ------------------------------------------------- $ git checkout test && git pull @@ -2113,7 +2113,7 @@ doing this capriciously in the "release" branch, as these noisy commits will become part of the permanent history when you ask Linus to pull from the release branch. -A few configuration variables (see gitlink:git-config[1]) can +A few configuration variables (see linkgit:git-config[1]) can make it easy to push both branches to your public tree. (See <<setting-up-a-public-repository>>.) @@ -2127,7 +2127,7 @@ EOF ------------------------------------------------- Then you can push both the test and release trees using -gitlink:git-push[1]: +linkgit:git-push[1]: ------------------------------------------------- $ git push mytree @@ -2440,7 +2440,7 @@ the result would create a new merge commit, like this: However, if you prefer to keep the history in mywork a simple series of commits without any merges, you may instead choose to use -gitlink:git-rebase[1]: +linkgit:git-rebase[1]: ------------------------------------------------- $ git checkout mywork @@ -2491,7 +2491,7 @@ $ git commit --amend which will replace the old commit by a new commit incorporating your changes, giving you a chance to edit the old commit message first. -You can also use a combination of this and gitlink:git-rebase[1] to +You can also use a combination of this and linkgit:git-rebase[1] to replace a commit further back in your history and recreate the intervening changes on top of it. First, tag the problematic commit with @@ -2529,7 +2529,7 @@ new commits having new object names. Reordering or selecting from a patch series ------------------------------------------- -Given one existing commit, the gitlink:git-cherry-pick[1] command +Given one existing commit, the linkgit:git-cherry-pick[1] command allows you to apply the change introduced by that commit and create a new commit that records it. So, for example, if "mywork" points to a series of patches on top of "origin", you might do something like: @@ -2542,7 +2542,7 @@ $ gitk origin..mywork & and browse through the list of patches in the mywork branch using gitk, applying them (possibly in a different order) to mywork-new using cherry-pick, and possibly modifying them as you go using `commit --amend`. -The gitlink:git-gui[1] command may also help as it allows you to +The linkgit:git-gui[1] command may also help as it allows you to individually select diff hunks for inclusion in the index (by right-clicking on the diff hunk and choosing "Stage Hunk for Commit"). @@ -2555,7 +2555,7 @@ $ git reset --hard origin ------------------------------------------------- Then modify, reorder, or eliminate patches as preferred before applying -them again with gitlink:git-am[1]. +them again with linkgit:git-am[1]. [[patch-series-tools]] Other tools @@ -2618,7 +2618,7 @@ published branches should never be rewritten. Why bisecting merge commits can be harder than bisecting linear history ----------------------------------------------------------------------- -The gitlink:git-bisect[1] command correctly handles history that +The linkgit:git-bisect[1] command correctly handles history that includes merge commits. However, when the commit that it finds is a merge commit, the user may need to work harder than usual to figure out why that commit introduced a problem. @@ -2651,7 +2651,7 @@ Nevertheless, the code at C is broken, because the callers added on the lower line of development have not been converted to the new semantics introduced on the upper line of development. So if all you know is that D is bad, that Z is good, and that -gitlink:git-bisect[1] identifies C as the culprit, how will you +linkgit:git-bisect[1] identifies C as the culprit, how will you figure out that the problem is due to this change in semantics? When the result of a git-bisect is a non-merge commit, you should @@ -2688,7 +2688,7 @@ Advanced branch management Fetching individual branches ---------------------------- -Instead of using gitlink:git-remote[1], you can also choose just +Instead of using linkgit:git-remote[1], you can also choose just to update one branch at a time, and to store it locally under an arbitrary name: @@ -2779,7 +2779,7 @@ Configuring remote branches We saw above that "origin" is just a shortcut to refer to the repository that you originally cloned from. This information is stored in git configuration variables, which you can see using -gitlink:git-config[1]: +linkgit:git-config[1]: ------------------------------------------------- $ git config -l @@ -2832,9 +2832,9 @@ throwing away commits on mybranch. Also note that all of the above configuration can be performed by directly editing the file .git/config instead of using -gitlink:git-config[1]. +linkgit:git-config[1]. -See gitlink:git-config[1] for more details on the configuration +See linkgit:git-config[1] for more details on the configuration options mentioned above. @@ -2900,7 +2900,7 @@ Commit Object The "commit" object links a physical state of a tree with a description of how we got there and why. Use the --pretty=raw option to -gitlink:git-show[1] or gitlink:git-log[1] to examine your favorite +linkgit:git-show[1] or linkgit:git-log[1] to examine your favorite commit: ------------------------------------------------ @@ -2941,9 +2941,9 @@ of the tree referred to by this commit with the trees associated with its parents. In particular, git does not attempt to record file renames explicitly, though it can identify cases where the existence of the same file data at changing paths suggests a rename. (See, for example, the --M option to gitlink:git-diff[1]). +-M option to linkgit:git-diff[1]). -A commit is usually created by gitlink:git-commit[1], which creates a +A commit is usually created by linkgit:git-commit[1], which creates a commit whose parent is normally the current HEAD, and whose tree is taken from the content currently stored in the index. @@ -2951,8 +2951,8 @@ taken from the content currently stored in the index. Tree Object ~~~~~~~~~~~ -The ever-versatile gitlink:git-show[1] command can also be used to -examine tree objects, but gitlink:git-ls-tree[1] will give you more +The ever-versatile linkgit:git-show[1] command can also be used to +examine tree objects, but linkgit:git-ls-tree[1] will give you more details: ------------------------------------------------ @@ -2991,7 +2991,7 @@ attention to the executable bit. Blob Object ~~~~~~~~~~~ -You can use gitlink:git-show[1] to examine the contents of a blob; take, +You can use linkgit:git-show[1] to examine the contents of a blob; take, for example, the blob in the entry for "COPYING" from the tree above: ------------------------------------------------ @@ -3013,7 +3013,7 @@ is totally independent of its location in the directory tree, and renaming a file does not change the object that file is associated with. Note that any tree or blob object can be examined using -gitlink:git-show[1] with the <revision>:<path> syntax. This can +linkgit:git-show[1] with the <revision>:<path> syntax. This can sometimes be useful for browsing the contents of a tree that is not currently checked out. @@ -3053,7 +3053,7 @@ Tag Object A tag object contains an object, object type, tag name, the name of the person ("tagger") who created the tag, and a message, which may contain -a signature, as can be seen using the gitlink:git-cat-file[1]: +a signature, as can be seen using the linkgit:git-cat-file[1]: ------------------------------------------------ $ git cat-file tag v1.5.0 @@ -3072,8 +3072,8 @@ nLE/L9aUXdWeTFPron96DLA= -----END PGP SIGNATURE----- ------------------------------------------------ -See the gitlink:git-tag[1] command to learn how to create and verify tag -objects. (Note that gitlink:git-tag[1] can also be used to create +See the linkgit:git-tag[1] command to learn how to create and verify tag +objects. (Note that linkgit:git-tag[1] can also be used to create "lightweight tags", which are not tag objects at all, but just simple references whose names begin with "refs/tags/"). @@ -3135,14 +3135,14 @@ $ git count-objects Although the object files are gone, any commands that refer to those objects will work exactly as they did before. -The gitlink:git-gc[1] command performs packing, pruning, and more for +The linkgit:git-gc[1] command performs packing, pruning, and more for you, so is normally the only high-level command you need. [[dangling-objects]] Dangling objects ~~~~~~~~~~~~~~~~ -The gitlink:git-fsck[1] command will sometimes complain about dangling +The linkgit:git-fsck[1] command will sometimes complain about dangling objects. They are not a problem. The most common cause of dangling objects is that you've rebased a @@ -3246,7 +3246,7 @@ which is sometimes a solvable problem. (Recovering missing trees and especially commits is *much* harder). Before starting, verify that there is corruption, and figure out where -it is with gitlink:git-fsck[1]; this may be time-consuming. +it is with linkgit:git-fsck[1]; this may be time-consuming. Assume the output looks like this: @@ -3264,7 +3264,7 @@ Now you know that blob 4b9458b3 is missing, and that the tree 2d9263c6 points to it. If you could find just one copy of that missing blob object, possibly in some other repository, you could move it into .git/objects/4b/9458b3... and be done. Suppose you can't. You can -still examine the tree that pointed to it with gitlink:git-ls-tree[1], +still examine the tree that pointed to it with linkgit:git-ls-tree[1], which might output something like: ------------------------------------------------ @@ -3282,7 +3282,7 @@ So now you know that the missing blob was the data for a file named say it's in "somedirectory". If you're lucky the missing copy might be the same as the copy you have checked out in your working tree at "somedirectory/myfile"; you can test whether that's right with -gitlink:git-hash-object[1]: +linkgit:git-hash-object[1]: ------------------------------------------------ $ git hash-object -w somedirectory/myfile @@ -3352,7 +3352,7 @@ The index The index is a binary file (generally kept in .git/index) containing a sorted list of path names, each with permissions and the SHA1 of a blob -object; gitlink:git-ls-files[1] can show you the contents of the index: +object; linkgit:git-ls-files[1] can show you the contents of the index: ------------------------------------------------- $ git ls-files --stage @@ -3374,7 +3374,7 @@ properties: 1. The index contains all the information necessary to generate a single (uniquely determined) tree object. + -For example, running gitlink:git-commit[1] generates this tree object +For example, running linkgit:git-commit[1] generates this tree object from the index, stores it in the object database, and uses it as the tree object associated with the new commit. @@ -3395,7 +3395,7 @@ you can create a three-way merge between them. + We saw in <<conflict-resolution>> that during a merge the index can store multiple versions of a single file (called "stages"). The third -column in the gitlink:git-ls-files[1] output above is the stage +column in the linkgit:git-ls-files[1] output above is the stage number, and will take on values other than 0 for files with merge conflicts. @@ -3444,7 +3444,7 @@ commit ID, so other developers who clone the containing project Partial checkouts of the superproject are possible: you can tell Git to clone none, some or all of the submodules. -The gitlink:git-submodule[1] command is available since Git 1.5.3. Users +The linkgit:git-submodule[1] command is available since Git 1.5.3. Users with Git 1.5.2 can look up the submodule commits in the repository and manually check them out; earlier versions won't recognize the submodules at all. @@ -3492,7 +3492,7 @@ The `git submodule add` command does a couple of things: - It clones the submodule under the current directory and by default checks out the master branch. -- It adds the submodule's clone path to the gitlink:gitmodules[5] file and +- It adds the submodule's clone path to the linkgit:gitmodules[5] file and adds this file to the index, ready to be committed. - It adds the submodule's current commit ID to the index, ready to be committed. @@ -3653,26 +3653,26 @@ understand its inner workings. Object access and manipulation ------------------------------ -The gitlink:git-cat-file[1] command can show the contents of any object, -though the higher-level gitlink:git-show[1] is usually more useful. +The linkgit:git-cat-file[1] command can show the contents of any object, +though the higher-level linkgit:git-show[1] is usually more useful. -The gitlink:git-commit-tree[1] command allows constructing commits with +The linkgit:git-commit-tree[1] command allows constructing commits with arbitrary parents and trees. -A tree can be created with gitlink:git-write-tree[1] and its data can be -accessed by gitlink:git-ls-tree[1]. Two trees can be compared with -gitlink:git-diff-tree[1]. +A tree can be created with linkgit:git-write-tree[1] and its data can be +accessed by linkgit:git-ls-tree[1]. Two trees can be compared with +linkgit:git-diff-tree[1]. -A tag is created with gitlink:git-mktag[1], and the signature can be -verified by gitlink:git-verify-tag[1], though it is normally simpler to -use gitlink:git-tag[1] for both. +A tag is created with linkgit:git-mktag[1], and the signature can be +verified by linkgit:git-verify-tag[1], though it is normally simpler to +use linkgit:git-tag[1] for both. [[the-workflow]] The Workflow ------------ -High-level operations such as gitlink:git-commit[1], -gitlink:git-checkout[1] and gitlink:git-reset[1] work by moving data +High-level operations such as linkgit:git-commit[1], +linkgit:git-checkout[1] and linkgit:git-reset[1] work by moving data between the working tree, the index, and the object database. Git provides low-level operations which perform each of these steps individually. @@ -3687,7 +3687,7 @@ combinations: working directory -> index ~~~~~~~~~~~~~~~~~~~~~~~~~~ -The gitlink:git-update-index[1] command updates the index with +The linkgit:git-update-index[1] command updates the index with information from the working directory. You generally update the index information by just specifying the filename you want to update, like so: @@ -3717,8 +3717,8 @@ stat information. It will 'not' update the object status itself, and it will only update the fields that are used to quickly test whether an object still matches its old backing store object. -The previously introduced gitlink:git-add[1] is just a wrapper for -gitlink:git-update-index[1]. +The previously introduced linkgit:git-add[1] is just a wrapper for +linkgit:git-update-index[1]. [[index-to-object-database]] index -> object database @@ -3865,7 +3865,7 @@ Examining the data You can examine the data represented in the object database and the index with various helper tools. For every object, you can use -gitlink:git-cat-file[1] to examine details about the +linkgit:git-cat-file[1] to examine details about the object: ------------------------------------------------- @@ -4528,7 +4528,7 @@ Scan Documentation/ for other stuff left out; in particular: - howto's - some of technical/? - hooks -- list of commands in gitlink:git[1] +- list of commands in linkgit:git[1] Scan email archives for other stuff left out |