From: Junio C Hamano Date: Wed, 7 Jun 2006 19:51:45 +0000 (+0000) Subject: Autogenerated HTML docs for v1.4.0-rc1-gfd7e X-Git-Url: https://git.verplant.org/?a=commitdiff_plain;h=33db43733d19e4dd878a9a04089535eaf47fd374;p=git.git Autogenerated HTML docs for v1.4.0-rc1-gfd7e --- diff --git a/config.txt b/config.txt index c861c6ce..570b691b 100644 --- a/config.txt +++ b/config.txt @@ -91,6 +91,14 @@ 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, aliases that hide existing git commands are ignored. + Arguments are split at whitespaces, but single or double + quote pair 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]. @@ -113,12 +121,12 @@ 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:: @@ -133,7 +141,7 @@ http.sslCAInfo:: 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:: diff --git a/cvs-migration.html b/cvs-migration.html index 1ff9c4ec..63e5d1ec 100644 --- a/cvs-migration.html +++ b/cvs-migration.html @@ -368,7 +368,7 @@ $ GIT_DIR=repo.git git repo-config core.sharedrepository true

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:

@@ -579,7 +579,7 @@ that contain this changed "if" statement:

diff --git a/cvs-migration.txt b/cvs-migration.txt index 826d0897..1fbca831 100644 --- a/cvs-migration.txt +++ b/cvs-migration.txt @@ -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: ------------------------------------------------ diff --git a/everyday.html b/everyday.html index 93b56172..012a9473 100644 --- a/everyday.html +++ b/everyday.html @@ -308,7 +308,7 @@ repositories to support developers.

  • -git-prune(1) to garbage collect crufts in the +git-prune(1) to garbage collect cruft in the repository.

    • @@ -1067,7 +1067,7 @@ upload to public HTTP server hosted by your ISP.
    diff --git a/everyday.txt b/everyday.txt index 6745ab5f..b935c180 100644 --- a/everyday.txt +++ b/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. diff --git a/git-apply.html b/git-apply.html index ff6beffc..bbfb9dcd 100644 --- a/git-apply.html +++ b/git-apply.html @@ -390,7 +390,7 @@ and a work tree.

    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.

    @@ -510,7 +510,7 @@ apply.whitespace diff --git a/git-apply.txt b/git-apply.txt index 9cc7c74d..2ff74949 100644 --- a/git-apply.txt +++ b/git-apply.txt @@ -76,7 +76,7 @@ OPTIONS -C:: Ensure at least 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:: diff --git a/git-check-ref-format.html b/git-check-ref-format.html index 8e555647..89d44303 100644 --- a/git-check-ref-format.html +++ b/git-check-ref-format.html @@ -285,8 +285,9 @@ imposes the following rules on how refs are named:

    1. -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 .;

    2. @@ -342,7 +343,7 @@ colon : is used as in srcref:dstref to mean "use srcref's diff --git a/git-check-ref-format.txt b/git-check-ref-format.txt index 3ea720dd..13a5f430 100644 --- a/git-check-ref-format.txt +++ b/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/git-describe.html b/git-describe.html index 3395f889..0b9589b0 100644 --- a/git-describe.html +++ b/git-describe.html @@ -289,7 +289,7 @@ object name of the commit.

      - The object name of the comittish. + The object name of the committish.

      @@ -367,7 +367,7 @@ butchered by Junio C Hamano <junkio@cox.net>

      diff --git a/git-describe.txt b/git-describe.txt index 7a253eaf..2700f35b 100644 --- a/git-describe.txt +++ b/git-describe.txt @@ -21,7 +21,7 @@ object name of the commit. OPTIONS ------- :: - 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/git-ls-tree.html b/git-ls-tree.html index 94a71b3c..caf41d24 100644 --- a/git-ls-tree.html +++ b/git-ls-tree.html @@ -272,9 +272,10 @@ git-ls-tree(1) Manual Page

      SYNOPSIS

      -

      git-ls-tree [-d] [-r] [-t] [-z] - [--name-only] [--name-status] [--full-name] [--abbrev=[<n>]] - <tree-ish> [paths…]

      +
      +
      git-ls-tree [-d] [-r] [-t] [-z] + [--name-only] [--name-status] [--full-name] [--abbrev=[<n>]] + <tree-ish> [paths…]

      DESCRIPTION

      @@ -350,6 +351,15 @@ arguments does not matter.

      +--full-name +
      +
      +

      + Instead of showing the path names relative the current working + directory, show the full path names. +

      +
      +
      paths
      @@ -380,7 +390,6 @@ another major rewrite by Linus Torvalds <torvalds@osdl.org>

      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

      @@ -388,7 +397,7 @@ another major rewrite by Linus Torvalds <torvalds@osdl.org>

      diff --git a/git-ls-tree.txt b/git-ls-tree.txt index 018c4019..7e072b53 100644 --- a/git-ls-tree.txt +++ b/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=[]] - [paths...] + [--name-only] [--name-status] [--full-name] [--abbrev=[]] + [paths...] DESCRIPTION ----------- @@ -47,6 +48,10 @@ OPTIONS lines, show only handful hexdigits prefix. Non default number of digits can be specified with --abbrev=. +--full-name:: + Instead of showing the path names relative 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 . -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/git-name-rev.html b/git-name-rev.html index 7ea2e879..4976fb57 100644 --- a/git-name-rev.html +++ b/git-name-rev.html @@ -272,7 +272,7 @@ git-name-rev(1) Manual Page

      SYNOPSIS

      -

      git-name-rev [--tags] ( --all | --stdin | <commitish>… )

      +

      git-name-rev [--tags] ( --all | --stdin | <committish>… )

      DESCRIPTION

      @@ -342,7 +342,7 @@ not the context.

      diff --git a/git-name-rev.txt b/git-name-rev.txt index ffaa0046..39a1434a 100644 --- a/git-name-rev.txt +++ b/git-name-rev.txt @@ -8,7 +8,7 @@ git-name-rev - Find symbolic names for given revs SYNOPSIS -------- -'git-name-rev' [--tags] ( --all | --stdin | ... ) +'git-name-rev' [--tags] ( --all | --stdin | ... ) DESCRIPTION ----------- diff --git a/git-p4import.html b/git-p4import.html index 11504382..cd9e75a7 100644 --- a/git-p4import.html +++ b/git-p4import.html @@ -421,7 +421,7 @@ 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 their are new changes to incrementally import from the +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 @@ -453,7 +453,7 @@ of mappings with each line containing one mapping in the format:

      diff --git a/git-p4import.txt b/git-p4import.txt index b8ff1e9b..c198ff25 100644 --- a/git-p4import.txt +++ b/git-p4import.txt @@ -128,7 +128,7 @@ 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 their are new changes to incrementally import from the +determines if there are new changes to incrementally import from the Perforce repository. If you import from a repository with many thousands of changes diff --git a/git-read-tree.html b/git-read-tree.html index d159a4cc..5edf6e34 100644 --- a/git-read-tree.html +++ b/git-read-tree.html @@ -590,7 +590,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"`
