From c7e7d4ab527cfc2219ed230c7618aa5a0cb8e099 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Wed, 22 Feb 2006 10:45:07 +0000 Subject: [PATCH] Autogenerated man pages for v1.2.2-g50319 --- man1/git-add.1 | 6 +++- man1/git-ls-files.1 | 20 +++++++++-- man1/git-pack-objects.1 | 20 +++++++++-- man1/git-push.1 | 2 ++ man1/git-rebase.1 | 54 +++++++++++++++++++++++++++-- man1/git-repack.1 | 12 +++++-- man1/git-update-index.1 | 75 ++++++++++++++++++++++++++++++++++++----- 7 files changed, 170 insertions(+), 19 deletions(-) diff --git a/man1/git-add.1 b/man1/git-add.1 index 3c036d719..f02c9f065 100755 --- a/man1/git-add.1 +++ b/man1/git-add.1 @@ -23,7 +23,7 @@ git-add \- Add files to the index file. .SH "SYNOPSIS" -git\-add [\-n] [\-v] ... +\fIgit\-add\fR [\-n] [\-v] [\-\-] ... .SH "DESCRIPTION" @@ -44,6 +44,10 @@ Don't actually add the file(s), just show if they exist\&. \-v Be verbose\&. +.TP +-- +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)\&. + .SH "DISCUSSION" diff --git a/man1/git-ls-files.1 b/man1/git-ls-files.1 index 109e73b1b..88a9fc5ef 100755 --- a/man1/git-ls-files.1 +++ b/man1/git-ls-files.1 @@ -22,8 +22,16 @@ git-ls-files \- Information about files in the index/working directory .SH "SYNOPSIS" - -\fIgit\-ls\-files\fR [\-z] [\-t] (\-\-[cached|deleted|others|ignored|stage|unmerged|killed|modified])* (\-[c|d|o|i|s|u|k|m])* [\-x |\-\-exclude=] [\-X |\-\-exclude\-from=] [\-\-exclude\-per\-directory=] [\-\-full\-name] [\-\-] []* +.nf +\fIgit\-ls\-files\fR [\-z] [\-t] [\-v] + (\-\-[cached|deleted|others|ignored|stage|unmerged|killed|modified])* + (\-[c|d|o|i|s|u|k|m])* + [\-x |\-\-exclude=] + [\-X |\-\-exclude\-from=] + [\-\-exclude\-per\-directory=] + [\-\-error\-unmatch] + [\-\-full\-name] [\-\-] []* +.fi .SH "DESCRIPTION" @@ -87,6 +95,10 @@ exclude patterns are read from ; 1 per line\&. \-\-exclude\-per\-directory= read additional exclude patterns that apply only to the directory and its subdirectories in \&. +.TP +\-\-error\-unmatch +If any does not appear in the index, treat this as an error (return 1)\&. + .TP \-t Identify the file status with the following tags (followed by a space) at the start of each line: @@ -115,6 +127,10 @@ to be killed other +.TP +\-v +Similar to \-t, but use lowercase letters for files that are marked as \fIalways matching index\fR\&. + .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\&. diff --git a/man1/git-pack-objects.1 b/man1/git-pack-objects.1 index 599771c87..e20e8c757 100755 --- a/man1/git-pack-objects.1 +++ b/man1/git-pack-objects.1 @@ -22,8 +22,11 @@ git-pack-objects \- Create a packed archive of objects. .SH "SYNOPSIS" - -git\-pack\-objects [\-\-non\-empty] [\-\-local] [\-\-incremental] [\-\-window=N] [\-\-depth=N] {\-\-stdout | base\-name} < object\-list +.nf +\fIgit\-pack\-objects\fR [\-q] [\-\-no\-reuse\-delta] [\-\-non\-empty] + [\-\-local] [\-\-incremental] [\-\-window=N] [\-\-depth=N] + {\-\-stdout | base\-name} < object\-list +.fi .SH "DESCRIPTION" @@ -34,11 +37,14 @@ Reads list of objects from the standard input, and writes a packed archive with A packed archive is an efficient way to transfer set of objects between two repositories, and also is an archival format which is efficient to access\&. The packed archive format (\&.pack) is designed to be unpackable without having anything else, but for random access, accompanied with the pack index file (\&.idx)\&. -git\-unpack\-objects command can read the packed archive and expand the objects contained in the pack into "one\-file one\-object" format; this is typically done by the smart\-pull commands when a pack is created on\-the\-fly for efficient network transport by their peers\&. +\fIgit\-unpack\-objects\fR command can read the packed archive and expand the objects contained in the pack into "one\-file one\-object" format; this is typically done by the smart\-pull commands when a pack is created on\-the\-fly for efficient network transport by their peers\&. Placing both in the pack/ subdirectory of $GIT_OBJECT_DIRECTORY (or any of the directories on $GIT_ALTERNATE_OBJECT_DIRECTORIES) enables git to read from such an archive\&. + +In a packed archive, an object is either stored as a compressed whole, or as a difference from some other object\&. The latter is often called a delta\&. + .SH "OPTIONS" .TP @@ -65,6 +71,14 @@ This flag is similar to \-\-incremental; instead of ignoring all packed objects, \-\-non\-empty Only create a packed archive if it would contain at least one object\&. +.TP +\-q +This flag makes the command not to report its progress on the standard error stream\&. + +.TP +\-\-no\-reuse\-delta +When creating a packed archive in a repository that has existing packs, the command reuses existing deltas\&. This sometimes results in a slightly suboptimal pack\&. This flag tells the command not to reuse existing deltas but compute them from scratch\&. + .SH "AUTHOR" diff --git a/man1/git-push.1 b/man1/git-push.1 index 140f97363..ddf8db8c6 100755 --- a/man1/git-push.1 +++ b/man1/git-push.1 @@ -47,6 +47,8 @@ The side can be an arbitrary "SHA1 expression" that can be used as an argu The local ref that matches is used to fast forward the remote ref that matches \&. If the optional plus + is used, the remote ref is updated even if it does not result in a fast forward update\&. +Note: If no explicit refspec is found, (that is neither on the command line nor in any Push line of the corresponding remotes file\-\-\-see below), then all the refs that exist both on the local side and on the remote side are updated\&. + Some short\-cut notations are also supported\&. .RS diff --git a/man1/git-rebase.1 b/man1/git-rebase.1 index 88be8f978..642e1c5c5 100755 --- a/man1/git-rebase.1 +++ b/man1/git-rebase.1 @@ -23,15 +23,65 @@ git-rebase \- Rebase local commits to new upstream head. .SH "SYNOPSIS" -git\-rebase [] +\fIgit\-rebase\fR [\-\-onto ] [] .SH "DESCRIPTION" -Rebases local commits to the new head of the upstream tree\&. +git\-rebase applies to (or optionally to ) commits from that do not appear in \&. When is not specified it defaults to the current branch (HEAD)\&. + + +When git\-rebase is complete, will be updated to point to the newly created line of commit objects, so the previous line will not be accessible unless there are other references to it already\&. + + +Assume the following history exists and the current branch is "topic": + +.nf + A\-\-\-B\-\-\-C topic + / +D\-\-\-E\-\-\-F\-\-\-G master +.fi + + +From this point, the result of the following commands: + +.nf +git\-rebase master +git\-rebase master topic +.fi + + +would be: + +.nf + A'\-\-B'\-\-C' topic + / +D\-\-\-E\-\-\-F\-\-\-G master +.fi + + +While, starting from the same point, the result of the following commands: + +.nf +git\-rebase \-\-onto master~1 master +git\-rebase \-\-onto master~1 master topic +.fi + + +would be: + +.nf + A'\-\-B'\-\-C' topic + / +D\-\-\-E\-\-\-F\-\-\-G master +.fi .SH "OPTIONS" +.TP + +Starting point at which to create the new commits\&. If the \-\-onto option is not specified, the starting point is \&. + .TP Upstream branch to compare against\&. diff --git a/man1/git-repack.1 b/man1/git-repack.1 index 615246cc5..80c006e73 100755 --- a/man1/git-repack.1 +++ b/man1/git-repack.1 @@ -23,7 +23,7 @@ git-repack \- Script used to pack a repository from a collection of objects into .SH "SYNOPSIS" -git\-repack [\-a] [\-d] [\-l] [\-n] +\fIgit\-repack\fR [\-a] [\-d] [\-f] [\-l] [\-n] [\-q] .SH "DESCRIPTION" @@ -40,7 +40,7 @@ Packs are used to reduce the load on mirror systems, backup engines, disk storag .TP \-a -Instead of incrementally packing the unpacked objects, pack everything available into a single pack\&. Especially useful when packing a repository that is used for a private development and there no need to worry about people fetching via dumb protocols from it\&. Use with \-d\&. +Instead of incrementally packing the unpacked objects, pack everything available into a single pack\&. Especially useful when packing a repository that is used for a private development and there no need to worry about people fetching via dumb protocols from it\&. Use with \fI\-d\fR\&. .TP \-d @@ -50,6 +50,14 @@ After packing, if the newly created packs make some existing packs redundant, re \-l Pass the \-\-local option to git pack\-objects, see \fBgit\-pack\-objects\fR(1)\&. +.TP +\-f +Pass the \-\-no\-reuse\-delta option to git pack\-objects, see \fBgit\-pack\-objects\fR(1)\&. + +.TP +\-q +Pass the \-q option to git pack\-objects, see \fBgit\-pack\-objects\fR(1)\&. + .TP \-n Do not update the server information with git update\-server\-info\&. diff --git a/man1/git-update-index.1 b/man1/git-update-index.1 index 61096d392..e61a10606 100755 --- a/man1/git-update-index.1 +++ b/man1/git-update-index.1 @@ -22,13 +22,24 @@ git-update-index \- Modifies the index or directory cache .SH "SYNOPSIS" - -git\-update\-index [\-\-add] [\-\-remove | \-\-force\-remove] [\-\-replace] [\-\-refresh [\-q] [\-\-unmerged] [\-\-ignore\-missing]] [\-\-cacheinfo ]* [\-\-chmod=(+|\-)x] [\-\-info\-only] [\-\-index\-info] [\-z] [\-\-stdin] [\-\-verbose] [\-\-] []* +.nf +\fIgit\-update\-index\fR + [\-\-add] [\-\-remove | \-\-force\-remove] [\-\-replace] + [\-\-refresh [\-q] [\-\-unmerged] [\-\-ignore\-missing]] + [\-\-cacheinfo ]* + [\-\-chmod=(+|\-)x] + [\-\-assume\-unchanged | \-\-no\-assume\-unchanged] + [\-\-really\-refresh] + [\-\-info\-only] [\-\-index\-info] + [\-z] [\-\-stdin] + [\-\-verbose] + [\-\-] []* +.fi .SH "DESCRIPTION" -Modifies the index or directory cache\&. Each file mentioned is updated into the index and any unmerged or needs updating state is cleared\&. +Modifies the index or directory cache\&. Each file mentioned is updated into the index and any \fIunmerged\fR or \fIneeds updating\fR state is cleared\&. The way "git\-update\-index" handles files it is told about can be modified using the various options: @@ -71,6 +82,10 @@ Read index information from stdin\&. \-\-chmod=(+|\-)x Set the execute permissions on the updated files\&. +.TP +\-\-assume\-unchanged, \-\-no\-assume\-unchanged +When these flags are specified, the object name recorded for the paths are not updated\&. Instead, these options sets and unsets the "assume unchanged" bit for the paths\&. When the "assume unchanged" bit is on, git stops checking the working tree files for possible modifications, so you need to manually unset the bit to tell git when you change the working tree file\&. This is sometimes helpful when working with a big project on a filesystem that has very slow lstat(2) system call (e\&.g\&. cifs)\&. + .TP \-\-info\-only Do not create objects in the object database for all arguments that follow this flag; just insert their object IDs into the index\&. @@ -101,12 +116,12 @@ Do not interpret any more arguments as options\&. .TP -Files to act on\&. Note that files beginning with \&. are discarded\&. This includes \&./file and dir/\&./file\&. If you don't want this, then use cleaner names\&. The same applies to directories ending / and paths with // +Files to act on\&. Note that files beginning with \fI\&.\fR are discarded\&. This includes \&./file and dir/\&./file\&. If you don't want this, then use cleaner names\&. The same applies to directories ending \fI/\fR and paths with \fI//\fR .SH "USING --REFRESH" -\-\-refresh does not calculate a new sha1 file or bring the index up\-to\-date for mode/content changes\&. But what it does do is to "re\-match" the stat information of a file with the index, so that you can refresh the index for a file that hasn't been changed but where the stat entry is out of date\&. +\fI\-\-refresh\fR does not calculate a new sha1 file or bring the index up\-to\-date for mode/content changes\&. But what it \fIdoes\fR do is to "re\-match" the stat information of a file with the index, so that you can refresh the index for a file that hasn't been changed but where the stat entry is out of date\&. For example, you'd want to do this after doing a "git\-read\-tree", to link up the stat index details with the proper files\&. @@ -114,7 +129,7 @@ For example, you'd want to do this after doing a "git\-read\-tree", to link up t .SH "USING --CACHEINFO OR --INFO-ONLY" -\-\-cacheinfo is used to register a file that is not in the current working directory\&. This is useful for minimum\-checkout merging\&. +\fI\-\-cacheinfo\fR is used to register a file that is not in the current working directory\&. This is useful for minimum\-checkout merging\&. To pretend you have a file with mode and sha1 at path, say: @@ -122,10 +137,10 @@ To pretend you have a file with mode and sha1 at path, say: .IP $ git\-update\-index \-\-cacheinfo mode sha1 path -\-\-info\-only is used to register files without placing them in the object database\&. This is useful for status\-only repositories\&. +\fI\-\-info\-only\fR is used to register files without placing them in the object database\&. This is useful for status\-only repositories\&. -Both \-\-cacheinfo and \-\-info\-only behave similarly: the index is updated but the object database isn't\&. \-\-cacheinfo is useful when the object is in the database but the file isn't available locally\&. \-\-info\-only is useful when the file is available, but you do not wish to update the object database\&. +Both \fI\-\-cacheinfo\fR and \fI\-\-info\-only\fR behave similarly: the index is updated but the object database isn't\&. \fI\-\-cacheinfo\fR is useful when the object is in the database but the file isn't available locally\&. \fI\-\-info\-only\fR is useful when the file is available, but you do not wish to update the object database\&. .SH "USING --INDEX-INFO" @@ -173,6 +188,17 @@ The first line of the input feeds 0 as the mode to remove the path; the SHA1 doe $ git ls\-files \-s 100644 8a1218a1024a212bb3db30becd860315f9f3ac52 1 frotz 100755 8a1218a1024a212bb3db30becd860315f9f3ac52 2 frotz +.SH "USING "ASSUME UNCHANGED" BIT" + + +Many operations in git depend on your filesystem to have an efficient lstat(2) implementation, so that st_mtime information for working tree files can be cheaply checked to see if the file contents have changed from the version recorded in the index file\&. Unfortunately, some filesystems have inefficient lstat(2)\&. If your filesystem is one of them, you can set "assume unchanged" bit to paths you have not changed to cause git not to do this check\&. Note that setting this bit on a path does not mean git will check the contents of the file to see if it has changed -- it makes git to omit any checking and assume it has \fInot\fR changed\&. When you make changes to working tree files, you have to explicitly tell git about it by dropping "assume unchanged" bit, either before or after you modify them\&. + + +In order to set "assume unchanged" bit, use \-\-assume\-unchanged option\&. To unset, use \-\-no\-assume\-unchanged\&. + + +The command looks at core\&.ignorestat configuration variable\&. When this is true, paths updated with git\-update\-index paths... and paths updated with other git commands that update both index and working tree (e\&.g\&. git\-apply \-\-index, git\-checkout\-index \-u, and git\-read\-tree \-u) are automatically marked as "assume unchanged"\&. Note that "assume unchanged" bit is \fInot\fR set if git\-update\-index \-\-refresh finds the working tree file matches the index (use git\-update\-index \-\-really\-refresh if you want to mark them as "assume unchanged")\&. + .SH "EXAMPLES" @@ -180,10 +206,41 @@ To update and refresh only the files already checked out: .IP $ git\-checkout\-index \-n \-f \-a && git\-update\-index \-\-ignore\-missing \-\-refresh + +On an inefficient filesystem with core\&.ignorestat set: + +.IP +$ git update\-index \-\-really\-refresh +$ git update\-index \-\-no\-assume\-unchanged foo\&.c +$ git diff \-\-name\-only +$ edit foo\&.c +$ git diff \-\-name\-only +M foo\&.c +$ git update\-index foo\&.c +$ git diff \-\-name\-only +$ edit foo\&.c +$ git diff \-\-name\-only +$ git update\-index \-\-no\-assume\-unchanged foo\&.c +$ git diff \-\-name\-only +M foo\&.c + + forces lstat(2) to set "assume unchanged" bits for paths + that match index\&. + mark the path to be edited\&. + this does lstat(2) and finds index matches the path\&. + this does lstat(2) and finds index does not match the path\&. + registering the new version to index sets "assume unchanged" bit\&. + and it is assumed unchanged\&. +(16) even after you edit it\&. +(17) you can tell about the change after the fact\&. +(18) now it checks with lstat(2) and finds it has been changed\&. .SH "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 \fBgit\-repo\-config\fR(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=\&. +The command honors core\&.filemode configuration variable\&. If your repository is on an filesystem whose executable bits are unreliable, this should be set to \fIfalse\fR (see \fBgit\-repo\-config\fR(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=\&. + + +The command looks at core\&.ignorestat configuration variable\&. See \fIUsing "assume unchanged" bit\fR section above\&. .SH "SEE ALSO" -- 2.26.2