.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-ADD" "1" "12/26/2006" "" ""
+.TH "GIT\-ADD" "1" "01/17/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
git\-add git\-*.sh
Considers adding content from all git\-*.sh scripts. Because this example lets shell expand the asterisk (i.e. you are listing the files explicitly), it does not consider subdir/git\-foo.sh.
.SH "INTERACTIVE MODE"
-When the command enters the interactive mode, it shows the output of the \fIstatus\fR subcommand, and then goes into ints interactive command loop.
+When the command enters the interactive mode, it shows the output of the \fIstatus\fR subcommand, and then goes into its interactive command loop.
The command loop shows the list of subcommands available, and gives a prompt "What now> ". In general, when the prompt ends with a single \fI>\fR, you can pick only one of the choices given and type return, like this:
.sp
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-BLAME" "1" "11/09/2006" "" ""
+.TH "GIT\-BLAME" "1" "01/17/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.fi
.SH "DESCRIPTION"
Annotates each line in the given file with information from the revision which last modified the line. Optionally, start annotating from the given revision.
-.sp
+
Also it can limit the range of lines annotated.
-.sp
+
This report doesn't tell you anything about lines which have been deleted or replaced; you need to use a tool such as \fBgit\-diff\fR(1) or the "pickaxe" interface briefly mentioned in the following paragraph.
-.sp
-Apart from supporting file annotation, git also supports searching the development history for when a code snippet occured 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:
-.sp
+
+Apart from supporting file annotation, git also supports searching the 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:
.sp
.nf
$ git log \-\-pretty=oneline \-S'blame_usage'
.SH "OPTIONS"
.TP
\-c, \-\-compatibility
-Use the same output mode as
-\fBgit\-annotate\fR(1)
-(Default: off).
+Use the same output mode as \fBgit\-annotate\fR(1) (Default: off).
.TP
\-L n,m
Annotate only the specified line range (lines count from 1).
Show raw timestamp (Default: off).
.TP
\-S, \-\-rev\-file <revs\-file>
-Use revs from revs\-file instead of calling
-\fBgit\-rev\-list\fR(1).
+Use revs from revs\-file instead of calling \fBgit\-rev\-list\fR(1).
.TP
\-f, \-\-show\-name
Show filename in the original commit. By default filename is shown if there is any line that came from a file with different name, due to rename detection.
Show in a format designed for machine consumption.
.TP
\-M
-Detect moving lines in the file as well. When a commit moves a block of lines in a file (e.g. the original file has A and then B, and the commit changes it to B and then A), traditional
-\fIblame\fR
-algorithm typically blames the lines that were moved up (i.e. B) to the parent and assigns blame to the lines that were moved down (i.e. A) to the child commit. With this option, both groups of lines are blamed on the parent.
+Detect moving lines in the file as well. When a commit moves a block of lines in a file (e.g. the original file has A and then B, and the commit changes it to B and then A), traditional \fIblame\fR algorithm typically blames the lines that were moved up (i.e. B) to the parent and assigns blame to the lines that were moved down (i.e. A) to the child commit. With this option, both groups of lines are blamed on the parent.
.TP
\-C
-In addition to
-\-M, detect lines copied from other files that were modified in the same commit. This is useful when you reorganize your program and move code around across files. When this option is given twice, the command looks for copies from all other files in the parent for the commit that creates the file in addition.
+In addition to \-M, detect lines copied from other files that were modified in the same commit. This is useful when you reorganize your program and move code around across files. When this option is given twice, the command looks for copies from all other files in the parent for the commit that creates the file in addition.
.TP
\-h, \-\-help
Show help message.
.SH "THE PORCELAIN FORMAT"
-In this format, each line is output after a header; the header at the minumum has the first line which has:
-.sp
+In this format, each line is output after a header; the header at the minimum has the first line which has:
.TP 3
\(bu
40\-byte SHA\-1 of the commit the line is attributed to;
.TP
\(bu
on a line that starts a group of line from a different commit than the previous one, the number of lines in this group. On subsequent lines this field is absent.
+
This header line is followed by the following information at least once for each commit:
-.sp
.TP 3
\(bu
author name ("author"), email ("author\-mail"), time ("author\-time"), and timezone ("author\-tz"); similarly for committer.
.TP
\(bu
the first line of the commit log message ("summary").
+
The contents of the actual line is output after the above header, prefixed by a TAB. This is to allow adding more header elements later.
-.sp
-.SH "SPECIFIYING RANGES"
+.SH "SPECIFYING RANGES"
Unlike git\-blame and git\-annotate in older git, the extent of annotation can be limited to both line ranges and revision ranges. When you are interested in finding the origin for ll. 40\-60 for file foo, you can use \-L option like this:
.sp
-.sp
.nf
git blame \-L 40,60 foo
.fi
Also you can use regular expression to specify the line range.
.sp
-.sp
.nf
git blame \-L '/^sub hello {/,/^}$/' foo
.fi
would limit the annotation to the body of hello subroutine.
-.sp
+
When you are not interested in changes older than the version v2.6.18, or changes older than 3 weeks, you can use revision range specifiers similar to git\-rev\-list:
.sp
-.sp
.nf
git blame v2.6.18.. \-\- foo
git blame \-\-since=3.weeks \-\- foo
.fi
When revision range specifiers are used to limit the annotation, lines that have not changed since the range boundary (either the commit v2.6.18 or the most recent commit that is more than 3 weeks old in the above example) are blamed for that range boundary commit.
-.sp
+
A particularly useful way is to see if an added file have lines created by copy\-and\-paste from existing files. Sometimes this indicates that the developer was being sloppy and did not refactor the code properly. You can first find the commit that introduced the file with:
.sp
-.sp
.nf
git log \-\-diff\-filter=A \-\-pretty=short \-\- foo
.fi
and then annotate the change between the commit and its parents, using commit^! notation:
.sp
-.sp
.nf
git blame \-C \-C \-f $commit^! \-\- foo
.fi
.SH "SEE ALSO"
\fBgit\-annotate\fR(1)
-.sp
.SH "AUTHOR"
Written by Junio C Hamano <junkio@cox.net>
-.sp
.SH "GIT"
Part of the \fBgit\fR(7) suite
-.sp
+
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-BRANCH" "1" "01/03/2007" "" ""
+.TH "GIT\-BRANCH" "1" "01/17/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
List both remote\-tracking branches and local branches.
.TP
\-v
-Show sha1 and commit subjectline for each head.
+Show sha1 and commit subject line for each head.
.TP
\-\-abbrev=<length>
Alter minimum display length for sha1 in output listing, default value is 7.
Before making a commit out of staged contents so far, stage the contents of paths given on the command line as well. This is usually not what you want unless you are concluding a conflicted merge.
.TP
\-q|\-\-quiet
-Supress commit summary message.
+Suppress commit summary message.
.TP
\-\-
Do not interpret any more arguments as options.
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-CVSIMPORT" "1" "01/08/2007" "" ""
+.TH "GIT\-CVSIMPORT" "1" "01/17/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
Substitute the character "/" in branch names with <subst>
.TP
\-A <author\-conv\-file>
-CVS by default uses the unix username when writing its commit logs. Using this option and an author\-conv\-file in this format
+CVS by default uses the Unix username when writing its commit logs. Using this option and an author\-conv\-file in this format
.TP
\-a
Import all commits, including recent ones. cvsimport by default skips commits that have a timestamp less than 10 minutes ago.
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-FOR\-EACH\-REF" "1" "10/28/2006" "" ""
+.TH "GIT\-FOR\-EACH\-REF" "1" "01/17/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
git\-for\-each\-ref \- Output information on each ref
.SH "SYNOPSIS"
\fIgit\-for\-each\-ref\fR [\-\-count=<count>]* [\-\-shell|\-\-perl|\-\-python] [\-\-sort=<key>]* [\-\-format=<format>] [<pattern>]
-.sp
.SH "DESCRIPTION"
-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> can optionally be quoted as string literals in the specified host language allowing their direct evaluation in that language.
-.sp
+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 interpolated values in <format> can optionally be quoted as string literals in the specified host language allowing their direct evaluation in that language.
.SH "OPTIONS"
.TP
<count>
-By default the command shows all refs that match
-<pattern>. This option makes it stop after showing that many refs.
+By default the command shows all refs that match <pattern>. This option makes it stop after showing that many refs.
.TP
<key>
-A field name to sort on. Prefix
-\-
-to sort in descending order of the value. When unspecified,
-refname
-is used. More than one sort keys can be given.
+A field name to sort on. Prefix \- to sort in descending order of the value. When unspecified, refname is used. More than one sort keys can be given.
.TP
<format>
-A string that interpolates
-%(fieldname)
-from the object pointed at by a ref being shown. If
-fieldname
-is prefixed with an asterisk (*) and the ref points at a tag object, the value for the field in the object tag refers is used. When unspecified, defaults to
-%(objectname) SPC %(objecttype) TAB %(refname). It also interpolates
-%%
-to
-%, and
-%xx
-where
-xx
-are hex digits interpolates to character with hex code
-xx; for example
-%00
-interpolates to
-\\0
-(NUL),
-%09
-to
-\\t
-(TAB) and
-%0a
-to
-\\n
-(LF).
+A string that interpolates %(fieldname) from the object pointed at by a ref being shown. If fieldname is prefixed with an asterisk (*) and the ref points at a tag object, the value for the field in the object tag refers is used. When unspecified, defaults to %(objectname) SPC %(objecttype) TAB %(refname). It also interpolates %% to %, and %xx where xx are hex digits interpolates to character with hex code xx; for example %00 interpolates to \\0 (NUL), %09 to \\t (TAB) and %0a to \\n (LF).
.TP
<pattern>
If given, the name of the ref is matched against this using fnmatch(3). Refs that do not match the pattern are not shown.
.TP
\-\-shell, \-\-perl, \-\-python
-If given, strings that substitute
-%(fieldname)
-placeholders are quoted as string literals suitable for the specified host language. This is meant to produce a scriptlet that can directly be `eval`ed.
+If given, strings that substitute %(fieldname) placeholders are quoted as string literals suitable for the specified host language. This is meant to produce a scriptlet that can directly be `eval`ed.
.SH "FIELD NAMES"
Various values from structured fields in referenced objects can be used to interpolate into the resulting output, or as sort keys.
-.sp
+
For all objects, the following names can be used:
-.sp
.TP
refname
The name of the ref (the part after $GIT_DIR/refs/).
.TP
objecttype
-The type of the object (blob,
-tree,
-commit,
-tag).
+The type of the object (blob, tree, commit, tag).
.TP
objectsize
-The size of the object (the same as
-git\-cat\-file \-s
-reports).
+The size of the object (the same as git\-cat\-file \-s reports).
.TP
objectname
The object name (aka SHA\-1).
+
In addition to the above, for commit and tag objects, the header field names (tree, parent, object, type, and tag) can be used to specify the value in the header field.
-.sp
+
Fields that have name\-email\-date tuple as its value (author, committer, and tagger) can be suffixed with name, email, and date to extract the named component.
-.sp
+
The first line of the message in a commit and tag object is subject, the remaining lines are body. The whole message is contents.
-.sp
+
For sorting purposes, fields with numeric values sort in numeric order (objectsize, authordate, committerdate, taggerdate). All other fields are used to sort in their byte\-value order.
-.sp
+
In any case, a field name that refers to a field inapplicable to the object referred by the ref does not cause an error. It returns an empty string instead.
-.sp
.SH "EXAMPLES"
An example directly producing formatted text. Show the most recent 3 tagged commits::
.sp
-.sp
.nf
#!/bin/sh
.fi
A simple example showing the use of shell eval on the output, demonstrating the use of \-\-shell. List the prefixes of all heads::
.sp
-.sp
.nf
#!/bin/sh
.fi
A bit more elaborate report on tags, demonstrating that the format may be an entire script::
.sp
-.sp
.nf
#!/bin/sh
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-GC" "1" "12/28/2006" "" ""
+.TH "GIT\-GC" "1" "01/17/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.SH "CONFIGURATION"
The optional configuration variable \fIgc.reflogExpire\fR can be set to indicate how long historical entries within each branch's reflog should remain available in this repository. The setting is expressed as a length of time, for example \fI90 days\fR or \fI3 months\fR. It defaults to \fI90 days\fR.
-The optional configuration variable \fIgc.reflogExpireUnreachable\fR can be set to indicate how long historical reflog entries which 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 are not part of the current project most users will want to expire them sooner. This option defaults to \fI30 days\fR.
+The optional configuration variable \fIgc.reflogExpireUnreachable\fR can be set to indicate how long historical reflog entries which 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 occurring. Since these changes are not part of the current project most users will want to expire them sooner. This option defaults to \fI30 days\fR.
The optional configuration variable \fIgc.rerereresolved\fR indicates how long records of conflicted merge you resolved earlier are kept. This defaults to 60 days.
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-GREP" "1" "10/19/2006" "" ""
+.TH "GIT\-GREP" "1" "01/17/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.fi
.SH "DESCRIPTION"
Look for specified patterns in the working tree files, blobs registered in the index file, or given tree objects.
-.sp
.SH "OPTIONS"
.TP
\-\-cached
Select non\-matching lines.
.TP
\-h | \-H
-By default, the command shows the filename for each match.
-\-h
-option is used to suppress this output.
-\-H
-is there for completeness and does not do anything except it overrides
-\-h
-given earlier on the command line.
+By default, the command shows the filename for each match. \-h option is used to suppress this output. \-H is there for completeness and does not do anything except it overrides \-h given earlier on the command line.
.TP
\-\-full\-name
When run from a subdirectory, the command usually outputs paths relative to the current directory. This option forces paths to be output relative to the project top directory.
Instead of showing every matched line, show the number of lines that match.
.TP
\-[ABC] <context>
-Show
-context
-trailing (A
-\(em after), or leading (B
-\(em before), or both (C
-\(em context) lines, and place a line containing
-\-\-
-between contiguous groups of matches.
+Show context trailing (A \(em after), or leading (B \(em before), or both (C \(em context) lines, and place a line containing \-\- between contiguous groups of matches.
.TP
\-f <file>
Read patterns from <file>, one per line.
.TP
\-e
-The next parameter is the pattern. This option has to be used for patterns starting with \- and should be used in scripts passing user input to grep. Multiple patterns are combined by
-\fIor\fR.
+The next parameter is the pattern. This option has to be used for patterns starting with \- and should be used in scripts passing user input to grep. Multiple patterns are combined by \fIor\fR.
.TP
\-\-and | \-\-or | \-\-not | ( | )
-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.
+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.
.TP
\-\-all\-match
-When giving multiple pattern expressions combined with
-\-\-or, this flag is specified to limit the match to files that have lines to match all of them.
+When giving multiple pattern expressions combined with \-\-or, this flag is specified to limit the match to files that have lines to match all of them.
.TP
<tree>\&...
Search blobs in the trees for specified patterns.
.SH "EXAMPLE"
.TP
git grep \-e '#define' \-\-and \\( \-e MAX_PATH \-e PATH_MAX \\)
-Looks for a line that has
-#define
-and either
-MAX_PATH
-or
-PATH_MAX.
+Looks for a line that has #define and either MAX_PATH or PATH_MAX.
.TP
git grep \-\-all\-match \-e NODE \-e Unexpected
-Looks for a line that has
-NODE
-or
-Unexpected
-in files that have lines that match both.
+Looks for a line that has NODE or Unexpected in files that have lines that match both.
.SH "AUTHOR"
Originally written by Linus Torvalds <torvalds@osdl.org>, later revamped by Junio C Hamano.
-.sp
.SH "DOCUMENTATION"
Documentation by Junio C Hamano and the git\-list <git@vger.kernel.org>.
-.sp
.SH "GIT"
Part of the \fBgit\fR(7) suite
-.sp
+
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-LS\-REMOTE" "1" "10/03/2006" "" ""
+.TH "GIT\-LS\-REMOTE" "1" "01/17/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.fi
.SH "DESCRIPTION"
Displays references available in a remote repository along with the associated commit IDs.
-.sp
.SH "OPTIONS"
.TP
\-h|\-\-heads, \-t|\-\-tags
Limit to only refs/heads and refs/tags, respectively. These options are _not_ mutually exclusive; when given both, references stored in refs/heads and refs/tags are displayed.
.TP
\-u <exec>, \-\-upload\-pack=<exec>
-Specify the full path of
-\fBgit\-upload\-pack\fR(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 user. Also see the
-\fI\-\-exec\fR
-option for
-\fBgit\-peek\-remote\fR(1).
+Specify the full path of \fBgit\-upload\-pack\fR(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. Also see the \fI\-\-exec\fR option for \fBgit\-peek\-remote\fR(1).
.TP
<repository>
Location of the repository. The shorthand defined in $GIT_DIR/branches/ can be used. Use "." (dot) to list references in the local repository.
.fi
.SH "AUTHOR"
Written by Junio C Hamano <junkio@cox.net>
-.sp
.SH "GIT"
Part of the \fBgit\fR(7) suite
-.sp
+
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-RERERE" "1" "01/15/2007" "" ""
+.TH "GIT\-RERERE" "1" "01/17/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
Normally, git\-rerere is run without arguments or user\-intervention. However, it has several commands that allow it to interact with its working state.
.TP
\fIclear\fR
-This resets the metadata used by rerere if a merge resolution is to be is aborted. Calling \fBgit\-am\fR(1) \-\-skip or \fBgit\-rebase\fR(1) [\-\-skip|\-\-abort] will automatcally invoke this command.
+This resets the metadata used by rerere if a merge resolution is to be is aborted. Calling \fBgit\-am\fR(1) \-\-skip or \fBgit\-rebase\fR(1) [\-\-skip|\-\-abort] will automatically invoke this command.
.TP
\fIdiff\fR
This displays diffs for the current state of the resolution. It is useful for tracking what has changed while the user is resolving conflicts. Additional arguments are passed directly to the system diff(1) command installed in PATH.
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-SH\-SETUP" "1" "10/03/2006" "" ""
+.TH "GIT\-SH\-SETUP" "1" "01/17/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
git\-sh\-setup \- Common git shell script setup code
.SH "SYNOPSIS"
\fIgit\-sh\-setup\fR
-.sp
.SH "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:
-.sp
-.sp
-.nf
-. git\-sh\-setup || die "Not a git archive"
-.fi
+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 \fBnot\fR export them to the environment.
+.SH "FUNCTIONS"
+.TP
+die
+exit after emitting the supplied error message to the standard error stream.
+.TP
+usage
+die with the usage message.
+.TP
+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.
+.TP
+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).
+.TP
+cd_to_toplevel
+runs chdir to the toplevel of the working tree.
+.TP
+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).
.SH "AUTHOR"
Written by Linus Torvalds <torvalds@osdl.org>
-.sp
.SH "DOCUMENTATION"
Documentation by Junio C Hamano and the git\-list <git@vger.kernel.org>.
-.sp
.SH "GIT"
Part of the \fBgit\fR(7) suite
-.sp
+
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-SHORTLOG" "1" "11/27/2006" "" ""
+.TH "GIT\-SHORTLOG" "1" "01/17/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
git\-shortlog \- Summarize 'git log' output
.SH "SYNOPSIS"
git\-log \-\-pretty=short | \fIgit\-shortlog\fR [\-h] [\-n] [\-s] git\-shortlog [\-n|\-\-number] [\-s|\-\-summary] [<committish>\&...]
-.sp
.SH "DESCRIPTION"
Summarizes \fIgit log\fR output in a format suitable for inclusion in release announcements. Each commit will be grouped by author and the first line of the commit message will be shown.
-.sp
+
Additionally, "[PATCH]" will be stripped from the commit description.
-.sp
.SH "OPTIONS"
.TP
\-h
Sort output according to the number of commits per author instead of author alphabetic order.
.TP
\-s
-Supress commit description and provide a commit count summary only.
+Suppress commit description and provide a commit count summary only.
.SH "FILES"
.TP
\fI.mailmap\fR
-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
-\fI<\fR
-and
-\fI>\fR. Use hash
-\fI#\fR
-for comments. Example:
+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 \fI<\fR and \fI>\fR. Use hash \fI#\fR for comments. Example:
.sp
.nf
# Keep alphabetized
.fi
.SH "AUTHOR"
Written by Jeff Garzik <jgarzik@pobox.com>
-.sp
.SH "DOCUMENTATION"
Documentation by Junio C Hamano.
-.sp
.SH "GIT"
Part of the \fBgit\fR(7) suite
-.sp
+
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-STATUS" "1" "10/03/2006" "" ""
+.TH "GIT\-STATUS" "1" "01/17/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
git\-status \- Show working tree status
.SH "SYNOPSIS"
\fIgit\-status\fR <options>\&...
-.sp
.SH "DESCRIPTION"
Examines paths in the working tree that has changes unrecorded to the index file, and changes between the index file and the current HEAD commit. The former paths are what you _could_ commit by running \fIgit\-update\-index\fR before running \fIgit commit\fR, and the latter paths are what you _would_ commit by running \fIgit commit\fR.
-.sp
+
If there is no path that is different between the index file and the current HEAD commit, the command exits with non\-zero status.
-.sp
+
The command takes the same set of options as git\-commit; it shows what would be committed if the same options are given to git\-commit.
-.sp
.SH "OUTPUT"
The output from this command is designed to be used as a commit template comments, and all the output lines are prefixed with \fI#\fR.
-.sp
+.SH "CONFIGURATION"
+The command honors color.status (or status.color \(em they mean the same thing and the latter is kept for backward compatibility) and color.status.<slot> configuration variables to colorize its output.
.SH "AUTHOR"
Written by Linus Torvalds <torvalds@osdl.org> and Junio C Hamano <junkio@cox.net>.
-.sp
.SH "DOCUMENTATION"
Documentation by David Greaves, Junio C Hamano and the git\-list <git@vger.kernel.org>.
-.sp
.SH "GIT"
Part of the \fBgit\fR(7) suite
-.sp
+
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-SVN" "1" "01/13/2007" "" ""
+.TH "GIT\-SVN" "1" "01/17/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
Recursively finds and lists the svn:ignore property on directories. The output is suitable for appending to the $GIT_DIR/info/exclude file.
.TP
\fIcommit\-diff\fR
-Commits the diff of two tree\-ish arguments from the command\-line. This command is intended for interopability 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 URL of the target Subversion repository. The final argument (URL) may be omitted if you are working from a git\-svn\-aware repository (that has been init\-ed with git\-svn). The \-r<revision> option is required for this.
+Commits the diff of two tree\-ish arguments from the command\-line. This command is intended for interoperability with git\-svnimport and does not rely on being inside an git\-svn init\-ed repository. This command takes three arguments, (a) the original tree to diff against, (b) the new tree result, (c) the URL of the target Subversion repository. The final argument (URL) may be omitted if you are working from a git\-svn\-aware repository (that has been init\-ed with git\-svn). The \-r<revision> option is required for this.
.TP
\fIgraft\-branches\fR
This command attempts to detect merges/branches from already imported history. Techniques used currently include regexes, file copies, and tree\-matches). This command generates (or modifies) the $GIT_DIR/info/grafts file. This command is considered experimental, and inherently flawed because merge\-tracking in SVN is inherently flawed and inconsistent across different repositories.
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-TAG" "1" "01/03/2007" "" ""
+.TH "GIT\-TAG" "1" "01/17/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-git\-tag \- Create a tag object signed with GPG
+git\-tag \- Create or verify a tag object signed with GPG
.SH "SYNOPSIS"
.sp
.nf
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-TAR\-TREE" "1" "10/03/2006" "" ""
+.TH "GIT\-TAR\-TREE" "1" "01/17/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
git\-tar\-tree \- Creates a tar archive of the files in the named tree
.SH "SYNOPSIS"
\fIgit\-tar\-tree\fR [\-\-remote=<repo>] <tree\-ish> [ <base> ]
-.sp
.SH "DESCRIPTION"
THIS COMMAND IS DEPRECATED. Use git\-archive with \-\-format=tar option instead.
-.sp
+
Creates a tar archive containing the tree structure for the named tree. When <base> is specified it is added as a leading path to the files in the generated tar archive.
-.sp
+
git\-tar\-tree behaves differently when given a tree ID versus when given a commit ID or tag ID. In the first case the current time is used as modification time of each file in the archive. In the latter case the commit time as recorded in the referenced commit object is used instead. Additionally the commit ID is stored in a global extended pax header. It can be extracted using git\-get\-tar\-commit\-id.
-.sp
.SH "OPTIONS"
.TP
<tree\-ish>
.SH "CONFIGURATION"
By default, file and directories modes are set to 0666 or 0777. It is possible to change this by setting the "umask" variable in the repository configuration as follows :
.sp
-.sp
.nf
umask = 002 ;# group friendly
.fi
-The special umask value "user" indicates that the user's current umask will be used instead. The default value remains 0, which means world readable/writable files and directories.
-.sp
+The special umask value "user" indicates that the user's current umask will be used instead. The default value is 002, which means group readable/writable files and directories.
.SH "EXAMPLES"
.TP
git tar\-tree HEAD junk | (cd /var/tmp/ && tar xf \-)
-Create a tar archive that contains the contents of the latest commit on the current branch, and extracts it in
-/var/tmp/junk
-directory.
+Create a tar archive that contains the contents of the latest commit on the current branch, and extracts it in /var/tmp/junk directory.
.TP
git tar\-tree v1.4.0 git\-1.4.0 | gzip >git\-1.4.0.tar.gz
Create a tarball for v1.4.0 release.
Get a tarball v1.4.0 from example.com.
.TP
git tar\-tree HEAD:Documentation/ git\-docs > git\-1.4.0\-docs.tar
-Put everything in the current head's Documentation/ directory into
-\fIgit\-1.4.0\-docs.tar\fR, with the prefix
-\fIgit\-docs/\fR.
+Put everything in the current head's Documentation/ directory into \fIgit\-1.4.0\-docs.tar\fR, with the prefix \fIgit\-docs/\fR.
.SH "AUTHOR"
Written by Rene Scharfe.
-.sp
.SH "DOCUMENTATION"
Documentation by David Greaves, Junio C Hamano and the git\-list <git@vger.kernel.org>.
-.sp
.SH "GIT"
Part of the \fBgit\fR(7) suite
-.sp
+
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-WHATCHANGED" "1" "10/03/2006" "" ""
+.TH "GIT\-WHATCHANGED" "1" "01/17/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
git\-whatchanged \- Show logs with difference each commit introduces
.SH "SYNOPSIS"
\fIgit\-whatchanged\fR <option>\&...
-.sp
.SH "DESCRIPTION"
Shows commit logs and diff output each commit introduces. The command internally invokes \fIgit\-rev\-list\fR piped to \fIgit\-diff\-tree\fR, and takes command line options for both of these commands.
-.sp
+
This manual page describes only the most frequently used options.
-.sp
.SH "OPTIONS"
.TP
\-p
Show textual diffs, instead of the git internal diff output format that is useful only to tell the changed paths and their nature of changes.
.TP
-\-\-max\-count=<n>
+\-<n>
Limit output to <n> commits.
.TP
<since>..<until>
Show git internal diff output, but for the whole tree, not just the top level.
.TP
\-\-pretty=<format>
-Controls the output format for the commit logs. <format> can be one of
-\fIraw\fR,
-\fImedium\fR,
-\fIshort\fR,
-\fIfull\fR, and
-\fIoneline\fR.
+Controls the output format for the commit logs. <format> can be one of \fIraw\fR, \fImedium\fR, \fIshort\fR, \fIfull\fR, and \fIoneline\fR.
.TP
\-m
By default, differences for merge commits are not shown. With this flag, show differences to that commit from all of its parents.
-.sp
-However, it is not very useful in general, although it
-\fBis\fR
-useful on a file\-by\-file basis.
+
+However, it is not very useful in general, although it \fBis\fR useful on a file\-by\-file basis.
.SH "EXAMPLES"
.TP
git\-whatchanged \-p v2.6.12.. include/scsi drivers/scsi
-Show as patches the commits since version
-\fIv2.6.12\fR
-that changed any file in the include/scsi or drivers/scsi subdirectories
+Show as patches the commits since version \fIv2.6.12\fR that changed any file in the include/scsi or drivers/scsi subdirectories
.TP
git\-whatchanged \-\-since="2 weeks ago" \-\- gitk
-Show the changes during the last two weeks to the file
-\fIgitk\fR. The "\-\-" is necessary to avoid confusion with the
-\fBbranch\fR
-named
-\fIgitk\fR
+Show the changes during the last two weeks to the file \fIgitk\fR. The "\-\-" is necessary to avoid confusion with the \fBbranch\fR named \fIgitk\fR
.SH "AUTHOR"
Written by Linus Torvalds <torvalds@osdl.org> and Junio C Hamano <junkio@cox.net>
-.sp
.SH "DOCUMENTATION"
Documentation by David Greaves, Junio C Hamano and the git\-list <git@vger.kernel.org>.
-.sp
.SH "GIT"
Part of the \fBgit\fR(7) suite
-.sp
+
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT" "7" "01/13/2007" "" ""
+.TH "GIT" "7" "01/17/2007" "" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
Read and modify symbolic refs.
.TP
\fBgit\-tag\fR(1)
-An example script to create a tag object signed with GPG.
+Create or verify a tag object signed with GPG.
.TP
\fBgit\-update\-ref\fR(1)
Update the object name stored in a ref safely.
projects / git.git / commitdiff