diff options
Diffstat (limited to 'Documentation')
49 files changed, 597 insertions, 161 deletions
diff --git a/Documentation/Makefile b/Documentation/Makefile index 2a08f59..2b0efe7 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -52,9 +52,9 @@ man1: $(DOC_MAN1) man7: $(DOC_MAN7) install: man - $(INSTALL) -d -m755 $(DESTDIR)/$(man1) $(DESTDIR)/$(man7) - $(INSTALL) $(DOC_MAN1) $(DESTDIR)/$(man1) - $(INSTALL) $(DOC_MAN7) $(DESTDIR)/$(man7) + $(INSTALL) -d -m755 $(DESTDIR)$(man1) $(DESTDIR)$(man7) + $(INSTALL) $(DOC_MAN1) $(DESTDIR)$(man1) + $(INSTALL) $(DOC_MAN7) $(DESTDIR)$(man7) # diff --git a/Documentation/config.txt b/Documentation/config.txt index d1a4bec..a04c5ad 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -2,15 +2,15 @@ CONFIGURATION FILE ------------------ The git configuration file contains a number of variables that affect -the git commands behaviour. They can be used by both the git plumbing -and the porcelains. The variables are divided to sections, where +the git command's behavior. They can be used by both the git plumbing +and the porcelains. The variables are divided into sections, where in the fully qualified variable name the variable itself is the last dot-separated segment and the section name is everything before the last dot. The variable names are case-insensitive and only alphanumeric characters are allowed. Some variables may appear multiple times. The syntax is fairly flexible and permissive; whitespaces are mostly -ignored. The '#' and ';' characters begin commends to the end of line, +ignored. The '#' and ';' characters begin comments to the end of line, blank lines are ignored, lines containing strings enclosed in square brackets start sections and all the other lines are recognized as setting variables, in the form 'name = value'. If there is no equal @@ -35,8 +35,8 @@ Variables ~~~~~~~~~ Note that this list is non-comprehensive and not necessarily complete. -For command-specific variables, you will find more detailed description -in the appropriate manual page. You will find description of non-core +For command-specific variables, you will find a more detailed description +in the appropriate manual page. You will find a description of non-core porcelain configuration variables in the respective porcelain documentation. core.fileMode:: @@ -52,10 +52,10 @@ core.gitProxy:: on hostnames ending with the specified domain string. This variable may be set multiple times and is matched in the given order; the first match wins. - - Can be overriden by the 'GIT_PROXY_COMMAND' environment variable - (which always applies universally, without the special "for" - handling). ++ +Can be overridden by the 'GIT_PROXY_COMMAND' environment variable +(which always applies universally, without the special "for" +handling). core.ignoreStat:: The working copy files are assumed to stay unchanged until you @@ -70,6 +70,14 @@ core.preferSymlinkRefs:: This is sometimes needed to work with old scripts that expect HEAD to be a symbolic link. +core.logAllRefUpdates:: + If true, `git-update-ref` will append a line to + "$GIT_DIR/logs/<ref>" listing the new SHA1 and the date/time + of the update. If the file does not exist it will be + created automatically. This information can be used to + determine what commit was the tip of a branch "2 days ago". + This value is false by default (no logging). + core.repositoryFormatVersion:: Internal variable identifying the repository format and layout version. @@ -83,6 +91,15 @@ core.warnAmbiguousRefs:: If true, git will warn you if the ref name you passed it is ambiguous and might match multiple refs in the .git/refs/ tree. True by default. +alias.*:: + Command aliases for the gitlink:git[1] command wrapper - e.g. + after defining "alias.last = cat-file commit HEAD", the invocation + "git last" is equivalent to "git cat-file commit HEAD". To avoid + confusion and troubles with script usage, aliases that + hide existing git commands are ignored. Arguments are split by + spaces, the usual shell quoting and escaping is supported. + quote pair and a backslash can be used to quote them. + apply.whitespace:: Tells `git-apply` how to handle whitespaces, in the same way as the '--whitespace' option. See gitlink:git-apply[1]. @@ -105,37 +122,37 @@ gitcvs.logfile:: http.sslVerify:: Whether to verify the SSL certificate when fetching or pushing - over HTTPS. Can be overriden by the 'GIT_SSL_NO_VERIFY' environment + over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment variable. http.sslCert:: File containing the SSL certificate when fetching or pushing - over HTTPS. Can be overriden by the 'GIT_SSL_CERT' environment + over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment variable. http.sslKey:: File containing the SSL private key when fetching or pushing - over HTTPS. Can be overriden by the 'GIT_SSL_KEY' environment + over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment variable. http.sslCAInfo:: File containing the certificates to verify the peer with when - fetching or pushing over HTTPS. Can be overriden by the + fetching or pushing over HTTPS. Can be overridden by the 'GIT_SSL_CAINFO' environment variable. http.sslCAPath:: Path containing files with the CA certificates to verify the peer - with when fetching or pushing over HTTPS. Can be overriden + with when fetching or pushing over HTTPS. Can be overridden by the 'GIT_SSL_CAPATH' environment variable. http.maxRequests:: - How many HTTP requests to launch in parallel. Can be overriden + How many HTTP requests to launch in parallel. Can be overridden by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5. http.lowSpeedLimit, http.lowSpeedTime:: If the HTTP transfer speed is less than 'http.lowSpeedLimit' for longer than 'http.lowSpeedTime' seconds, the transfer is aborted. - Can be overriden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and + Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and 'GIT_HTTP_LOW_SPEED_TIME' environment variables. i18n.commitEncoding:: @@ -166,12 +183,12 @@ showbranch.default:: user.email:: Your email address to be recorded in any newly created commits. - Can be overriden by the 'GIT_AUTHOR_EMAIL' and 'GIT_COMMITTER_EMAIL' + Can be overridden by the 'GIT_AUTHOR_EMAIL' and 'GIT_COMMITTER_EMAIL' environment variables. See gitlink:git-commit-tree[1]. user.name:: Your full name to be recorded in any newly created commits. - Can be overriden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME' + Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME' environment variables. See gitlink:git-commit-tree[1]. whatchanged.difftree:: diff --git a/Documentation/core-tutorial.txt b/Documentation/core-tutorial.txt index d1360ec..1185897 100644 --- a/Documentation/core-tutorial.txt +++ b/Documentation/core-tutorial.txt @@ -1,5 +1,5 @@ -A short git tutorial -==================== +A git core tutorial for developers +================================== Introduction ------------ @@ -184,7 +184,7 @@ $ git-cat-file -t 557db03de997c86a4a028e1ebd3a1ceb225be238 ---------------- where the `-t` tells `git-cat-file` to tell you what the "type" of the -object is. git will tell you that you have a "blob" object (ie just a +object is. git will tell you that you have a "blob" object (i.e., just a regular file), and you can see the contents with ---------------- @@ -619,7 +619,7 @@ $ git tag -s <tagname> ---------------- which will sign the current `HEAD` (but you can also give it another -argument that specifies the thing to tag, ie you could have tagged the +argument that specifies the thing to tag, i.e., you could have tagged the current `mybranch` point by using `git tag <tagname> mybranch`). You normally only do signed tags for major releases or things @@ -1097,7 +1097,7 @@ commit object by downloading from `repo.git/objects/xx/xxx\...` using the object name of that commit object. Then it reads the commit object to find out its parent commits and the associate tree object; it repeats this process until it gets all the -necessary objects. Because of this behaviour, they are +necessary objects. Because of this behavior, they are sometimes also called 'commit walkers'. + The 'commit walkers' are sometimes also called 'dumb diff --git a/Documentation/cvs-migration.txt b/Documentation/cvs-migration.txt index fa94efd..1fbca83 100644 --- a/Documentation/cvs-migration.txt +++ b/Documentation/cvs-migration.txt @@ -1,7 +1,7 @@ git for CVS users ================= -So you're a CVS user. That's ok, it's a treatable condition. The job of +So you're a CVS user. That's OK, it's a treatable condition. The job of this document is to put you on the road to recovery, by helping you convert an existing cvs repository to git, and by showing you how to use a git repository in a cvs-like fashion. @@ -106,7 +106,7 @@ Make sure committers have a umask of at most 027, so that the directories they create are writable and searchable by other group members. Suppose this repository is now set up in /pub/repo.git on the host -foo.com. Then as an individual commiter you can clone the shared +foo.com. Then as an individual committer you can clone the shared repository: ------------------------------------------------ @@ -159,7 +159,7 @@ other than `master`. [NOTE] ============ -Because of this behaviour, if the shared repository and the developer's +Because of this behavior, if the shared repository and the developer's repository both have branches named `origin`, then a push like the above attempts to update the `origin` branch in the shared repository from the developer's `origin` branch. The results may be unexpected, so it's diff --git a/Documentation/everyday.txt b/Documentation/everyday.txt index 4b56370..b935c18 100644 --- a/Documentation/everyday.txt +++ b/Documentation/everyday.txt @@ -45,7 +45,7 @@ Everybody uses these commands to feed and care git repositories. * gitlink:git-fsck-objects[1] to validate the repository. - * gitlink:git-prune[1] to garbage collect crufts in the + * gitlink:git-prune[1] to garbage collect cruft in the repository. * gitlink:git-repack[1] to pack loose objects for efficiency. @@ -66,7 +66,7 @@ $ git prune <4> <1> running without "--full" is usually cheap and assures the repository health reasonably well. <2> check how many loose objects there are and how much -diskspace is wasted by not repacking. +disk space is wasted by not repacking. <3> without "-a" repacks incrementally. repacking every 4-5MB of loose objects accumulation may be a good rule of thumb. <4> after repack, prune removes the duplicate loose objects. @@ -86,7 +86,7 @@ Individual Developer (Standalone)[[Individual Developer (Standalone)]] ---------------------------------------------------------------------- A standalone individual developer does not exchange patches with -other poeple, and works alone in a single repository, using the +other people, and works alone in a single repository, using the following commands. * gitlink:git-show-branch[1] to see where you are. @@ -336,15 +336,20 @@ master, nor exposed as a part of a stable branch. <11> make sure I did not accidentally rewind master beyond what I already pushed out. "ko" shorthand points at the repository I have at kernel.org, and looks like this: - $ cat .git/remotes/ko - URL: kernel.org:/pub/scm/git/git.git - Pull: master:refs/tags/ko-master - Pull: maint:refs/tags/ko-maint - Push: master - Push: +pu - Push: maint ++ +------------ +$ cat .git/remotes/ko +URL: kernel.org:/pub/scm/git/git.git +Pull: master:refs/tags/ko-master +Pull: maint:refs/tags/ko-maint +Push: master +Push: +pu +Push: maint +------------ ++ In the output from "git show-branch", "master" should have everything "ko-master" has. + <12> push out the bleeding edge. <13> push the tag out, too. @@ -370,13 +375,36 @@ Examples Run git-daemon to serve /pub/scm from inetd.:: + ------------ -$ grep git /etc/inet.conf +$ grep git /etc/inetd.conf git stream tcp nowait nobody \ /usr/bin/git-daemon git-daemon --inetd --syslog --export-all /pub/scm ------------ + The actual configuration line should be on one line. +Run git-daemon to serve /pub/scm from xinetd.:: ++ +------------ +$ cat /etc/xinetd.d/git-daemon +# default: off +# description: The git server offers access to git repositories +service git +{ + disable = no + type = UNLISTED + port = 9418 + socket_type = stream + wait = no + user = nobody + server = /usr/bin/git-daemon + server_args = --inetd --syslog --export-all --base-path=/pub/scm + log_on_failure += USERID +} +------------ ++ +Check your xinetd(8) documentation and setup, this is from a Fedora system. +Others might be different. + Give push/pull only access to developers.:: + ------------ diff --git a/Documentation/git-apply.txt b/Documentation/git-apply.txt index e93ea1f..2ff7494 100644 --- a/Documentation/git-apply.txt +++ b/Documentation/git-apply.txt @@ -76,7 +76,7 @@ OPTIONS -C<n>:: Ensure at least <n> lines of surrounding context match before and after each change. When fewer lines of surrounding - context exist they all most match. By default no context is + context exist they all must match. By default no context is ever ignored. --apply:: @@ -113,7 +113,7 @@ OPTIONS When `git-apply` is used for statistics and not applying a patch, it defaults to `nowarn`. You can use different `<option>` to control this - behaviour: + behavior: + * `nowarn` turns off the trailing whitespace warning. * `warn` outputs warnings for a few such errors, but applies the diff --git a/Documentation/git-blame.txt b/Documentation/git-blame.txt index 5189878..bfed945 100644 --- a/Documentation/git-blame.txt +++ b/Documentation/git-blame.txt @@ -16,11 +16,14 @@ which introduced the line. Start annotation from the given revision. OPTIONS ------- --c, --compability:: +-c, --compatibility:: Use the same output mode as git-annotate (Default: off). -l, --long:: - Show long rev (Defaults off). + Show long rev (Default: off). + +-t, --time:: + Show raw timestamp (Default: off). -S, --rev-file <revs-file>:: Use revs from revs-file instead of calling git-rev-list. diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt index 0b37e2b..d43ef1d 100644 --- a/Documentation/git-branch.txt +++ b/Documentation/git-branch.txt @@ -9,7 +9,7 @@ SYNOPSIS -------- [verse] 'git-branch' [-r] -'git-branch' [-f] <branchname> [<start-point>] +'git-branch' [-l] [-f] <branchname> [<start-point>] 'git-branch' (-d | -D) <branchname>... DESCRIPTION @@ -23,7 +23,8 @@ If no <start-point> is given, the branch will be created with a head equal to that of the currently checked out branch. With a `-d` or `-D` option, `<branchname>` will be deleted. You may -specify more than one branch for deletion. +specify more than one branch for deletion. If the branch currently +has a ref log then the ref log will also be deleted. OPTIONS @@ -34,6 +35,11 @@ OPTIONS -D:: Delete a branch irrespective of its index status. +-l:: + Create the branch's ref log. This activates recording of + all changes to made the branch ref, enabling use of date + based sha1 expressions such as "<branchname>@{yesterday}". + -f:: Force the creation of a new branch even if it means deleting a branch that already exists with the same name. diff --git a/Documentation/git-check-ref-format.txt b/Documentation/git-check-ref-format.txt index 3ea720d..13a5f43 100644 --- a/Documentation/git-check-ref-format.txt +++ b/Documentation/git-check-ref-format.txt @@ -19,8 +19,9 @@ branch head is stored under `$GIT_DIR/refs/heads` directory, and a tag is stored under `$GIT_DIR/refs/tags` directory. git imposes the following rules on how refs are named: -. It could be named hierarchically (i.e. separated with slash - `/`), but each of its component cannot begin with a dot `.`; +. It can include slash `/` for hierarchical (directory) + grouping, but no slash-separated component can begin with a + dot `.`; . It cannot have two consecutive dots `..` anywhere; diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt index d82efc0..fbdbadc 100644 --- a/Documentation/git-checkout.txt +++ b/Documentation/git-checkout.txt @@ -8,7 +8,7 @@ git-checkout - Checkout and switch to a branch SYNOPSIS -------- [verse] -'git-checkout' [-f] [-b <new_branch>] [-m] [<branch>] +'git-checkout' [-f] [-b <new_branch> [-l]] [-m] [<branch>] 'git-checkout' [-m] [<branch>] <paths>... DESCRIPTION @@ -40,6 +40,11 @@ OPTIONS by gitlink:git-check-ref-format[1]. Some of these checks may restrict the characters allowed in a branch name. +-l:: + Create the new branch's ref log. This activates recording of + all changes to made the branch ref, enabling use of date + based sha1 expressions such as "<branchname>@{yesterday}". + -m:: If you have local modifications to one or more files that are different between the current branch and the branch to diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt index b333f51..a90521e 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt @@ -9,9 +9,9 @@ git-clone - Clones a repository SYNOPSIS -------- [verse] -'git-clone' [-l [-s]] [-q] [-n] [--bare] [-o <name>] [-u <upload-pack>] - [--reference <repository>] - <repository> [<directory>] +'git-clone' [--template=<template_directory>] [-l [-s]] [-q] [-n] [--bare] + [-o <name>] [-u <upload-pack>] [--reference <repository>] + [--use-separate-remote] <repository> [<directory>] DESCRIPTION ----------- @@ -73,7 +73,7 @@ OPTIONS files in `<directory>/.git`, make the `<directory>` itself the `$GIT_DIR`. This implies `-n` option. When this option is used, neither the `origin` branch nor the - default `remotes/origin` file is created. + default `remotes/origin` file is created. -o <name>:: Instead of using the branch name 'origin' to keep track @@ -89,12 +89,22 @@ OPTIONS the command to specify non-default path for the command run on the other end. +--template=<template_directory>:: + Specify the directory from which templates will be used; + if unset the templates are taken from the installation + defined default, typically `/usr/share/git-core/templates`. + +--use-separate-remote:: + Save remotes heads under `$GIT_DIR/remotes/origin/` instead + of `$GIT_DIR/refs/heads/`. Only the master branch is saved + in the latter. + <repository>:: The (possibly remote) repository to clone from. It can be any URL git-fetch supports. <directory>:: - The name of a new directory to clone into. The "humanish" + The name of a new directory to clone into. The "humanish" part of the source repository is used if no directory is explicitly given ("repo" for "/path/to/repo.git" and "foo" for "host.xz:foo/.git"). Cloning into an existing directory diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index 38df59c..0fe66f2 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt @@ -98,7 +98,7 @@ but can be used to amend a merge commit. Instead of committing only the files specified on the command line, update them in the index file and then commit the whole index. This is the traditional - behaviour. + behavior. -o|--only:: Commit only the files specified on the command line. diff --git a/Documentation/git-cvsserver.txt b/Documentation/git-cvsserver.txt index 4dc13c3..e328db3 100644 --- a/Documentation/git-cvsserver.txt +++ b/Documentation/git-cvsserver.txt @@ -36,49 +36,62 @@ INSTALLATION 1. If you are going to offer anonymous CVS access via pserver, add a line in /etc/inetd.conf like - ++ +-- +------ cvspserver stream tcp nowait nobody git-cvsserver pserver - Note: In some cases, you need to pass the 'pserver' argument twice for - git-cvsserver to see it. So the line would look like +------ +Note: In some cases, you need to pass the 'pserver' argument twice for +git-cvsserver to see it. So the line would look like +------ cvspserver stream tcp nowait nobody git-cvsserver pserver pserver - No special setup is needed for SSH access, other than having GIT tools - in the PATH. If you have clients that do not accept the CVS_SERVER - env variable, you can rename git-cvsserver to cvs. - +------ +No special setup is needed for SSH access, other than having GIT tools +in the PATH. If you have clients that do not accept the CVS_SERVER +env variable, you can rename git-cvsserver to cvs. +-- 2. For each repo that you want accessible from CVS you need to edit config in the repo and add the following section. - ++ +-- +------ [gitcvs] enabled=1 # optional for debugging logfile=/path/to/logfile - Note: you need to ensure each user that is going to invoke git-cvsserver has - write access to the log file and to the git repository. When offering anon - access via pserver, this means that the nobody user should have write access - to at least the sqlite database at the root of the repository. - +------ +Note: you need to ensure each user that is going to invoke git-cvsserver has +write access to the log file and to the git repository. When offering anon +access via pserver, this means that the nobody user should have write access +to at least the sqlite database at the root of the repository. +-- 3. On the client machine you need to set the following variables. CVSROOT should be set as per normal, but the directory should point at the appropriate git repo. For example: ++ +-- +For SSH access, CVS_SERVER should be set to git-cvsserver - For SSH access, CVS_SERVER should be set to git-cvsserver - - Example: +Example: +------ export CVSROOT=:ext:user@server:/var/git/project.git export CVS_SERVER=git-cvsserver - +------ +-- 4. For SSH clients that will make commits, make sure their .bashrc file sets the GIT_AUTHOR and GIT_COMMITTER variables. 5. Clients should now be able to check out the project. Use the CVS 'module' name to indicate what GIT 'head' you want to check out. Example: - ++ +------ cvs co -d project-master master +------ Eclipse CVS Client Notes ------------------------ @@ -94,7 +107,7 @@ To get a checkout with the Eclipse CVS client: 4. Pick 'HEAD' when it asks what branch/tag to check out. Untick the "launch commit wizard" to avoid committing the .project file. -Protocol notes: If you are using anonymous acces via pserver, just select that. +Protocol notes: If you are using anonymous access via pserver, just select that. Those using SSH access should choose the 'ext' protocol, and configure 'ext' access on the Preferences->Team->CVS->ExtConnection pane. Set CVS_SERVER to 'git-cvsserver'. Not that password support is not good when using 'ext', diff --git a/Documentation/git-daemon.txt b/Documentation/git-daemon.txt index 924a676..4c357da 100644 --- a/Documentation/git-daemon.txt +++ b/Documentation/git-daemon.txt @@ -20,7 +20,7 @@ aka 9418. It waits for a connection, and will just execute "git-upload-pack" when it gets one. It's careful in that there's a magic request-line that gives the command and -what directory to upload, and it verifies that the directory is ok. +what directory to upload, and it verifies that the directory is OK. It verifies that the directory has the magic file "git-daemon-export-ok", and it will refuse to export any git directory that hasn't explicitly been marked @@ -28,7 +28,7 @@ for export this way (unless the '--export-all' parameter is specified). If you pass some directory paths as 'git-daemon' arguments, you can further restrict the offers to a whitelist comprising of those. -This is ideally suited for read-only updates, ie pulling from git repositories. +This is ideally suited for read-only updates, i.e., pulling from git repositories. OPTIONS ------- diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt index 7a253ea..2700f35 100644 --- a/Documentation/git-describe.txt +++ b/Documentation/git-describe.txt @@ -21,7 +21,7 @@ object name of the commit. OPTIONS ------- <committish>:: - The object name of the comittish. + The object name of the committish. --all:: Instead of using only the annotated tags, use any ref diff --git a/Documentation/git-diff-index.txt b/Documentation/git-diff-index.txt index 5d2096a..9cd43f1 100644 --- a/Documentation/git-diff-index.txt +++ b/Documentation/git-diff-index.txt @@ -101,7 +101,7 @@ have not actually done a "git-update-index" on it yet - there is no torvalds@ppc970:~/v2.6/linux> git-diff-index HEAD *100644->100664 blob 7476bb......->000000...... kernel/sched.c -ie it shows that the tree has changed, and that `kernel/sched.c` has is +i.e., it shows that the tree has changed, and that `kernel/sched.c` has is not up-to-date and may contain new stuff. The all-zero sha1 means that to get the real diff, you need to look at the object in the working directory directly rather than do an object-to-object diff. diff --git a/Documentation/git-diff-tree.txt b/Documentation/git-diff-tree.txt index 906830d..f7e8ff2 100644 --- a/Documentation/git-diff-tree.txt +++ b/Documentation/git-diff-tree.txt @@ -32,7 +32,7 @@ include::diff-options.txt[] <path>...:: If provided, the results are limited to a subset of files matching one of these prefix strings. - ie file matches `/^<pattern1>|<pattern2>|.../` + i.e., file matches `/^<pattern1>|<pattern2>|.../` Note that this parameter does not provide any wildcard or regexp features. @@ -54,7 +54,7 @@ include::diff-options.txt[] + When a single commit is given on one line of such input, it compares the commit with its parents. The following flags further affects its -behaviour. This does not apply to the case where two <tree-ish> +behavior. This does not apply to the case where two <tree-ish> separated with a single space are given. -m:: diff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt index 7267bcd..7ab2080 100644 --- a/Documentation/git-diff.txt +++ b/Documentation/git-diff.txt @@ -85,7 +85,7 @@ $ git diff arch/i386 include/asm-i386 <3> nor deletion. <2> show only names and the nature of change, but not actual diff output. --name-status disables usual patch generation -which in turn also disables recursive behaviour, so without -r +which in turn also disables recursive behavior, so without -r you would only see the directory name if there is a change in a file in a subdirectory. <3> limit diff output to named subtrees. diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt index 7cc7faf..4ca0014 100644 --- a/Documentation/git-format-patch.txt +++ b/Documentation/git-format-patch.txt @@ -9,26 +9,31 @@ git-format-patch - Prepare patches for e-mail submission SYNOPSIS -------- [verse] -'git-format-patch' [-n | -k] [-o <dir> | --stdout] [--attach] [-s] [-c] - [--diff-options] <his> [<mine>] +'git-format-patch' [-n | -k] [-o <dir> | --stdout] [--attach] + [-s | --signoff] [--diff-options] [--start-number <n>] + <since>[..<until>] DESCRIPTION ----------- -Prepare each commit with its patch since <mine> head forked from -<his> head, one file per patch formatted to resemble UNIX mailbox -format, for e-mail submission or use with gitlink:git-am[1]. + +Prepare each commit between <since> and <until> with its patch in +one file per commit, formatted to resemble UNIX mailbox format. +If ..<until> is not specified, the head of the current working +tree is implied. + +The output of this command is convenient for e-mail submission or +for use with gitlink:git-am[1]. Each output file is numbered sequentially from 1, and uses the -first line of the commit message (massaged for pathname safety) -as the filename. +first line of the commit message (massaged for pathname safety) as +the filename. The names of the output files are printed to standard +output, unless the --stdout option is specified. -When -o is specified, output files are created in <dir>; otherwise -they are created in the current working directory. This option -is ignored if --stdout is specified. +If -o is specified, output files are created in <dir>. Otherwise +they are created in the current working directory. -When -n is specified, instead of "[PATCH] Subject", the first -line is formatted as "[PATCH N/M] Subject", unless you have only -one patch. +If -n is specified, instead of "[PATCH] Subject", the first line +is formatted as "[PATCH n/m] Subject". OPTIONS @@ -40,6 +45,9 @@ OPTIONS -n|--numbered:: Name output in '[PATCH n/m]' format. +--start-number <n>:: + Start numbering the patches at <n> instead of 1. + -k|--keep-subject:: Do not strip/add '[PATCH]' from the first line of the commit log message. @@ -48,17 +56,9 @@ OPTIONS Add `Signed-off-by:` line to the commit message, using the committer identity of yourself. --c|--check:: - Display suspicious lines in the patch. The definition - of 'suspicious lines' is currently the lines that has - trailing whitespaces, and the lines whose indentation - has a SP character immediately followed by a TAB - character. - --stdout:: - This flag generates the mbox formatted output to the - standard output, instead of saving them into a file per - patch and implies --mbox. + Print all commits to the standard output in mbox format, + instead of creating a file for each one. --attach:: Create attachments instead of inlining patches. @@ -82,18 +82,18 @@ git-format-patch -k --stdout R1..R2 | git-am -3 -k:: cherry-pick them. git-format-patch origin:: - Extract commits the current branch accumulated since it - pulled from origin the last time in a patch form for - e-mail submission. + Extract all commits which are in the current branch but + not in the origin branch. For each commit a separate file + is created in the current directory. git-format-patch -M -B origin:: - The same as the previous one, except detect and handle - renames and complete rewrites intelligently to produce - renaming patch. A renaming patch reduces the amount of - text output, and generally makes it easier to review - it. Note that the "patch" program does not understand - renaming patch well, so use it only when you know the - recipient uses git to apply your patch. + The same as the previous one. Additionally, it detects + and handles renames and complete rewrites intelligently to + produce a renaming patch. A renaming patch reduces the + amount of text output, and generally makes it easier to + review it. Note that the "patch" program does not + understand renaming patches, so use it only when you know + the recipient uses git to apply your patch. See Also diff --git a/Documentation/git-fsck-objects.txt b/Documentation/git-fsck-objects.txt index 93ce9dc..d0af99d 100644 --- a/Documentation/git-fsck-objects.txt +++ b/Documentation/git-fsck-objects.txt @@ -71,7 +71,7 @@ sorted properly etc), but on the whole if "git-fsck-objects" is happy, you do have a valid tree. Any corrupt objects you will have to find in backups or other archives -(ie you can just remove them and do an "rsync" with some other site in +(i.e., you can just remove them and do an "rsync" with some other site in the hopes that somebody else has the object you have corrupted). Of course, "valid tree" doesn't mean that it wasn't generated by some diff --git a/Documentation/git-grep.txt b/Documentation/git-grep.txt index 74102b7..7b810df 100644 --- a/Documentation/git-grep.txt +++ b/Documentation/git-grep.txt @@ -30,7 +30,7 @@ OPTIONS ------- --cached:: Instead of searching in the working tree files, check - the blobs registerd in the index file. + the blobs registered in the index file. -a | --text:: Process binary files as if they were text. @@ -65,7 +65,7 @@ OPTIONS -[ABC] <context>:: Show `context` trailing (`A` -- after), or leading (`B` -- before), or both (`C` -- context) lines, and place a - line containing `--` between continguous groups of + line containing `--` between contiguous groups of matches. -f <file>:: diff --git a/Documentation/git-ls-files.txt b/Documentation/git-ls-files.txt index a29c633..4d8a2ad 100644 --- a/Documentation/git-ls-files.txt +++ b/Documentation/git-ls-files.txt @@ -195,8 +195,7 @@ An exclude pattern is of the following format: - if it does not contain a slash '/', it is a shell glob pattern and used to match against the filename without - leading directories (i.e. the same way as the current - implementation). + leading directories. - otherwise, it is a shell glob pattern, suitable for consumption by fnmatch(3) with FNM_PATHNAME flag. I.e. a @@ -222,6 +221,19 @@ An example: --exclude-per-directory=.gitignore -------------------------------------------------------------- +Another example: + +-------------------------------------------------------------- + $ cat .gitignore + vmlinux* + $ ls arch/foo/kernel/vm* + arch/foo/kernel/vmlinux.lds.S + $ echo '!/vmlinux*' >arch/foo/kernel/.gitignore +-------------------------------------------------------------- + +The second .gitignore keeps `arch/foo/kernel/vmlinux.lds.S` file +from getting ignored. + See Also -------- diff --git a/Documentation/git-ls-tree.txt b/Documentation/git-ls-tree.txt index 018c401..f283bac 100644 --- a/Documentation/git-ls-tree.txt +++ b/Documentation/git-ls-tree.txt @@ -8,9 +8,10 @@ git-ls-tree - Lists the contents of a tree object SYNOPSIS -------- +[verse] 'git-ls-tree' [-d] [-r] [-t] [-z] - [--name-only] [--name-status] [--full-name] [--abbrev=[<n>]] - <tree-ish> [paths...] + [--name-only] [--name-status] [--full-name] [--abbrev=[<n>]] + <tree-ish> [paths...] DESCRIPTION ----------- @@ -47,6 +48,10 @@ OPTIONS lines, show only handful hexdigits prefix. Non default number of digits can be specified with --abbrev=<n>. +--full-name:: + Instead of showing the path names relative to the current working + directory, show the full path names. + paths:: When paths are given, show them (note that this isn't really raw pathnames, but rather a list of patterns to match). Otherwise @@ -72,8 +77,6 @@ Documentation Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>. -This manual page is a stub. You can help the git documentation by expanding it. - GIT --- Part of the gitlink:git[7] suite diff --git a/Documentation/git-merge-index.txt b/Documentation/git-merge-index.txt index 332e023..6cd0601 100644 --- a/Documentation/git-merge-index.txt +++ b/Documentation/git-merge-index.txt @@ -69,7 +69,7 @@ or fatal: merge program failed where the latter example shows how "git-merge-index" will stop trying to -merge once anything has returned an error (ie "cat" returned an error +merge once anything has returned an error (i.e., "cat" returned an error for the AA file, because it didn't exist in the original, and thus "git-merge-index" didn't even try to merge the MM thing). diff --git a/Documentation/git-name-rev.txt b/Documentation/git-name-rev.txt index ffaa004..39a1434 100644 --- a/Documentation/git-name-rev.txt +++ b/Documentation/git-name-rev.txt @@ -8,7 +8,7 @@ git-name-rev - Find symbolic names for given revs SYNOPSIS -------- -'git-name-rev' [--tags] ( --all | --stdin | <commitish>... ) +'git-name-rev' [--tags] ( --all | --stdin | <committish>... ) DESCRIPTION ----------- diff --git a/Documentation/git-p4import.txt b/Documentation/git-p4import.txt new file mode 100644 index 0000000..0858e5e --- /dev/null +++ b/Documentation/git-p4import.txt @@ -0,0 +1,168 @@ +git-p4import(1) +=============== + +NAME +---- +git-p4import - Import a Perforce repository into git + + +SYNOPSIS +-------- +`git-p4import` [-q|-v] [--notags] [--authors <file>] [-t <timezone>] <//p4repo/path> <branch> + +`git-p4import` --stitch <//p4repo/path> + +`git-p4import` + + +DESCRIPTION +----------- +Import a Perforce repository into an existing git repository. When +a <//p4repo/path> and <branch> are specified a new branch with the +given name will be created and the initial import will begin. + +Once the initial import is complete you can do an incremental import +of new commits from the Perforce repository. You do this by checking +out the appropriate git branch and then running `git-p4import` without +any options. + +The standard p4 client is used to communicate with the Perforce +repository; it must be configured correctly in order for `git-p4import` +to operate (see below). + + +OPTIONS +------- +-q:: + Do not display any progress information. + +-v:: + Give extra progress information. + +\--authors:: + Specify an authors file containing a mapping of Perforce user + ids to full names and email addresses (see Notes below). + +\--notags:: + Do not create a tag for each imported commit. + +\--stitch:: + Import the contents of the given perforce branch into the + currently checked out git branch. + +\--log:: + Store debugging information in the specified file. + +-t:: + Specify that the remote repository is in the specified timezone. + Timezone must be in the format "US/Pacific" or "Europe/London" + etc. You only need to specify this once, it will be saved in + the git config file for the repository. + +<//p4repo/path>:: + The Perforce path that will be imported into the specified branch. + +<branch>:: + The new branch that will be created to hold the Perforce imports. + + +P4 Client +--------- +You must make the `p4` client command available in your $PATH and +configure it to communicate with the target Perforce repository. +Typically this means you must set the "$P4PORT" and "$P4CLIENT" +environment variables. + +You must also configure a `p4` client "view" which maps the Perforce +branch into the top level of your git repository, for example: + +------------ +Client: myhost + +Root: /home/sean/import + +Options: noallwrite clobber nocompress unlocked modtime rmdir + +View: + //public/jam/... //myhost/jam/... +------------ + +With the above `p4` client setup, you could import the "jam" +perforce branch into a branch named "jammy", like so: + +------------ +$ mkdir -p /home/sean/import/jam +$ cd /home/sean/import/jam +$ git init-db +$ git p4import //public/jam jammy +------------ + + +Multiple Branches +----------------- +Note that by creating multiple "views" you can use `git-p4import` +to import additional branches into the same git repository. +However, the `p4` client has a limitation in that it silently +ignores all but the last "view" that maps into the same local +directory. So the following will *not* work: + +------------ +View: + //public/jam/... //myhost/jam/... + //public/other/... //myhost/jam/... + //public/guest/... //myhost/jam/... +------------ + +If you want more than one Perforce branch to be imported into the +same directory you must employ a workaround. A simple option is +to adjust your `p4` client before each import to only include a +single view. + +Another option is to create multiple symlinks locally which all +point to the same directory in your git repository and then use +one per "view" instead of listing the actual directory. + + +Tags +---- +A git tag of the form p4/xx is created for every change imported from +the Perforce repository where xx is the Perforce changeset number. +Therefore after the import you can use git to access any commit by its +Perforce number, eg. git show p4/327. + +The tag associated with the HEAD commit is also how `git-p4import` +determines if there are new changes to incrementally import from the +Perforce repository. + +If you import from a repository with many thousands of changes +you will have an equal number of p4/xxxx git tags. Git tags can +be expensive in terms of disk space and repository operations. +If you don't need to perform further incremental imports, you +may delete the tags. + + +Notes +----- +You can interrupt the import (eg. ctrl-c) at any time and restart it +without worry. + +Author information is automatically determined by querying the +Perforce "users" table using the id associated with each change. +However, if you want to manually supply these mappings you can do +so with the "--authors" option. It accepts a file containing a list +of mappings with each line containing one mapping in the format: + +------------ + perforce_id = Full Name <email@address.com> +------------ + + +Author +------ +Written by Sean Estabrooks <seanlkml@sympatico.ca> + + +GIT +--- +Part of the gitlink:git[7] suite + diff --git a/Documentation/git-patch-id.txt b/Documentation/git-patch-id.txt index 723b8cc..5389097 100644 --- a/Documentation/git-patch-id.txt +++ b/Documentation/git-patch-id.txt @@ -13,7 +13,7 @@ DESCRIPTION ----------- A "patch ID" is nothing but a SHA1 of the diff associated with a patch, with whitespace and line numbers ignored. As such, it's "reasonably stable", but at -the same time also reasonably unique, ie two patches that have the same "patch +the same time also reasonably unique, i.e., two patches that have the same "patch ID" are almost guaranteed to be the same thing. IOW, you can use this thing to look for likely duplicate commits. diff --git a/Documentation/git-read-tree.txt b/Documentation/git-read-tree.txt index 844cfda..11bd9c0 100644 --- a/Documentation/git-read-tree.txt +++ b/Documentation/git-read-tree.txt @@ -8,7 +8,7 @@ git-read-tree - Reads tree information into the index SYNOPSIS -------- -'git-read-tree' (<tree-ish> | [[-m [--aggressive]| --reset] [-u | -i]] <tree-ish1> [<tree-ish2> [<tree-ish3>]]) +'git-read-tree' (<tree-ish> | [[-m [--aggressive] | --reset | --prefix=<prefix>] [-u | -i]] <tree-ish1> [<tree-ish2> [<tree-ish3>]]) DESCRIPTION @@ -63,6 +63,15 @@ OPTIONS * when both sides adds a path identically. The resolution is to add that path. +--prefix=<prefix>/:: + Keep the current index contents, and read the contents + of named tree-ish under directory at `<prefix>`. The + original index file cannot have anything at the path + `<prefix>` itself, and have nothing in `<prefix>/` + directory. Note that the `<prefix>/` value must end + with a slash. + + <tree-ish#>:: The id of the tree object(s) to be read/merged. @@ -205,7 +214,7 @@ The `git-write-tree` command refuses to write a nonsensical tree, and it will complain about unmerged entries if it sees a single entry that is not stage 0. -Ok, this all sounds like a collection of totally nonsensical rules, +OK, this all sounds like a collection of totally nonsensical rules, but it's actually exactly what you want in order to do a fast merge. The different stages represent the "result tree" (stage 0, aka "merged"), the original tree (stage 1, aka "orig"), and the two trees @@ -226,7 +235,7 @@ populated. Here is an outline of how the algorithm works: - the index file saves and restores with all this information, so you can merge things incrementally, but as long as it has entries in - stages 1/2/3 (ie "unmerged entries") you can't write the result. So + stages 1/2/3 (i.e., "unmerged entries") you can't write the result. So now the merge algorithm ends up being really simple: * you walk the index in order, and ignore all entries of stage 0, @@ -257,7 +266,7 @@ file that does not match stage 2. This is done to prevent you from losing your work-in-progress changes, and mixing your random changes in an unrelated merge commit. To illustrate, suppose you start from what has been -commited last to your repository: +committed last to your repository: ---------------- $ JC=`git-rev-parse --verify "HEAD^0"` diff --git a/Documentation/git-repo-config.txt b/Documentation/git-repo-config.txt index 660c18f..d5142e0 100644 --- a/Documentation/git-repo-config.txt +++ b/Documentation/git-repo-config.txt @@ -49,7 +49,7 @@ OPTIONS ------- --replace-all:: - Default behaviour is to replace at most one line. This replaces + Default behavior is to replace at most one line. This replaces all lines matching the key (and optionally the value_regex). --get:: diff --git a/Documentation/git-reset.txt b/Documentation/git-reset.txt index b27399d..73a0ffc 100644 --- a/Documentation/git-reset.txt +++ b/Documentation/git-reset.txt @@ -24,7 +24,7 @@ gitlink:git-revert[1] is your friend. OPTIONS ------- --mixed:: - Resets the index but not the working tree (ie, the changed files + Resets the index but not the working tree (i.e., the changed files are preserved but not marked for commit) and reports what has not been updated. This is the default action. diff --git a/Documentation/git-rev-parse.txt b/Documentation/git-rev-parse.txt index ab896fc..627cde8 100644 --- a/Documentation/git-rev-parse.txt +++ b/Documentation/git-rev-parse.txt @@ -13,7 +13,7 @@ SYNOPSIS DESCRIPTION ----------- -Many git Porcelainish commands take mixture of flags +Many git porcelainish commands take mixture of flags (i.e. parameters that begin with a dash '-') and parameters meant for underlying `git-rev-list` command they use internally and flags and parameters for other commands they use as the @@ -91,7 +91,7 @@ OPTIONS --short, --short=number:: Instead of outputting the full SHA1 values of object names try to - abbriviate them to a shorter unique name. When no length is specified + abbreviate them to a shorter unique name. When no length is specified 7 is used. The minimum length is 4. --since=datestring, --after=datestring:: @@ -124,6 +124,13 @@ syntax. happen to have both heads/master and tags/master, you can explicitly say 'heads/master' to tell git which one you mean. +* A suffix '@' followed by a date specification enclosed in a brace + pair (e.g. '\{yesterday\}', '\{1 month 2 weeks 3 days 1 hour 1 + second ago\}' or '\{1979-02-26 18:30:00\}') to specify the value + of the ref at a prior point in time. This suffix may only be + used immediately following a ref name and the ref must have an + existing log ($GIT_DIR/logs/<ref>). + * A suffix '{caret}' to a revision parameter means the first parent of that commit object. '{caret}<n>' means the <n>th parent (i.e. 'rev{caret}' diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt index 8c58685..ad1b9cf 100644 --- a/Documentation/git-send-email.txt +++ b/Documentation/git-send-email.txt @@ -52,7 +52,7 @@ The options available are: is not set, this will be prompted for. --no-signed-off-by-cc:: - Do not add emails foudn in Signed-off-by: lines to the cc list. + Do not add emails found in Signed-off-by: lines to the cc list. --quiet:: Make git-send-email less verbose. One line per email should be diff --git a/Documentation/git-send-pack.txt b/Documentation/git-send-pack.txt index 08e0705..9e67f17 100644 --- a/Documentation/git-send-pack.txt +++ b/Documentation/git-send-pack.txt @@ -53,7 +53,7 @@ Specifying the Refs There are three ways to specify which refs to update on the remote end. -With '--all' flag, all refs that exist locally are transfered to +With '--all' flag, all refs that exist locally are transferred to the remote side. You cannot specify any '<ref>' if you use this flag. diff --git a/Documentation/git-sh-setup.txt b/Documentation/git-sh-setup.txt index 6742c9b..79217d8 100644 --- a/Documentation/git-sh-setup.txt +++ b/Documentation/git-sh-setup.txt @@ -13,7 +13,7 @@ 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. +(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: diff --git a/Documentation/git-shortlog.txt b/Documentation/git-shortlog.txt index 54fb922..7486ebe 100644 --- a/Documentation/git-shortlog.txt +++ b/Documentation/git-shortlog.txt @@ -5,7 +5,6 @@ NAME ---- git-shortlog - Summarize 'git log' output - SYNOPSIS -------- git-log --pretty=short | 'git-shortlog' @@ -13,8 +12,22 @@ git-log --pretty=short | 'git-shortlog' DESCRIPTION ----------- Summarizes 'git log' output in a format suitable for inclusion -in release announcements. - +in release announcements. Each commit will be grouped by author +the first line of the commit message will be shown. + +Additionally, "[PATCH]" will be stripped from the commit description. + +FILES +----- +'.mailmap':: + 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 + '<' and '>'. Use hash '#' for comments. Example: + + # Keep alphabetized + Adam Morrow <adam@localhost.localdomain> + Eve Jones <eve@laptop.(none)> Author ------ diff --git a/Documentation/git-tar-tree.txt b/Documentation/git-tar-tree.txt index 2139b6f..831537b 100644 --- a/Documentation/git-tar-tree.txt +++ b/Documentation/git-tar-tree.txt @@ -8,7 +8,7 @@ git-tar-tree - Creates a tar archive of the files in the named tree SYNOPSIS -------- -'git-tar-tree' <tree-ish> [ <base> ] +'git-tar-tree' [--remote=<repo>] <tree-ish> [ <base> ] DESCRIPTION ----------- @@ -23,6 +23,35 @@ 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. +OPTIONS +------- + +<tree-ish>:: + The tree or commit to produce tar archive for. If it is + the object name of a commit object. + +<base>:: + Leading path to the files in the resulting tar archive. + +--remote=<repo>:: + Instead of making a tar archive from local repository, + retrieve a tar archive from a remote repository. + +Examples +-------- +git tar-tree HEAD | (cd /var/tmp/ && mkdir junk && tar Cxf junk -):: + + Create a tar archive that contains the contents of the + latest commit on the current branch, and extracts it in + `/var/tmp/junk` directory. + +git tar-tree v2.6.17 linux-2.6.17 | gzip >linux-2.6.17.tar.gz + + Create a tarball for v2.6.17 release. + +git tar-tree --remote=example.com:git.git v0.99 >git-0.99.tar + + Get a tarball v0.99 from example.com. Author ------ diff --git a/Documentation/git-tools.txt b/Documentation/git-tools.txt index 00e57a6..d79523f 100644 --- a/Documentation/git-tools.txt +++ b/Documentation/git-tools.txt @@ -12,7 +12,7 @@ This document presents a brief summary of each tool and the corresponding link. -Alternative/Augmentative Procelains +Alternative/Augmentative Porcelains ----------------------------------- - *Cogito* (http://www.kernel.org/pub/software/scm/cogito/) diff --git a/Documentation/git-update-index.txt b/Documentation/git-update-index.txt index d043e86..3ae6e74 100644 --- a/Documentation/git-update-index.txt +++ b/Documentation/git-update-index.txt @@ -40,7 +40,7 @@ OPTIONS --remove:: If a specified file is in the index but is missing then it's removed. - Default behaviour is to ignore removed file. + Default behavior is to ignore removed file. --refresh:: Looks at the current index and checks to see if merges or diff --git a/Documentation/git-update-ref.txt b/Documentation/git-update-ref.txt index 475237f..e062030 100644 --- a/Documentation/git-update-ref.txt +++ b/Documentation/git-update-ref.txt @@ -7,7 +7,7 @@ git-update-ref - update the object name stored in a ref safely SYNOPSIS -------- -'git-update-ref' <ref> <newvalue> [<oldvalue>] +'git-update-ref' [-m <reason>] <ref> <newvalue> [<oldvalue>] DESCRIPTION ----------- @@ -49,6 +49,32 @@ for reading but not for writing (so we'll never write through a ref symlink to some other tree, if you have copied a whole archive by creating a symlink tree). +Logging Updates +--------------- +If config parameter "core.logAllRefUpdates" is true or the file +"$GIT_DIR/logs/<ref>" exists then `git-update-ref` will append +a line to the log file "$GIT_DIR/logs/<ref>" (dereferencing all +symbolic refs before creating the log name) describing the change +in ref value. Log lines are formatted as: + + . oldsha1 SP newsha1 SP committer LF ++ +Where "oldsha1" is the 40 character hexadecimal value previously +stored in <ref>, "newsha1" is the 40 character hexadecimal value of +<newvalue> and "committer" is the committer's name, email address +and date in the standard GIT committer ident format. + +Optionally with -m: + + . oldsha1 SP newsha1 SP committer TAB message LF ++ +Where all fields are as described above and "message" is the +value supplied to the -m option. + +An update will fail (without changing <ref>) if the current user is +unable to create a new log file, append to the existing log file +or does not have committer information available. + Author ------ Written by Linus Torvalds <torvalds@osdl.org>. diff --git a/Documentation/git-upload-tar.txt b/Documentation/git-upload-tar.txt new file mode 100644 index 0000000..a1019a0 --- /dev/null +++ b/Documentation/git-upload-tar.txt @@ -0,0 +1,39 @@ +git-upload-tar(1) +================= + +NAME +---- +git-upload-tar - Send tar archive + + +SYNOPSIS +-------- +'git-upload-tar' <directory> + +DESCRIPTION +----------- +Invoked by 'git-tar-tree --remote' and sends a generated tar archive +to the other end over the git protocol. + +This command is usually not invoked directly by the end user. +The UI for the protocol is on the 'git-tar-tree' side, and the +program pair is meant to be used to get a tar achive from a +remote repository. + + +OPTIONS +------- +<directory>:: + The repository to get a tar archive from. + +Author +------ +Written by Junio C Hamano <junio@kernel.org> + +Documentation +-------------- +Documentation by Junio C Hamano. + +GIT +--- +Part of the gitlink:git[7] suite diff --git a/Documentation/git-write-tree.txt b/Documentation/git-write-tree.txt index 77e12cb..c85fa89 100644 --- a/Documentation/git-write-tree.txt +++ b/Documentation/git-write-tree.txt @@ -8,7 +8,7 @@ git-write-tree - Creates a tree object from the current index SYNOPSIS -------- -'git-write-tree' [--missing-ok] +'git-write-tree' [--missing-ok] [--prefix=<prefix>/] DESCRIPTION ----------- @@ -30,6 +30,12 @@ OPTIONS directory exist in the object database. This option disables this check. +--prefix=<prefix>/:: + Writes a tree object that represents a subdirectory + `<prefix>`. This can be used to write the tree object + for a subproject that is in the named subdirectory. + + Author ------ Written by Linus Torvalds <torvalds@osdl.org> diff --git a/Documentation/git.txt b/Documentation/git.txt index 24ca55d..d4472b5 100644 --- a/Documentation/git.txt +++ b/Documentation/git.txt @@ -21,6 +21,9 @@ link:everyday.html[Everyday Git] for a useful minimum set of commands, and "man git-commandname" for documentation of each command. CVS users may also want to read link:cvs-migration.html[CVS migration]. +The COMMAND is either a name of a Git command (see below) or an alias +as defined in the configuration file (see gitlink:git-repo-config[1]). + OPTIONS ------- --version:: @@ -237,6 +240,10 @@ gitlink:git-upload-pack[1]:: Invoked by 'git-clone-pack' and 'git-fetch-pack' to push what are asked for. +gitlink:git-upload-tar[1]:: + Invoked by 'git-tar-tree --remote' to return the tar + archive the other end asked for. + High-level commands (porcelain) ------------------------------- @@ -378,6 +385,9 @@ gitlink:git-merge-one-file[1]:: gitlink:git-prune[1]:: Prunes all unreachable objects from the object database. +gitlink:git-quiltimport[1]:: + Applies a quilt patchset onto the current branch. + gitlink:git-relink[1]:: Hardlink common objects in local repositories. diff --git a/Documentation/glossary.txt b/Documentation/glossary.txt index 39c90ad..116ddb7 100644 --- a/Documentation/glossary.txt +++ b/Documentation/glossary.txt @@ -109,6 +109,13 @@ file system:: git archive:: Synonym for repository (for arch people). +grafts:: + Grafts enables two otherwise different lines of development to be + joined together by recording fake ancestry information for commits. + This way you can make git pretend the set of parents a commit + has is different from what was recorded when the commit was created. + Configured via the `.git/info/grafts` file. + hash:: In git's context, synonym to object name. diff --git a/Documentation/hooks.txt b/Documentation/hooks.txt index 3824a95..898b4aa 100644 --- a/Documentation/hooks.txt +++ b/Documentation/hooks.txt @@ -100,7 +100,7 @@ update This hook is invoked by `git-receive-pack` on the remote repository, which is happens when a `git push` is done on a local repository. Just before updating the ref on the remote repository, the update hook -is invoked. It's exit status determins the success or failure of +is invoked. Its exit status determines the success or failure of the ref update. The hook executes once for each ref to be updated, and takes @@ -151,7 +151,7 @@ so it is a poor place to do log old..new. The default post-update hook, when enabled, runs `git-update-server-info` to keep the information used by dumb -transports (eg, http) up-to-date. If you are publishing +transports (e.g., http) up-to-date. If you are publishing a git repository that is accessible via http, you should probably enable this hook. diff --git a/Documentation/repository-layout.txt b/Documentation/repository-layout.txt index 98fbe7d..b52dfdc 100644 --- a/Documentation/repository-layout.txt +++ b/Documentation/repository-layout.txt @@ -128,3 +128,14 @@ remotes:: Stores shorthands to be used to give URL and default refnames to interact with remote repository to `git fetch`, `git pull` and `git push` commands. + +logs:: + Records of changes made to refs are stored in this + directory. See the documentation on git-update-ref + for more information. + +logs/refs/heads/`name`:: + Records all changes made to the branch tip named `name`. + +logs/refs/tags/`name`:: + Records all changes made to the tag named `name`. diff --git a/Documentation/technical/pack-format.txt b/Documentation/technical/pack-format.txt index ed2decc..0e1ffb2 100644 --- a/Documentation/technical/pack-format.txt +++ b/Documentation/technical/pack-format.txt @@ -5,8 +5,13 @@ GIT pack format - The header appears at the beginning and consists of the following: - 4-byte signature - 4-byte version number (network byte order) + 4-byte signature: + The signature is: {'P', 'A', 'C', 'K'} + + 4-byte version number (network byte order): + GIT currently accepts version number 2 or 3 but + generates version 2 only. + 4-byte number of objects contained in the pack (network byte order) Observation: we cannot have more than 4G versions ;-) and @@ -41,7 +46,7 @@ GIT pack format 8-byte integers to go beyond 4G objects per pack, but it is not strictly necessary. - - The header is followed by sorted 28-byte entries, one entry + - The header is followed by sorted 24-byte entries, one entry per object in the pack. Each entry is: 4-byte network byte order integer, recording where the diff --git a/Documentation/technical/pack-heuristics.txt b/Documentation/technical/pack-heuristics.txt index eaab3ee..9aadd5c 100644 --- a/Documentation/technical/pack-heuristics.txt +++ b/Documentation/technical/pack-heuristics.txt @@ -288,7 +288,7 @@ And of course there is the "Other Shoe" Factor too. - we actively try to generate deltas from a larger object to a smaller one - this means that the top-of-tree very seldom has deltas - (ie deltas in _practice_ are "backwards deltas") + (i.e. deltas in _practice_ are "backwards deltas") Again, we should reread that whole paragraph. Not just because Linus has slipped Linus's Law in there on us, but because it is diff --git a/Documentation/tutorial-2.txt b/Documentation/tutorial-2.txt index 08d3453..894ca5e 100644 --- a/Documentation/tutorial-2.txt +++ b/Documentation/tutorial-2.txt @@ -49,7 +49,7 @@ tree A tree can refer to one or more "blob" objects, each corresponding to a file. In addition, a tree can also refer to other tree objects, -thus creating a directory heirarchy. You can examine the contents of +thus creating a directory hierarchy. You can examine the contents of any tree using ls-tree (remember that a long enough initial portion of the SHA1 will also work): @@ -136,7 +136,7 @@ The "tree" object here refers to the new state of the tree: ------------------------------------------------ $ git ls-tree d0492b36 100644 blob a0423896973644771497bdc03eb99d5281615b51 file.txt -$ git cat-file commit a0423896 +$ git cat-file blob a0423896 hello world! ------------------------------------------------ @@ -377,7 +377,7 @@ At this point you should know everything necessary to read the man pages for any of the git commands; one good place to start would be with the commands mentioned in link:everyday.html[Everyday git]. You should be able to find any unknown jargon in the -link:glossary.html[Glosssay]. +link:glossary.html[Glossary]. The link:cvs-migration.html[CVS migration] document explains how to import a CVS repository into git, and shows how to use git in a diff --git a/Documentation/tutorial.txt b/Documentation/tutorial.txt index 79781ad..554ee0a 100644 --- a/Documentation/tutorial.txt +++ b/Documentation/tutorial.txt @@ -194,7 +194,7 @@ $ git clone /home/alice/project myrepo This creates a new directory "myrepo" containing a clone of Alice's repository. The clone is on an equal footing with the original -project, posessing its own copy of the original project's history. +project, possessing its own copy of the original project's history. Bob then makes some changes and commits them: @@ -240,7 +240,7 @@ $ git log -p master..bob-incoming shows a list of all the changes that Bob made since he branched from Alice's master branch. -After examing those changes, and possibly fixing things, Alice can +After examining those changes, and possibly fixing things, Alice can pull the changes into her master branch: ------------------------------------- @@ -357,7 +357,7 @@ $ git diff v2.5 HEAD # compare the current HEAD to v2.5 $ git branch stable v2.5 # start a new branch named "stable" based # at v2.5 $ git reset --hard HEAD^ # reset your current branch and working - # directory its state at HEAD^ + # directory to its state at HEAD^ ------------------------------------- Be careful with that last command: in addition to losing any changes @@ -374,7 +374,7 @@ project, so $ git grep "hello" v2.5 ------------------------------------- -searches for all occurences of "hello" in v2.5. +searches for all occurrences of "hello" in v2.5. If you leave out the commit name, git grep will search any of the files it manages in your current directory. So @@ -429,16 +429,24 @@ $ gitk --since="2 weeks ago" drivers/ ------------------------------------- allows you to browse any commits from the last 2 weeks of commits -that modified files under the "drivers" directory. +that modified files under the "drivers" directory. (Note: you can +adjust gitk's fonts by holding down the control key while pressing +"-" or "+".) Finally, most commands that take filenames will optionally allow you to precede any filename by a commit, to specify a particular version -fo the file: +of the file: ------------------------------------- $ git diff v2.5:Makefile HEAD:Makefile.in ------------------------------------- +You can also use "git cat-file -p" to see any such file: + +------------------------------------- +$ git cat-file -p v2.5:Makefile +------------------------------------- + Next Steps ---------- @@ -474,6 +482,6 @@ digressions that may be interesting at this point are: smart enough to perform a close-to-optimal search even in the case of complex non-linear history with lots of merged branches. - * link:everyday.html[Everday GIT with 20 Commands Or So] + * link:everyday.html[Everyday GIT with 20 Commands Or So] * link:cvs-migration.html[git for CVS users]. |