mirrors/git
1
0
Fork 0
mirror of https://github.com/git/git.git synced 2024-11-06 09:13:01 +01:00
Code Activity
git/Documentation/git-add.txt

90 lines
2.2 KiB
Text
Raw Normal View History

Big tool rename. As promised, this is the "big tool rename" patch. The primary differences since 0.99.6 are: (1) git-*-script are no more. The commands installed do not have any such suffix so users do not have to remember if something is implemented as a shell script or not. (2) Many command names with 'cache' in them are renamed with 'index' if that is what they mean. There are backward compatibility symblic links so that you and Porcelains can keep using the old names, but the backward compatibility support is expected to be removed in the near future. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-08 02:26:23 +02:00
git-add(1)
==========
Add placeholders for missing documents. The text does not say anything interesting, but at least the author list should reflect something close to reality. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-08-23 10:49:47 +02:00
NAME
----
make 'git add' a first class user friendly interface to the index This brings the power of the index up front using a proper mental model without talking about the index at all. See for example how all the technical discussion has been evacuated from the git-add man page. Any content to be committed must be added together. Whether that content comes from new files or modified files doesn't matter. You just need to "add" it, either with git-add, or by providing git-commit with -a (for already known files only of course). No need for a separate command to distinguish new vs modified files please. That would only screw the mental model everybody should have when using GIT. Signed-off-by: Nicolas Pitre <nico@cam.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-12-04 17:13:39 +01:00
git-add - Add file contents to the changeset to be committed next
Add placeholders for missing documents. The text does not say anything interesting, but at least the author list should reflect something close to reality. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-08-23 10:49:47 +02:00
SYNOPSIS
--------
git-add: Add support for --, documentation, and test. This adds support to git-add to allow the common -- to separate command-line options and file names. It adds documentation and a new git-add test case as well. [jc: this should apply to 1.2.X maintenance series, so I reworked git-ls-files --error-unmatch test. ] Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-02-22 00:33:49 +01:00
'git-add' [-n] [-v] [--] <file>...
Add placeholders for missing documents. The text does not say anything interesting, but at least the author list should reflect something close to reality. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-08-23 10:49:47 +02:00
DESCRIPTION
-----------
make 'git add' a first class user friendly interface to the index This brings the power of the index up front using a proper mental model without talking about the index at all. See for example how all the technical discussion has been evacuated from the git-add man page. Any content to be committed must be added together. Whether that content comes from new files or modified files doesn't matter. You just need to "add" it, either with git-add, or by providing git-commit with -a (for already known files only of course). No need for a separate command to distinguish new vs modified files please. That would only screw the mental model everybody should have when using GIT. Signed-off-by: Nicolas Pitre <nico@cam.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-12-04 17:13:39 +01:00
All the changed file contents to be committed together in a single set
of changes must be "added" with the 'add' command before using the
'commit' command. This is not only for adding new files. Even modified
files must be added to the set of changes about to be committed.
Documentation: git-add -- do not say "cache", add examples. Its use of git-ls-files --others is very nice, but sometimes gives surprising results, so we'd better talk about it. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-11-04 09:04:17 +01:00
make 'git add' a first class user friendly interface to the index This brings the power of the index up front using a proper mental model without talking about the index at all. See for example how all the technical discussion has been evacuated from the git-add man page. Any content to be committed must be added together. Whether that content comes from new files or modified files doesn't matter. You just need to "add" it, either with git-add, or by providing git-commit with -a (for already known files only of course). No need for a separate command to distinguish new vs modified files please. That would only screw the mental model everybody should have when using GIT. Signed-off-by: Nicolas Pitre <nico@cam.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-12-04 17:13:39 +01:00
This command can be performed multiple times before a commit. The added
content corresponds to the state of specified file(s) at the time the
'add' command is used. This means the 'commit' command will not consider
subsequent changes to already added content if it is not added again before
the commit.
The 'git status' command can be used to obtain a summary of what is included
for the next commit.
This command only adds non-ignored files, to add ignored files use
Document that "git add" only adds non-ignored files. Signed-off-by: Santi Béjar <sbejar@gmail.com> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-05-19 23:02:34 +02:00
"git update-index --add".
Add placeholders for missing documents. The text does not say anything interesting, but at least the author list should reflect something close to reality. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-08-23 10:49:47 +02:00
make 'git add' a first class user friendly interface to the index This brings the power of the index up front using a proper mental model without talking about the index at all. See for example how all the technical discussion has been evacuated from the git-add man page. Any content to be committed must be added together. Whether that content comes from new files or modified files doesn't matter. You just need to "add" it, either with git-add, or by providing git-commit with -a (for already known files only of course). No need for a separate command to distinguish new vs modified files please. That would only screw the mental model everybody should have when using GIT. Signed-off-by: Nicolas Pitre <nico@cam.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-12-04 17:13:39 +01:00
Please see gitlink:git-commit[1] for alternative ways to add content to a
commit.
Add placeholders for missing documents. The text does not say anything interesting, but at least the author list should reflect something close to reality. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-08-23 10:49:47 +02:00
OPTIONS
-------
Update the main documentation index. Gitzilla updated bunch of undocumented command pages, so move the entries in the main documentation index around to put them in proper category. Ordering within category will be fixed later. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-08-27 06:33:46 +02:00
<file>...::
make 'git add' a first class user friendly interface to the index This brings the power of the index up front using a proper mental model without talking about the index at all. See for example how all the technical discussion has been evacuated from the git-add man page. Any content to be committed must be added together. Whether that content comes from new files or modified files doesn't matter. You just need to "add" it, either with git-add, or by providing git-commit with -a (for already known files only of course). No need for a separate command to distinguish new vs modified files please. That would only screw the mental model everybody should have when using GIT. Signed-off-by: Nicolas Pitre <nico@cam.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-12-04 17:13:39 +01:00
Files to add content from.
Add placeholders for missing documents. The text does not say anything interesting, but at least the author list should reflect something close to reality. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-08-23 10:49:47 +02:00
Add to usage and docs for git-add.sh Signed-off-by: Chris Shoemaker <c.shoemaker@cox.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-29 23:46:41 +02:00
-n::
Don't actually add the file(s), just show if they exist.
-v::
Be verbose.
Fix up docs where "--" isn't displayed correctly. A bare "--" doesn't show up in man or html pages correctly as two individual dashes unless backslashed as \-- in the asciidoc source. Note, no backslash is needed inside a literal block. Signed-off-by: Sean Estabrooks <seanlkml@sympatico.ca> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-05-05 21:05:24 +02:00
\--::
git-add: Add support for --, documentation, and test. This adds support to git-add to allow the common -- to separate command-line options and file names. It adds documentation and a new git-add test case as well. [jc: this should apply to 1.2.X maintenance series, so I reworked git-ls-files --error-unmatch test. ] Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-02-22 00:33:49 +01:00
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).
Add to usage and docs for git-add.sh Signed-off-by: Chris Shoemaker <c.shoemaker@cox.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-10-29 23:46:41 +02:00
Documentation: git-add -- do not say "cache", add examples. Its use of git-ls-files --others is very nice, but sometimes gives surprising results, so we'd better talk about it. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-11-04 09:04:17 +01:00
EXAMPLES
--------
git-add Documentation/\\*.txt::
make 'git add' a first class user friendly interface to the index This brings the power of the index up front using a proper mental model without talking about the index at all. See for example how all the technical discussion has been evacuated from the git-add man page. Any content to be committed must be added together. Whether that content comes from new files or modified files doesn't matter. You just need to "add" it, either with git-add, or by providing git-commit with -a (for already known files only of course). No need for a separate command to distinguish new vs modified files please. That would only screw the mental model everybody should have when using GIT. Signed-off-by: Nicolas Pitre <nico@cam.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-12-04 17:13:39 +01:00
Adds content from all `\*.txt` files under `Documentation`
directory and its subdirectories.
Documentation: git-add -- do not say "cache", add examples. Its use of git-ls-files --others is very nice, but sometimes gives surprising results, so we'd better talk about it. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-11-04 09:04:17 +01:00
+
Note that the asterisk `\*` is quoted from the shell in this
example; this lets the command to include the files from
subdirectories of `Documentation/` directory.
git-add git-*.sh::
make 'git add' a first class user friendly interface to the index This brings the power of the index up front using a proper mental model without talking about the index at all. See for example how all the technical discussion has been evacuated from the git-add man page. Any content to be committed must be added together. Whether that content comes from new files or modified files doesn't matter. You just need to "add" it, either with git-add, or by providing git-commit with -a (for already known files only of course). No need for a separate command to distinguish new vs modified files please. That would only screw the mental model everybody should have when using GIT. Signed-off-by: Nicolas Pitre <nico@cam.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-12-04 17:13:39 +01:00
Considers adding content from all git-*.sh scripts.
Documentation: git-add -- do not say "cache", add examples. Its use of git-ls-files --others is very nice, but sometimes gives surprising results, so we'd better talk about it. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-11-04 09:04:17 +01:00
Because this example lets shell expand the asterisk
(i.e. you are listing the files explicitly), it does not
make 'git add' a first class user friendly interface to the index This brings the power of the index up front using a proper mental model without talking about the index at all. See for example how all the technical discussion has been evacuated from the git-add man page. Any content to be committed must be added together. Whether that content comes from new files or modified files doesn't matter. You just need to "add" it, either with git-add, or by providing git-commit with -a (for already known files only of course). No need for a separate command to distinguish new vs modified files please. That would only screw the mental model everybody should have when using GIT. Signed-off-by: Nicolas Pitre <nico@cam.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-12-04 17:13:39 +01:00
consider `subdir/git-foo.sh`.
Documentation: git-add -- do not say "cache", add examples. Its use of git-ls-files --others is very nice, but sometimes gives surprising results, so we'd better talk about it. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-11-04 09:04:17 +01:00
documentation: add 'see also' sections to git-rm and git-add Pair up git-add and git-rm by adding a 'see also' section that references the opposite command to each of their documentation files. Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-03-05 22:18:19 +01:00
See Also
--------
make 'git add' a first class user friendly interface to the index This brings the power of the index up front using a proper mental model without talking about the index at all. See for example how all the technical discussion has been evacuated from the git-add man page. Any content to be committed must be added together. Whether that content comes from new files or modified files doesn't matter. You just need to "add" it, either with git-add, or by providing git-commit with -a (for already known files only of course). No need for a separate command to distinguish new vs modified files please. That would only screw the mental model everybody should have when using GIT. Signed-off-by: Nicolas Pitre <nico@cam.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-12-04 17:13:39 +01:00
gitlink:git-status[1]
documentation: add 'see also' sections to git-rm and git-add Pair up git-add and git-rm by adding a 'see also' section that references the opposite command to each of their documentation files. Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-03-05 22:18:19 +01:00
gitlink:git-rm[1]
make 'git add' a first class user friendly interface to the index This brings the power of the index up front using a proper mental model without talking about the index at all. See for example how all the technical discussion has been evacuated from the git-add man page. Any content to be committed must be added together. Whether that content comes from new files or modified files doesn't matter. You just need to "add" it, either with git-add, or by providing git-commit with -a (for already known files only of course). No need for a separate command to distinguish new vs modified files please. That would only screw the mental model everybody should have when using GIT. Signed-off-by: Nicolas Pitre <nico@cam.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
2006-12-04 17:13:39 +01:00
gitlink:git-mv[1]
gitlink:git-commit[1]
gitlink:git-update-index[1]
Documentation: git-add -- do not say "cache", add examples. Its use of git-ls-files --others is very nice, but sometimes gives surprising results, so we'd better talk about it. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-11-04 09:04:17 +01:00
Add placeholders for missing documents. The text does not say anything interesting, but at least the author list should reflect something close to reality. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-08-23 10:49:47 +02:00
Author
------
Written by Linus Torvalds <torvalds@osdl.org>
Documentation
--------------
Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
GIT
---
[PATCH] Documentation: Update all files to use the new gitlink: macro The replacement was performed automatically by these commands: perl -pi -e 's/link:(git.+)\.html\[\1\]/gitlink:$1\[1\]/g' \ README Documentation/*.txt perl -pi -e 's/link:git\.html\[git\]/gitlink:git\[7\]/g' \ README Documentation/*.txt Signed-off-by: Sergey Vlasov <vsu@altlinux.ru> Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-09-19 12:10:51 +02:00
Part of the gitlink:git[7] suite
Add placeholders for missing documents. The text does not say anything interesting, but at least the author list should reflect something close to reality. Signed-off-by: Junio C Hamano <junkio@cox.net>
2005-08-23 10:49:47 +02:00
Copy permalink