Attachment 185291 Details for Bug 275241 – git-add.xml file created by asciidoc

git-add.xml file created by asciidoc

git-add.xml (text/xml), 11.70 KB, created by Horst H. von Brand on 2007-09-03 14:57:25 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Horst H. von Brand

Created: 2007-09-03 14:57:25 UTC

Size: 11.70 KB

patch

obsolete

><?xml version="1.0" encoding="UTF-8"?>
><!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
><refentry>
><refmeta>
><refentrytitle>git-add</refentrytitle>
><manvolnum>1</manvolnum>
><refmiscinfo class="source">Git</refmiscinfo>
><refmiscinfo class="version">1.5.3</refmiscinfo>
><refmiscinfo class="manual">Git Manual</refmiscinfo>
></refmeta>
><refnamediv>
>  <refname>git-add</refname>
>  <refpurpose>Add file contents to the index</refpurpose>
></refnamediv>
><refsynopsisdiv>
><literallayout><emphasis>git-add</emphasis> [-n] [-v] [-f] [--interactive | -i] [-u] [--refresh]
>          [--] &lt;filepattern&gt;&#8230;</literallayout>
></refsynopsisdiv>
><refsect1>
><title>DESCRIPTION</title>
><simpara>This command adds the current content of new or modified files to the
>index, thus staging that content for inclusion in the next commit.</simpara>
>
><simpara>The "index" holds a snapshot of the content of the working tree, and it
>is this snapshot that is taken as the contents of the next commit.  Thus
>after making any changes to the working directory, and before running
>the commit command, you must use the <emphasis>add</emphasis> command to add any new or
>modified files to the index.</simpara>
>
><simpara>This command can be performed multiple times before a commit.  It only
>adds the content of the specified file(s) at the time the add command is
>run; if you want subsequent changes included in the next commit, then
>you must run <emphasis>git add</emphasis> again to add the new content to the index.</simpara>
>
><simpara>The <emphasis>git status</emphasis> command can be used to obtain a summary of which
>files have changes that are staged for the next commit.</simpara>
>
><simpara>The <emphasis>git add</emphasis> command will not add ignored files by default.  If any
>ignored files were explicitly specified on the command line, <emphasis>git add</emphasis>
>will fail with a list of ignored files.  Ignored files reached by
>directory recursion or filename globbing performed by Git (quote your
>globs before the shell) will be silently ignored.  The <emphasis>add</emphasis> command can
>be used to add ignored files with the <literal>-f</literal> (force) option.</simpara>
>
><simpara>Please see <citerefentry>
><refentrytitle>git-commit</refentrytitle><manvolnum>1</manvolnum>
></citerefentry> for alternative ways to add content to a
>commit.</simpara>
>
></refsect1>
><refsect1>
><title>OPTIONS</title>
><variablelist>
><varlistentry>
><term>
>&lt;filepattern&gt;&#8230;
></term>
><listitem>
><simpara>
>        Files to add content from.  Fileglobs (e.g. <literal>*.c</literal>) can
>        be given to add all matching files.  Also a
>        leading directory name (e.g. <literal>dir</literal> to add <literal>dir/file1</literal>
>        and <literal>dir/file2</literal>) can be given to add all files in the
>        directory, recursively.
></simpara>
></listitem>
></varlistentry>
><varlistentry>
><term>
>-n
></term>
><listitem>
><simpara>
>        Don't actually add the file(s), just show if they exist.
></simpara>
></listitem>
></varlistentry>
><varlistentry>
><term>
>-v
></term>
><listitem>
><simpara>
>        Be verbose.
></simpara>
></listitem>
></varlistentry>
><varlistentry>
><term>
>-f
></term>
><listitem>
><simpara>
>        Allow adding otherwise ignored files.
></simpara>
></listitem>
></varlistentry>
><varlistentry>
><term>
>-i, --interactive
></term>
><listitem>
><simpara>
>        Add modified contents in the working tree interactively to
>        the index.
></simpara>
></listitem>
></varlistentry>
><varlistentry>
><term>
>-u
></term>
><listitem>
><simpara>
>        Update only files that git already knows about. This is similar
>        to what "git commit -a" does in preparation for making a commit,
>        except that the update is limited to paths specified on the
>        command line. If no paths are specified, all tracked files are
>        updated.
></simpara>
></listitem>
></varlistentry>
><varlistentry>
><term>
>--refresh
></term>
><listitem>
><simpara>
>        Don't add the file(s), but only refresh their stat()
>        information in the index.
></simpara>
></listitem>
></varlistentry>
><varlistentry>
><term>
>--
></term>
><listitem>
><simpara>
>        This option can be used to separate command-line options from
>        the list of files, (useful when filenames might be mistaken
>        for command-line options).
></simpara>
></listitem>
></varlistentry>
></variablelist>
></refsect1>
><refsect1>
><title>Configuration</title>
><simpara>The optional configuration variable <emphasis>core.excludesfile</emphasis> indicates a path to a
>file containing patterns of file names to exclude from git-add, similar to
>$GIT_DIR/info/exclude.  Patterns in the exclude file are used in addition to
>those in info/exclude.  See <ulink url="repository-layout.html">repository layout</ulink>.</simpara>
>
></refsect1>
><refsect1>
><title>EXAMPLES</title>
><variablelist>
><varlistentry>
><term>
>git-add Documentation/\*.txt
></term>
><listitem>
><simpara>
>        Adds content from all <literal>*.txt</literal> files under <literal>Documentation</literal>
>        directory and its subdirectories.
></simpara>
><simpara>Note that the asterisk <literal>*</literal> is quoted from the shell in this
>example; this lets the command to include the files from
>subdirectories of <literal>Documentation/</literal> directory.</simpara>
>
></listitem>
></varlistentry>
><varlistentry>
><term>
>git-add git-*.sh
></term>
><listitem>
><simpara>
>        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 <literal>subdir/git-foo.sh</literal>.
></simpara>
></listitem>
></varlistentry>
></variablelist>
></refsect1>
><refsect1>
><title>Interactive mode</title>
><simpara>When the command enters the interactive mode, it shows the
>output of the <emphasis>status</emphasis> subcommand, and then goes into its
>interactive command loop.</simpara>
>
><simpara>The command loop shows the list of subcommands available, and
>gives a prompt "What now&gt; ".  In general, when the prompt ends
>with a single <emphasis>&gt;</emphasis>, you can pick only one of the choices given
>and type return, like this:</simpara>
>
><literallayout>
>&#10;.ft C&#10;    *** Commands ***
>      1: status       2: update       3: revert       4: add untracked
>      5: patch        6: diff         7: quit         8: help
>    What now&gt; 1&#10;.ft&#10;
></literallayout>
><simpara>You also could say "s" or "sta" or "status" above as long as the
>choice is unique.</simpara>
>
><simpara>The main command loop has 6 subcommands (plus help and quit).</simpara>
>
><variablelist>
><varlistentry>
><term>
>status
></term>
><listitem>
><simpara>
>   This shows the change between HEAD and index (i.e. what will be
>   committed if you say "git commit"), and between index and
>   working tree files (i.e. what you could stage further before
>   "git commit" using "git-add") for each path.  A sample output
>   looks like this:
></simpara>
><literallayout>
>&#10;.ft C&#10;              staged     unstaged path
>     1:       binary      nothing foo.png
>     2:     +403/-35        +1/-1 git-add--interactive.perl&#10;.ft&#10;
></literallayout>
><simpara>It shows that foo.png has differences from HEAD (but that is
>binary so line count cannot be shown) and there is no
>difference between indexed copy and the working tree
>version (if the working tree version were also different,
><emphasis>binary</emphasis> would have been shown in place of <emphasis>nothing</emphasis>).  The
>other file, git-add--interactive.perl, has 403 lines added
>and 35 lines deleted if you commit what is in the index, but
>working tree file has further modifications (one addition and
>one deletion).</simpara>
>
></listitem>
></varlistentry>
><varlistentry>
><term>
>update
></term>
><listitem>
><simpara>
>   This shows the status information and gives prompt
>   "Update&gt;&gt;".  When the prompt ends with double <emphasis>&gt;&gt;</emphasis>, you can
>   make more than one selection, concatenated with whitespace or
>   comma.  Also you can say ranges.  E.g. "2-5 7,9" to choose
>   2,3,4,5,7,9 from the list.  You can say <emphasis>*</emphasis> to choose
>   everything.
></simpara>
><simpara>What you chose are then highlighted with <emphasis>*</emphasis>,
>like this:</simpara>
>
><literallayout>
>&#10;.ft C&#10;           staged     unstaged path
>  1:       binary      nothing foo.png
>* 2:     +403/-35        +1/-1 git-add--interactive.perl&#10;.ft&#10;
></literallayout>
><simpara>To remove selection, prefix the input with <literal>-</literal>
>like this:</simpara>
>
><literallayout>
>&#10;.ft C&#10;Update&gt;&gt; -2&#10;.ft&#10;
></literallayout>
><simpara>After making the selection, answer with an empty line to stage the
>contents of working tree files for selected paths in the index.</simpara>
>
></listitem>
></varlistentry>
><varlistentry>
><term>
>revert
></term>
><listitem>
><simpara>
>  This has a very similar UI to <emphasis>update</emphasis>, and the staged
>  information for selected paths are reverted to that of the
>  HEAD version.  Reverting new paths makes them untracked.
></simpara>
></listitem>
></varlistentry>
><varlistentry>
><term>
>add untracked
></term>
><listitem>
><simpara>
>  This has a very similar UI to <emphasis>update</emphasis> and
>  <emphasis>revert</emphasis>, and lets you add untracked paths to the index.
></simpara>
></listitem>
></varlistentry>
><varlistentry>
><term>
>patch
></term>
><listitem>
><simpara>
>  This lets you choose one path out of <emphasis>status</emphasis> like selection.
>  After choosing the path, it presents diff between the index
>  and the working tree file and asks you if you want to stage
>  the change of each hunk.  You can say:
></simpara>
><literallayout class="monospaced">y - add the change from that hunk to index
>n - do not add the change from that hunk to index
>a - add the change from that hunk and all the rest to index
>d - do not the change from that hunk nor any of the rest to index
>j - do not decide on this hunk now, and view the next
>    undecided hunk
>J - do not decide on this hunk now, and view the next hunk
>k - do not decide on this hunk now, and view the previous
>    undecided hunk
>K - do not decide on this hunk now, and view the previous hunk</literallayout>
><simpara>After deciding the fate for all hunks, if there is any hunk
>that was chosen, the index is updated with the selected hunks.</simpara>
>
></listitem>
></varlistentry>
><varlistentry>
><term>
>diff
></term>
><listitem>
><simpara>
>  This lets you review what will be committed (i.e. between
>  HEAD and index).
></simpara>
></listitem>
></varlistentry>
></variablelist>
></refsect1>
><refsect1>
><title>See Also</title>
><simpara><citerefentry>
><refentrytitle>git-status</refentrytitle><manvolnum>1</manvolnum>
></citerefentry>
><citerefentry>
><refentrytitle>git-rm</refentrytitle><manvolnum>1</manvolnum>
></citerefentry>
><citerefentry>
><refentrytitle>git-mv</refentrytitle><manvolnum>1</manvolnum>
></citerefentry>
><citerefentry>
><refentrytitle>git-commit</refentrytitle><manvolnum>1</manvolnum>
></citerefentry>
><citerefentry>
><refentrytitle>git-update-index</refentrytitle><manvolnum>1</manvolnum>
></citerefentry></simpara>
>
></refsect1>
><refsect1>
><title>Author</title>
><simpara>Written by Linus Torvalds &lt;torvalds@osdl.org&gt;</simpara>
>
></refsect1>
><refsect1>
><title>Documentation</title>
><simpara>Documentation by Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</simpara>
>
></refsect1>
><refsect1>
><title>GIT</title>
><simpara>Part of the <citerefentry>
><refentrytitle>git</refentrytitle><manvolnum>7</manvolnum>
></citerefentry> suite</simpara>
>
></refsect1>
></refentry>

Actions: View

Attachments on bug 275241: 185281 | 185291 | 185371