<h2>Interactive mode</h2>\r
<div class="sectionbody">\r
<p>When the command enters the interactive mode, it shows the\r
-output of the <em>status</em> subcommand, and then goes into ints\r
+output of the <em>status</em> subcommand, and then goes into its\r
interactive command loop.</p>\r
<p>The command loop shows the list of subcommands available, and\r
gives a prompt "What now> ". In general, when the prompt ends\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 26-Dec-2006 03:21:38 UTC\r
+Last updated 17-Jan-2007 17:42:11 UTC\r
</div>\r
</div>\r
</body>\r
Interactive mode
----------------
When the command enters the interactive mode, it shows the
-output of the 'status' subcommand, and then goes into ints
+output of the 'status' subcommand, and then goes into its
interactive command loop.
The command loop shows the list of subcommands available, and
replaced; you need to use a tool such as <a href="git-diff.html">git-diff(1)</a> or the "pickaxe"\r
interface briefly mentioned in the following paragraph.</p>\r
<p>Apart from supporting file annotation, git also supports searching the\r
-development history for when a code snippet occured in a change. This makes it\r
+development history for when a code snippet occurred in a change. This makes it\r
possible to track when a code snippet was added to a file, moved or copied\r
between files, and eventually deleted or replaced. It works by searching for\r
a text string in the diff. A small example:</p>\r
<h2>THE PORCELAIN FORMAT</h2>\r
<div class="sectionbody">\r
<p>In this format, each line is output after a header; the\r
-header at the minumum has the first line which has:</p>\r
+header at the minimum has the first line which has:</p>\r
<ul>\r
<li>\r
<p>\r
header, prefixed by a TAB. This is to allow adding more\r
header elements later.</p>\r
</div>\r
-<h2>SPECIFIYING RANGES</h2>\r
+<h2>SPECIFYING RANGES</h2>\r
<div class="sectionbody">\r
<p>Unlike <tt>git-blame</tt> and <tt>git-annotate</tt> in older git, the extent\r
of annotation can be limited to both line ranges and revision\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 09-Nov-2006 18:45:28 UTC\r
+Last updated 17-Jan-2007 17:42:11 UTC\r
</div>\r
</div>\r
</body>\r
interface briefly mentioned in the following paragraph.
Apart from supporting file annotation, git also supports searching the
-development history for when a code snippet occured in a change. This makes it
+development history for when a code snippet occurred in a change. This makes it
possible to track when a code snippet was added to a file, moved or copied
between files, and eventually deleted or replaced. It works by searching for
a text string in the diff. A small example:
--------------------
In this format, each line is output after a header; the
-header at the minumum has the first line which has:
+header at the minimum has the first line which has:
- 40-byte SHA-1 of the commit the line is attributed to;
- the line number of the line in the original file;
header elements later.
-SPECIFIYING RANGES
-------------------
+SPECIFYING RANGES
+-----------------
Unlike `git-blame` and `git-annotate` in older git, the extent
of annotation can be limited to both line ranges and revision
</dt>\r
<dd>\r
<p>\r
- Show sha1 and commit subjectline for each head.\r
+ Show sha1 and commit subject line for each head.\r
</p>\r
</dd>\r
<dt>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 03-Jan-2007 22:02:01 UTC\r
+Last updated 17-Jan-2007 17:42:12 UTC\r
</div>\r
</div>\r
</body>\r
List both remote-tracking branches and local branches.
-v::
- Show sha1 and commit subjectline for each head.
+ Show sha1 and commit subject line for each head.
--abbrev=<length>::
Alter minimum display length for sha1 in output listing,
</dt>\r
<dd>\r
<p>\r
- Supress commit summary message.\r
+ Suppress commit summary message.\r
</p>\r
</dd>\r
<dt>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 17-Jan-2007 07:24:19 UTC\r
+Last updated 17-Jan-2007 17:42:13 UTC\r
</div>\r
</div>\r
</body>\r
are concluding a conflicted merge.
-q|--quiet::
- Supress commit summary message.
+ Suppress commit summary message.
\--::
Do not interpret any more arguments as options.
</dt>\r
<dd>\r
<p>\r
- CVS by default uses the unix username when writing its\r
+ CVS by default uses the Unix username when writing its\r
commit logs. Using this option and an author-conv-file\r
in this format\r
</p>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 08-Jan-2007 11:18:44 UTC\r
+Last updated 17-Jan-2007 17:42:13 UTC\r
</div>\r
</div>\r
</body>\r
Substitute the character "/" in branch names with <subst>
-A <author-conv-file>::
- CVS by default uses the unix username when writing its
+ CVS by default uses the Unix username when writing its
commit logs. Using this option and an author-conv-file
in this format
<p>Iterate over all refs that match <tt><pattern></tt> and show them\r
according to the given <tt><format></tt>, after sorting them according\r
to the given set of <tt><key></tt>. If <tt><max></tt> is given, stop after\r
-showing that many refs. The interporated values in <tt><format></tt>\r
+showing that many refs. The interpolated values in <tt><format></tt>\r
can optionally be quoted as string literals in the specified\r
host language allowing their direct evaluation in that language.</p>\r
</div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 28-Oct-2006 21:28:52 UTC\r
+Last updated 17-Jan-2007 17:42:14 UTC\r
</div>\r
</div>\r
</body>\r
Iterate over all refs that match `<pattern>` and show them
according to the given `<format>`, after sorting them according
to the given set of `<key>`. If `<max>` is given, stop after
-showing that many refs. The interporated values in `<format>`
+showing that many refs. The interpolated values in `<format>`
can optionally be quoted as string literals in the specified
host language allowing their direct evaluation in that language.
are not part of the current branch should remain available in\r
this repository. These types of entries are generally created as\r
a result of using <tt>git commit --amend</tt> or <tt>git rebase</tt> and are the\r
-commits prior to the amend or rebase occuring. Since these changes\r
+commits prior to the amend or rebase occurring. Since these changes\r
are not part of the current project most users will want to expire\r
them sooner. This option defaults to <em>30 days</em>.</p>\r
<p>The optional configuration variable <em>gc.rerereresolved</em> indicates\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 28-Dec-2006 00:59:28 UTC\r
+Last updated 17-Jan-2007 17:42:14 UTC\r
</div>\r
</div>\r
</body>\r
are not part of the current branch should remain available in
this repository. These types of entries are generally created as
a result of using `git commit \--amend` or `git rebase` and are the
-commits prior to the amend or rebase occuring. Since these changes
+commits prior to the amend or rebase occurring. Since these changes
are not part of the current project most users will want to expire
them sooner. This option defaults to '30 days'.
</dt>\r
<dd>\r
<p>\r
- Specify how multiple patterns are combined using boolean\r
+ Specify how multiple patterns are combined using Boolean\r
expressions. <tt>--or</tt> is the default operator. <tt>--and</tt> has\r
higher precedence than <tt>--or</tt>. <tt>-e</tt> has to be used for all\r
patterns.\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 19-Oct-2006 05:58:40 UTC\r
+Last updated 17-Jan-2007 17:42:15 UTC\r
</div>\r
</div>\r
</body>\r
combined by 'or'.
--and | --or | --not | ( | )::
- Specify how multiple patterns are combined using boolean
+ Specify how multiple patterns are combined using Boolean
expressions. `--or` is the default operator. `--and` has
higher precedence than `--or`. `-e` has to be used for all
patterns.
<p>\r
Specify the full path of <a href="git-upload-pack.html">git-upload-pack(1)</a> on the remote\r
host. This allows listing references from repositories accessed via\r
- SSH and where the SSH deamon does not use the PATH configured by the\r
+ SSH and where the SSH daemon does not use the PATH configured by the\r
user. Also see the <em>--exec</em> option for <a href="git-peek-remote.html">git-peek-remote(1)</a>.\r
</p>\r
</dd>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 03-Oct-2006 08:41:10 UTC\r
+Last updated 17-Jan-2007 17:42:15 UTC\r
</div>\r
</div>\r
</body>\r
-u <exec>, --upload-pack=<exec>::
Specify the full path of gitlink:git-upload-pack[1] on the remote
host. This allows listing references from repositories accessed via
- SSH and where the SSH deamon does not use the PATH configured by the
+ SSH and where the SSH daemon does not use the PATH configured by the
user. Also see the '--exec' option for gitlink:git-peek-remote[1].
<repository>::
<p>\r
This resets the metadata used by rerere if a merge resolution is to be\r
is aborted. Calling <a href="git-am.html">git-am(1)</a> --skip or <a href="git-rebase.html">git-rebase(1)</a>\r
-[--skip|--abort] will automatcally invoke this command.\r
+[--skip|--abort] will automatically invoke this command.\r
</p>\r
</dd>\r
<dt>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 15-Jan-2007 06:12:33 UTC\r
+Last updated 17-Jan-2007 17:42:16 UTC\r
</div>\r
</div>\r
</body>\r
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]
-[--skip|--abort] will automatcally invoke this command.
+[--skip|--abort] will automatically invoke this command.
'diff'::
</div>\r
<h2>DESCRIPTION</h2>\r
<div class="sectionbody">\r
-<p>Sets up the normal git environment variables and a few helper functions\r
-(currently just "die()"), and returns OK if it all looks like a git archive.\r
-So, to make the rest of the git scripts more careful and readable,\r
-use it as follows:</p>\r
-<div class="listingblock">\r
-<div class="content">\r
-<pre><tt>. git-sh-setup || die "Not a git archive"</tt></pre>\r
-</div></div>\r
+<p>This is not a command the end user would want to run. Ever.\r
+This documentation is meant for people who are studying the\r
+Porcelain-ish scripts and/or are writing new ones.</p>\r
+<p>The <tt>git-sh-setup</tt> scriptlet is designed to be sourced (using\r
+<tt>.</tt>) by other shell scripts to set up some variables pointing at\r
+the normal git directories and a few helper shell functions.</p>\r
+<p>Before sourcing it, your script should set up a few variables;\r
+<tt>USAGE</tt> (and <tt>LONG_USAGE</tt>, if any) is used to define message\r
+given by <tt>usage()</tt> shell function. <tt>SUBDIRECTORY_OK</tt> can be set\r
+if the script can run from a subdirectory of the working tree\r
+(some commands do not).</p>\r
+<p>The scriptlet sets <tt>GIT_DIR</tt> and <tt>GIT_OBJECT_DIRECTORY</tt> shell\r
+variables, but does <strong>not</strong> export them to the environment.</p>\r
+</div>\r
+<h2>FUNCTIONS</h2>\r
+<div class="sectionbody">\r
+<dl>\r
+<dt>\r
+die\r
+</dt>\r
+<dd>\r
+<p>\r
+ exit after emitting the supplied error message to the\r
+ standard error stream.\r
+</p>\r
+</dd>\r
+<dt>\r
+usage\r
+</dt>\r
+<dd>\r
+<p>\r
+ die with the usage message.\r
+</p>\r
+</dd>\r
+<dt>\r
+set_reflog_action\r
+</dt>\r
+<dd>\r
+<p>\r
+ set the message that will be recorded to describe the\r
+ end-user action in the reflog, when the script updates a\r
+ ref.\r
+</p>\r
+</dd>\r
+<dt>\r
+is_bare_repository\r
+</dt>\r
+<dd>\r
+<p>\r
+ outputs <tt>true</tt> or <tt>false</tt> to the standard output stream\r
+ to indicate if the repository is a bare repository\r
+ (i.e. without an associated working tree).\r
+</p>\r
+</dd>\r
+<dt>\r
+cd_to_toplevel\r
+</dt>\r
+<dd>\r
+<p>\r
+ runs chdir to the toplevel of the working tree.\r
+</p>\r
+</dd>\r
+<dt>\r
+require_work_tree\r
+</dt>\r
+<dd>\r
+<p>\r
+ checks if the repository is a bare repository, and dies\r
+ if so. Used by scripts that require working tree\r
+ (e.g. <tt>checkout</tt>).\r
+</p>\r
+</dd>\r
+</dl>\r
</div>\r
<h2>Author</h2>\r
<div class="sectionbody">\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 03-Oct-2006 08:41:30 UTC\r
+Last updated 17-Jan-2007 17:42:17 UTC\r
</div>\r
</div>\r
</body>\r
DESCRIPTION
-----------
-Sets up the normal git environment variables and a few helper functions
-(currently just "die()"), and returns OK if it all looks like a git archive.
-So, to make the rest of the git scripts more careful and readable,
-use it as follows:
-
--------------------------------------------------
-. git-sh-setup || die "Not a git archive"
--------------------------------------------------
+This is not a command the end user would want to run. Ever.
+This documentation is meant for people who are studying the
+Porcelain-ish scripts and/or are writing new ones.
+
+The `git-sh-setup` scriptlet is designed to be sourced (using
+`.`) by other shell scripts to set up some variables pointing at
+the normal git directories and a few helper shell functions.
+
+Before sourcing it, your script should set up a few variables;
+`USAGE` (and `LONG_USAGE`, if any) is used to define message
+given by `usage()` shell function. `SUBDIRECTORY_OK` can be set
+if the script can run from a subdirectory of the working tree
+(some commands do not).
+
+The scriptlet sets `GIT_DIR` and `GIT_OBJECT_DIRECTORY` shell
+variables, but does *not* export them to the environment.
+
+FUNCTIONS
+---------
+
+die::
+ exit after emitting the supplied error message to the
+ standard error stream.
+
+usage::
+ die with the usage message.
+
+set_reflog_action::
+ set the message that will be recorded to describe the
+ end-user action in the reflog, when the script updates a
+ ref.
+
+is_bare_repository::
+ outputs `true` or `false` to the standard output stream
+ to indicate if the repository is a bare repository
+ (i.e. without an associated working tree).
+
+cd_to_toplevel::
+ runs chdir to the toplevel of the working tree.
+
+require_work_tree::
+ checks if the repository is a bare repository, and dies
+ if so. Used by scripts that require working tree
+ (e.g. `checkout`).
+
Author
------
</dt>\r
<dd>\r
<p>\r
- Supress commit description and provide a commit count summary only.\r
+ Suppress commit description and provide a commit count summary only.\r
</p>\r
</dd>\r
</dl>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 27-Nov-2006 20:03:15 UTC\r
+Last updated 17-Jan-2007 17:42:16 UTC\r
</div>\r
</div>\r
</body>\r
of author alphabetic order.
-s::
- Supress commit description and provide a commit count summary only.
+ Suppress commit description and provide a commit count summary only.
FILES
-----
<p>The output from this command is designed to be used as a commit\r
template comments, and all the output lines are prefixed with <em>#</em>.</p>\r
</div>\r
+<h2>CONFIGURATION</h2>\r
+<div class="sectionbody">\r
+<p>The command honors <tt>color.status</tt> (or <tt>status.color</tt> — they\r
+mean the same thing and the latter is kept for backward\r
+compatibility) and <tt>color.status.<slot></tt> configuration variables\r
+to colorize its output.</p>\r
+</div>\r
<h2>Author</h2>\r
<div class="sectionbody">\r
<p>Written by Linus Torvalds <torvalds@osdl.org> and\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 03-Oct-2006 08:41:31 UTC\r
+Last updated 17-Jan-2007 17:42:17 UTC\r
</div>\r
</div>\r
</body>\r
template comments, and all the output lines are prefixed with '#'.
+CONFIGURATION
+-------------
+
+The command honors `color.status` (or `status.color` -- they
+mean the same thing and the latter is kept for backward
+compatibility) and `color.status.<slot>` configuration variables
+to colorize its output.
+
+
Author
------
Written by Linus Torvalds <torvalds@osdl.org> and
<dd>\r
<p>\r
Commits the diff of two tree-ish arguments from the\r
- command-line. This command is intended for interopability with\r
+ command-line. This command is intended for interoperability with\r
git-svnimport and does not rely on being inside an git-svn\r
init-ed repository. This command takes three arguments, (a) the\r
original tree to diff against, (b) the new tree result, (c) the\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 13-Jan-2007 08:09:03 UTC\r
+Last updated 17-Jan-2007 17:42:17 UTC\r
</div>\r
</div>\r
</body>\r
'commit-diff'::
Commits the diff of two tree-ish arguments from the
- command-line. This command is intended for interopability with
+ command-line. This command is intended for interoperability with
git-svnimport and does not rely on being inside an git-svn
init-ed repository. This command takes three arguments, (a) the
original tree to diff against, (b) the new tree result, (c) the
<h2>NAME</h2>\r
<div class="sectionbody">\r
<p>git-tag -\r
- Create a tag object signed with GPG\r
+ Create or verify a tag object signed with GPG\r
</p>\r
</div>\r
</div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 03-Jan-2007 22:02:03 UTC\r
+Last updated 17-Jan-2007 17:42:18 UTC\r
</div>\r
</div>\r
</body>\r
NAME
----
-git-tag - Create a tag object signed with GPG
+git-tag - Create or verify a tag object signed with GPG
SYNOPSIS
<pre><tt>umask = 002 ;# group friendly</tt></pre>\r
</div></div>\r
<p>The special umask value "user" indicates that the user's current umask\r
-will be used instead. The default value remains 0, which means world\r
+will be used instead. The default value is 002, which means group\r
readable/writable files and directories.</p>\r
</div>\r
<h2>EXAMPLES</h2>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 03-Oct-2006 08:41:34 UTC\r
+Last updated 17-Jan-2007 17:42:19 UTC\r
</div>\r
</div>\r
</body>\r
umask = 002 ;# group friendly
The special umask value "user" indicates that the user's current umask
-will be used instead. The default value remains 0, which means world
+will be used instead. The default value is 002, which means group
readable/writable files and directories.
EXAMPLES
</li>\r
<li>\r
<p>\r
-<strong>gitweb</strong> (ftp://ftp.kernel.org/pub/software/scm/gitweb/)\r
+<strong>gitweb</strong> (shipped with git-core)\r
</p>\r
<div class="literalblock">\r
<div class="content">\r
viewers and commit tools.</tt></pre>\r
</div></div>\r
</li>\r
+<li>\r
+<p>\r
+<strong>tig</strong> (http://jonas.nitro.dk/tig/)\r
+</p>\r
+<div class="literalblock">\r
+<div class="content">\r
+<pre><tt>tig by Jonas Fonseca is a simple git repository browser\r
+written using ncurses. Basically, it just acts as a front-end\r
+for git-log and git-show/git-diff. Additionally, you can also\r
+use it as a pager for git commands.</tt></pre>\r
+</div></div>\r
+</li>\r
</ul>\r
</div>\r
<h2>Foreign SCM interface</h2>\r
<ul>\r
<li>\r
<p>\r
-<strong>git-svn</strong> (contrib/)\r
+<strong>git-svn</strong> (shipped with git-core)\r
</p>\r
<div class="literalblock">\r
<div class="content">\r
</div></div>\r
</li>\r
</ul>\r
+<p>http://git.or.cz/gitwiki/InterfacesFrontendsAndTools has more\r
+comprehensive list.</p>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 03-Oct-2006 08:41:49 UTC\r
+Last updated 17-Jan-2007 17:42:22 UTC\r
</div>\r
</div>\r
</body>\r
gitview is a GTK based repository browser for git
- - *gitweb* (ftp://ftp.kernel.org/pub/software/scm/gitweb/)
+ - *gitweb* (shipped with git-core)
GITweb provides full-fledged web interface for GIT repositories.
Currently it is the fastest and most feature rich among the git
viewers and commit tools.
+ - *tig* (http://jonas.nitro.dk/tig/)
+
+ tig by Jonas Fonseca is a simple git repository browser
+ written using ncurses. Basically, it just acts as a front-end
+ for git-log and git-show/git-diff. Additionally, you can also
+ use it as a pager for git commands.
Foreign SCM interface
---------------------
- - *git-svn* (contrib/)
+ - *git-svn* (shipped with git-core)
git-svn is a simple conduit for changesets between a single Subversion
branch and git.
This is an Emacs interface for git. The user interface is modeled on
pcl-cvs. It has been developed on Emacs 21 and will probably need some
tweaking to work on XEmacs.
+
+
+http://git.or.cz/gitwiki/InterfacesFrontendsAndTools has more
+comprehensive list.
</p>\r
</dd>\r
<dt>\r
---max-count=<n>\r
+-<n>\r
</dt>\r
<dd>\r
<p>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 03-Oct-2006 08:41:39 UTC\r
+Last updated 17-Jan-2007 17:42:19 UTC\r
</div>\r
</div>\r
</body>\r
output format that is useful only to tell the changed
paths and their nature of changes.
---max-count=<n>::
+-<n>::
Limit output to <n> commits.
<since>..<until>::
</dt>\r
<dd>\r
<p>\r
- An example script to create a tag object signed with GPG.\r
+ Create or verify a tag object signed with GPG.\r
</p>\r
</dd>\r
<dt>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 13-Jan-2007 08:09:04 UTC\r
+Last updated 17-Jan-2007 17:42:20 UTC\r
</div>\r
</div>\r
</body>\r
Read and modify symbolic refs.
gitlink:git-tag[1]::
- An example script to create a tag object signed with GPG.
+ Create or verify a tag object signed with GPG.
gitlink:git-update-ref[1]::
Update the object name stored in a ref safely.
projects / git.git / commitdiff