@@ -649,7 +649,7 @@ have finished your work-in-progress), attempt the merge again.
      diff --git a/git-read-tree.txt b/git-read-tree.txt index 02c7e99f..d894f537 100644 --- a/git-read-tree.txt +++ b/git-read-tree.txt @@ -257,7 +257,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/git-repo-config.html b/git-repo-config.html index c95eef17..2d69a87e 100644 --- a/git-repo-config.html +++ b/git-repo-config.html @@ -619,6 +619,19 @@ core.warnAmbiguousRefs

      +alias.* +
      +
      +

      + Command aliases for the 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, aliases that hide existing git commands are ignored. + Arguments are split at whitespaces, but single or double + quote pair can be used to quote them. +

      +
      +
      apply.whitespace
      @@ -669,7 +682,7 @@ 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.

      @@ -679,7 +692,7 @@ 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.

      @@ -709,7 +722,7 @@ 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.

      @@ -843,7 +856,7 @@ imap diff --git a/git-shortlog.html b/git-shortlog.html index 42676338..41b397c3 100644 --- a/git-shortlog.html +++ b/git-shortlog.html @@ -277,7 +277,31 @@ git-shortlog(1) Manual Page

      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

      @@ -293,7 +317,7 @@ in release announcements.

      diff --git a/git-shortlog.txt b/git-shortlog.txt index 54fb922b..7486ebe7 100644 --- a/git-shortlog.txt +++ b/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 + Eve Jones Author ------ diff --git a/git-tar-tree.html b/git-tar-tree.html index 26b84f65..0cecc683 100644 --- a/git-tar-tree.html +++ b/git-tar-tree.html @@ -3,7 +3,7 @@ - + +git-upload-tar(1) + + + +

      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 git(7) suite

      +
      + + + diff --git a/git-upload-tar.txt b/git-upload-tar.txt new file mode 100644 index 00000000..a1019a02 --- /dev/null +++ b/git-upload-tar.txt @@ -0,0 +1,39 @@ +git-upload-tar(1) +================= + +NAME +---- +git-upload-tar - Send tar archive + + +SYNOPSIS +-------- +'git-upload-tar' + +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 +------- +:: + The repository to get a tar archive from. + +Author +------ +Written by Junio C Hamano + +Documentation +-------------- +Documentation by Junio C Hamano. + +GIT +--- +Part of the gitlink:git[7] suite diff --git a/git.html b/git.html index 7811ef0e..69837495 100644 --- a/git.html +++ b/git.html @@ -283,6 +283,8 @@ and full access to internals.

      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 CVS migration.

      +

      The COMMAND is either a name of a Git command (see below) or an alias +as defined in the configuration file (see git-repo-config(1)).

      OPTIONS

      @@ -742,6 +744,15 @@ the working tree.

      what are asked for.

      +
      +git-upload-tar(1) +
      +
      +

      + Invoked by git-tar-tree --remote to return the tar + archive the other end asked for. +

      +

      High-level commands (porcelain)

      @@ -1091,6 +1102,14 @@ ancillary user utilities.

      +git-quiltimport(1) +
      +
      +

      + Applies a quilt patchset onto the current branch. +

      +
      +
      git-relink(1)
      @@ -2095,7 +2114,7 @@ contributors on the git-list <git@vger.kernel.org>.

      diff --git a/git.txt b/git.txt index 24ca55da..d4472b56 100644 --- a/git.txt +++ b/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/glossary.html b/glossary.html index 0c45a4f7..303893e0 100644 --- a/glossary.html +++ b/glossary.html @@ -497,6 +497,18 @@ div.exampleblock-content {

      +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
      @@ -938,7 +950,7 @@ the git-list <git@vger.kernel.org>.

      diff --git a/glossary.txt b/glossary.txt index 39c90ad7..116ddb7f 100644 --- a/glossary.txt +++ b/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/hooks.html b/hooks.html index 657211b9..04f074c8 100644 --- a/hooks.html +++ b/hooks.html @@ -345,7 +345,7 @@ send out a commit notification e-mail.

      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 determines 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 three parameters: @@ -393,7 +393,7 @@ you can redirect your output to your stderr.

      diff --git a/hooks.txt b/hooks.txt index e3dde391..898b4aaf 100644 --- a/hooks.txt +++ b/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 determines 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 diff --git a/tutorial.html b/tutorial.html index cfa8273e..6ef57a76 100644 --- a/tutorial.html +++ b/tutorial.html @@ -565,7 +565,7 @@ names. For example:

      $ 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 in the working directory, it will also remove all later commits from @@ -701,7 +701,7 @@ digressions that may be interesting at this point are:

      diff --git a/tutorial.txt b/tutorial.txt index db563127..554ee0af 100644 --- a/tutorial.txt +++ b/tutorial.txt @@ -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