diff options
Diffstat (limited to 'Documentation')
33 files changed, 89 insertions, 61 deletions
diff --git a/Documentation/cvs-migration.txt b/Documentation/cvs-migration.txt index dc9387b..8fd1a33 100644 --- a/Documentation/cvs-migration.txt +++ b/Documentation/cvs-migration.txt @@ -138,7 +138,7 @@ mailing list archives for details). git has a couple of alternatives, though, that you may find sufficient or even superior depending on your use. One is called "git-whatchanged" (for obvious reasons) and the other one is called "pickaxe" ("a tool for -the software archeologist"). +the software archaeologist"). The "git-whatchanged" script is a truly trivial script that can give you a good overview of what has changed in a file or a directory (or an diff --git a/Documentation/diff-format.txt b/Documentation/diff-format.txt index 97756ec..0398b40 100644 --- a/Documentation/diff-format.txt +++ b/Documentation/diff-format.txt @@ -117,7 +117,7 @@ git specific extension to diff format What -p option produces is slightly different from the traditional diff format. -1. It is preceeded with a "git diff" header, that looks like +1. It is preceded with a "git diff" header, that looks like this: diff --git a/file1 b/file2 diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt index 9e574a0..5c85167 100644 --- a/Documentation/diff-options.txt +++ b/Documentation/diff-options.txt @@ -21,7 +21,7 @@ --abbrev[=<n>]:: Instead of showing the full 40-byte hexadecimal object name in diff-raw format output and diff-tree header - lines, show only handful dhexigits prefix. This is + lines, show only handful hexdigits prefix. This is independent of --full-index option above, which controls the diff-patch output format. Non default number of digits can be specified with --abbrev=<n>. diff --git a/Documentation/git-add.txt b/Documentation/git-add.txt index 4cae412..89e4614 100644 --- a/Documentation/git-add.txt +++ b/Documentation/git-add.txt @@ -31,7 +31,7 @@ DISCUSSION ---------- The list of <file> given to the command is fed to `git-ls-files` -command to list files that are not registerd in the index and +command to list files that are not registered in the index and are not ignored/excluded by `$GIT_DIR/info/exclude` file or `.gitignore` file in each directory. This means two things: diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt index a415fe2..02cabc9 100644 --- a/Documentation/git-am.txt +++ b/Documentation/git-am.txt @@ -8,6 +8,7 @@ git-am - Apply a series of patches in a mailbox SYNOPSIS -------- +[verse] 'git-am' [--signoff] [--dotest=<dir>] [--utf8] [--binary] [--3way] <mbox>... 'git-am' [--skip | --resolved] diff --git a/Documentation/git-apply.txt b/Documentation/git-apply.txt index 626e281..51c7d47 100644 --- a/Documentation/git-apply.txt +++ b/Documentation/git-apply.txt @@ -8,7 +8,10 @@ git-apply - Apply patch on a git index file and a work tree SYNOPSIS -------- -'git-apply' [--stat] [--numstat] [--summary] [--check] [--index] [--apply] [--no-add] [--index-info] [--allow-binary-replacement] [-z] [<patch>...] +[verse] +'git-apply' [--stat] [--numstat] [--summary] [--check] [--index] [--apply] + [--no-add] [--index-info] [--allow-binary-replacement] [-z] + [<patch>...] DESCRIPTION ----------- diff --git a/Documentation/git-archimport.txt b/Documentation/git-archimport.txt index a2bd788..023d3ae 100644 --- a/Documentation/git-archimport.txt +++ b/Documentation/git-archimport.txt @@ -8,15 +8,15 @@ git-archimport - Import an Arch repository into git SYNOPSIS -------- -`git-archimport` [ -h ] [ -v ] [ -o ] [ -a ] [ -f ] [ -T ] - [ -D depth ] [ -t tempdir ] - <archive/branch> [ <archive/branch> ] +[verse] +`git-archimport` [-h] [-v] [-o] [-a] [-f] [-T] [-D depth] [-t tempdir] + <archive/branch> [ <archive/branch> ] DESCRIPTION ----------- Imports a project from one or more Arch repositories. It will follow branches and repositories within the namespaces defined by the <archive/branch> -parameters suppplied. If it cannot find the remote branch a merge comes from +parameters supplied. If it cannot find the remote branch a merge comes from it will just import it as a regular commit. If it can find it, it will mark it as a merge whenever possible (see discussion below). diff --git a/Documentation/git-cat-file.txt b/Documentation/git-cat-file.txt index 9a7700f..504eb1b 100644 --- a/Documentation/git-cat-file.txt +++ b/Documentation/git-cat-file.txt @@ -8,7 +8,7 @@ git-cat-file - Provide content or type information for repository objects SYNOPSIS -------- -'git-cat-file' (-t | -s | -e | <type>) <object> +'git-cat-file' [-t | -s | -e | <type>] <object> DESCRIPTION ----------- diff --git a/Documentation/git-checkout-index.txt b/Documentation/git-checkout-index.txt index 9f32c65..2a1e526 100644 --- a/Documentation/git-checkout-index.txt +++ b/Documentation/git-checkout-index.txt @@ -8,8 +8,9 @@ git-checkout-index - Copy files from the index to the working directory SYNOPSIS -------- +[verse] 'git-checkout-index' [-u] [-q] [-a] [-f] [-n] [--prefix=<string>] - [--stage=<number>] [--] <file>... + [--stage=<number>] [--] <file>... DESCRIPTION ----------- diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt index 8410a6d..ffa4fb0 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt @@ -8,7 +8,9 @@ git-clone - Clones a repository. SYNOPSIS -------- -'git-clone' [-l [-s]] [-q] [-n] [-u <upload-pack>] <repository> [<directory>] +[verse] +'git-clone' [-l [-s]] [-q] [-n] [-u <upload-pack>] + <repository> [<directory>] DESCRIPTION ----------- diff --git a/Documentation/git-commit-tree.txt b/Documentation/git-commit-tree.txt index a794192..41d1a1c 100644 --- a/Documentation/git-commit-tree.txt +++ b/Documentation/git-commit-tree.txt @@ -60,7 +60,8 @@ either `.git/config` file, or using the following environment variables. (nb "<", ">" and "\n"s are stripped) -In `.git/config` file, the following items are used: +In `.git/config` file, the following items are used for GIT_AUTHOR_NAME and +GIT_AUTHOR_EMAIL: [user] name = "Your Name" diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index 8b91f22..e0ff74f 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt @@ -7,7 +7,9 @@ git-commit - Record your changes SYNOPSIS -------- -'git-commit' [-a] [-s] [-v] [(-c | -C) <commit> | -F <file> | -m <msg>] [-e] [--] <file>... +[verse] +'git-commit' [-a] [-s] [-v] [(-c | -C) <commit> | -F <file> | -m <msg>] + [-e] [--] <file>... DESCRIPTION ----------- diff --git a/Documentation/git-cvsexportcommit.txt b/Documentation/git-cvsexportcommit.txt index 91def2b..13cbf3b 100644 --- a/Documentation/git-cvsexportcommit.txt +++ b/Documentation/git-cvsexportcommit.txt @@ -8,8 +8,7 @@ git-cvsexportcommit - Export a commit to a CVS checkout SYNOPSIS -------- -git-cvsexportcommmit.perl - [ -h ] [ -v ] [ -c ] [ -p ] [PARENTCOMMIT] COMMITID +'git-cvsexportcommmit' [-h] [-v] [-c] [-p] [PARENTCOMMIT] COMMITID DESCRIPTION diff --git a/Documentation/git-cvsimport.txt b/Documentation/git-cvsimport.txt index f89b251..01ca7ef 100644 --- a/Documentation/git-cvsimport.txt +++ b/Documentation/git-cvsimport.txt @@ -8,10 +8,10 @@ git-cvsimport - Import a CVS repository into git SYNOPSIS -------- -'git-cvsimport' [ -o <branch-for-HEAD> ] [ -h ] [ -v ] - [ -d <CVSROOT> ] [ -p <options-for-cvsps> ] - [ -C <git_repository> ] [ -i ] [ -P <file> ] [ -k ] - [ -s <subst> ] [ -m ] [ -M regex ] [ <CVS_module> ] +[verse] +'git-cvsimport' [-o <branch-for-HEAD>] [-h] [-v] [-d <CVSROOT>] [-s <subst>] + [-p <options-for-cvsps>] [-C <git_repository>] [-i] [-P <file>] + [-m] [-M regex] [<CVS_module>] DESCRIPTION diff --git a/Documentation/git-daemon.txt b/Documentation/git-daemon.txt index 2a8f371..33f3320 100644 --- a/Documentation/git-daemon.txt +++ b/Documentation/git-daemon.txt @@ -7,8 +7,9 @@ git-daemon - A really simple server for git repositories. SYNOPSIS -------- +[verse] 'git-daemon' [--verbose] [--syslog] [--inetd | --port=n] [--export-all] - [--timeout=n] [--init-timeout=n] [--strict-paths] [directory...] + [--timeout=n] [--init-timeout=n] [--strict-paths] [directory...] DESCRIPTION ----------- diff --git a/Documentation/git-diff-index.txt b/Documentation/git-diff-index.txt index dba6d30..5d2096a 100644 --- a/Documentation/git-diff-index.txt +++ b/Documentation/git-diff-index.txt @@ -53,7 +53,7 @@ If '--cached' is specified, it allows you to ask: contents (the ones I'd write with a "git-write-tree") For example, let's say that you have worked on your working directory, updated -some files in the index and are ready to commit. You want to see eactly +some files in the index and are ready to commit. You want to see exactly *what* you are going to commit is without having to write a new tree object and compare it that way, and to do that, you just do @@ -110,7 +110,7 @@ NOTE: As with other commands of this type, "git-diff-index" does not actually look at the contents of the file at all. So maybe `kernel/sched.c` hasn't actually changed, and it's just that you touched it. In either case, it's a note that you need to -"git-upate-index" it to make the index be in sync. +"git-update-index" it to make the index be in sync. NOTE: You can have a mixture of files show up as "has been updated" and "is still dirty in the working directory" together. You can always diff --git a/Documentation/git-diff-tree.txt b/Documentation/git-diff-tree.txt index 9a2947e..91fb130 100644 --- a/Documentation/git-diff-tree.txt +++ b/Documentation/git-diff-tree.txt @@ -8,7 +8,9 @@ git-diff-tree - Compares the content and mode of blobs found via two tree object SYNOPSIS -------- -'git-diff-tree' [--stdin] [-m] [-s] [-v] [--no-commit-id] [--pretty] [-t] [-r] [--root] [<common diff options>] <tree-ish> [<tree-ish>] [<path>...] +[verse] +'git-diff-tree' [--stdin] [-m] [-s] [-v] [--no-commit-id] [--pretty] [-t] [-r] + [--root] [<common diff options>] <tree-ish> [<tree-ish>] [<path>...] DESCRIPTION ----------- @@ -62,7 +64,7 @@ separated with a single space are given. -s:: By default, "git-diff-tree --stdin" shows differences, either in machine-readable form (without '-p') or in patch - form (with '-p'). This output can be supressed. It is + form (with '-p'). This output can be suppressed. It is only useful with '-v' flag. -v:: diff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt index b04f393..ca41634 100644 --- a/Documentation/git-diff.txt +++ b/Documentation/git-diff.txt @@ -67,7 +67,7 @@ $ git diff HEAD^ HEAD <3> <1> instead of using the tip of the current branch, compare with the tip of "test" branch. <2> instead of comparing with the tip of "test" branch, compare with -the tip of the curren branch, but limit the comparison to the +the tip of the current branch, but limit the comparison to the file "test". <3> compare the version before the last commit and the last commit. ------------ diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt index d7ca2db..47705de 100644 --- a/Documentation/git-format-patch.txt +++ b/Documentation/git-format-patch.txt @@ -8,7 +8,9 @@ git-format-patch - Prepare patches for e-mail submission. SYNOPSIS -------- -'git-format-patch' [-n | -k] [-o <dir> | --stdout] [-s] [-c] [--mbox] [--diff-options] <his> [<mine>] +[verse] +'git-format-patch' [-n | -k] [-o <dir> | --stdout] [-s] [-c] [--mbox] + [--diff-options] <his> [<mine>] DESCRIPTION ----------- @@ -96,7 +98,7 @@ git-format-patch -M -B origin:: See Also -------- -gitlink:git-am[1], gitlink:git-send-email +gitlink:git-am[1], gitlink:git-send-email[1] Author diff --git a/Documentation/git-fsck-objects.txt b/Documentation/git-fsck-objects.txt index bab1f60..387b435 100644 --- a/Documentation/git-fsck-objects.txt +++ b/Documentation/git-fsck-objects.txt @@ -8,7 +8,9 @@ git-fsck-objects - Verifies the connectivity and validity of the objects in the SYNOPSIS -------- -'git-fsck-objects' [--tags] [--root] [--unreachable] [--cache] [--standalone | --full] [--strict] [<object>*] +[verse] +'git-fsck-objects' [--tags] [--root] [--unreachable] [--cache] + [--standalone | --full] [--strict] [<object>*] DESCRIPTION ----------- diff --git a/Documentation/git-grep.txt b/Documentation/git-grep.txt index 0175793..2bfd8ed 100644 --- a/Documentation/git-grep.txt +++ b/Documentation/git-grep.txt @@ -8,7 +8,7 @@ git-grep - print lines matching a pattern SYNOPSIS -------- -'git-grep' <option>... <pattern> <path>... +'git-grep' [<option>...] <pattern> [<path>...] DESCRIPTION ----------- @@ -27,7 +27,6 @@ OPTIONS The pattern to look for. <path>...:: - Optional paths to limit the set of files to be searched; passed to `git-ls-files`. diff --git a/Documentation/git-http-fetch.txt b/Documentation/git-http-fetch.txt index 1116e85..bc1a132 100644 --- a/Documentation/git-http-fetch.txt +++ b/Documentation/git-http-fetch.txt @@ -3,12 +3,12 @@ git-http-fetch(1) NAME ---- -git-http-fetch - Downloads a remote git repository via HTTP +git-http-fetch - downloads a remote git repository via HTTP SYNOPSIS -------- -'git-http-fetch' [-c] [-t] [-a] [-d] [-v] [-w filename] [--recover] commit-id url +'git-http-fetch' [-c] [-t] [-a] [-d] [-v] [-w filename] [--recover] <commit> <url> DESCRIPTION ----------- diff --git a/Documentation/git-init-db.txt b/Documentation/git-init-db.txt index 6deef92..ea4d849 100644 --- a/Documentation/git-init-db.txt +++ b/Documentation/git-init-db.txt @@ -8,7 +8,7 @@ git-init-db - Creates an empty git repository SYNOPSIS -------- -'git-init-db' [--template=<template_directory>] +'git-init-db' [--template=<template_directory>] [--shared] OPTIONS @@ -16,6 +16,9 @@ OPTIONS --template=<template_directory>:: Provide the directory in from which templates will be used. +--shared:: + Specify that the git repository is to be shared amongst several users. + DESCRIPTION ----------- @@ -30,7 +33,16 @@ If the object storage directory is specified via the `$GIT_OBJECT_DIRECTORY` environment variable then the sha1 directories are created underneath - otherwise the default `$GIT_DIR/objects` directory is used. -`git-init-db` won't hurt an existing repository. +A shared repository allows users belonging to the same group to push into that +repository. When specifying `--shared` the config variable "core.sharedRepository" +is set to 'true' so that directories under `$GIT_DIR` are made group writable +(and g+sx, since the git group may be not the primary group of all users). + + +Running `git-init-db` in an existing repository is safe. It will not overwrite +things that are already there. The primary reason for rerunning `git-init-db` +is to pick up newly added templates. + EXAMPLES diff --git a/Documentation/git-ls-files.txt b/Documentation/git-ls-files.txt index 186f3bb..e42af5e 100644 --- a/Documentation/git-ls-files.txt +++ b/Documentation/git-ls-files.txt @@ -74,7 +74,7 @@ OPTIONS H:: cached M:: unmerged R:: removed/deleted - C:: modifed/changed + C:: modified/changed K:: to be killed ? other diff --git a/Documentation/git-pack-objects.txt b/Documentation/git-pack-objects.txt index 009ec5a..2d67d39 100644 --- a/Documentation/git-pack-objects.txt +++ b/Documentation/git-pack-objects.txt @@ -46,7 +46,7 @@ base-name:: output of the command. --stdout:: - Write the pack contents (what would have been writtin to + Write the pack contents (what would have been written to .pack file) out to the standard output. --window and --depth:: diff --git a/Documentation/git-repo-config.txt b/Documentation/git-repo-config.txt index 5eefe02..3069464 100644 --- a/Documentation/git-repo-config.txt +++ b/Documentation/git-repo-config.txt @@ -21,9 +21,9 @@ You can query/set/replace/unset options with this command. The name is actually the section and the key separated by a dot, and the value will be escaped. -If you want to set/unset an option which can occor on multiple lines, you +If you want to set/unset an option which can occur on multiple lines, you should provide a POSIX regex for the value. If you want to handle the lines -*not* matching the regex, just prepend a single exlamation mark in front +*not* matching the regex, just prepend a single exclamation mark in front (see EXAMPLES). This command will fail if diff --git a/Documentation/git-rev-list.txt b/Documentation/git-rev-list.txt index 064ccb1..f9146f1 100644 --- a/Documentation/git-rev-list.txt +++ b/Documentation/git-rev-list.txt @@ -8,18 +8,19 @@ git-rev-list - Lists commit objects in reverse chronological order SYNOPSIS -------- +[verse] 'git-rev-list' [ \--max-count=number ] - [ \--max-age=timestamp ] - [ \--min-age=timestamp ] - [ \--sparse ] - [ \--no-merges ] - [ \--all ] - [ [ \--merge-order [ \--show-breaks ] ] | [ \--topo-order ] | ] - [ \--parents ] - [ \--objects [ \--unpacked ] ] - [ \--pretty | \--header | ] - [ \--bisect ] - <commit>... [ \-- <paths>... ] + [ \--max-age=timestamp ] + [ \--min-age=timestamp ] + [ \--sparse ] + [ \--no-merges ] + [ \--all ] + [ [ \--merge-order [ \--show-breaks ] ] | [ \--topo-order ] ] + [ \--parents ] + [ \--objects [ \--unpacked ] ] + [ \--pretty | \--header ] + [ \--bisect ] + <commit>... [ \-- <paths>... ] DESCRIPTION ----------- @@ -129,7 +130,7 @@ the marked commit in the list. + Commits marked with (^) are not parents of the immediately preceding commit. These "breaks" represent necessary discontinuities implied by trying to -represent an arbtirary DAG in a linear form. +represent an arbitrary DAG in a linear form. + `--show-breaks` is only valid if `--merge-order` is also specified. diff --git a/Documentation/git-show-branch.txt b/Documentation/git-show-branch.txt index ffe64d8..5b76f3b 100644 --- a/Documentation/git-show-branch.txt +++ b/Documentation/git-show-branch.txt @@ -85,7 +85,7 @@ Following these N lines, one-line log for each commit is displayed, indented N places. If a commit is on the I-th branch, the I-th indentation character shows a '+' sign; otherwise it shows a space. Each commit shows a short name that -can be used as an exended SHA1 to name that commit. +can be used as an extended SHA1 to name that commit. The following example shows three branches, "master", "fixes" and "mhf": diff --git a/Documentation/git-svnimport.txt b/Documentation/git-svnimport.txt index f8dbee7..db1ce38 100644 --- a/Documentation/git-svnimport.txt +++ b/Documentation/git-svnimport.txt @@ -11,7 +11,7 @@ SYNOPSIS -------- 'git-svnimport' [ -o <branch-for-HEAD> ] [ -h ] [ -v ] [ -d | -D ] [ -C <GIT_repository> ] [ -i ] [ -u ] [-l limit_rev] - [ -b branch_subdir ] [ -t trunk_subdir ] [ -T tag_subdir ] + [ -b branch_subdir ] [ -T trunk_subdir ] [ -t tag_subdir ] [ -s start_chg ] [ -m ] [ -M regex ] <SVN_repository_URL> [ <path> ] @@ -40,17 +40,17 @@ OPTIONS -s <start_rev>:: Start importing at this SVN change number. The default is 1. + -When importing incementally, you might need to edit the .git/svn2git file. +When importing incrementally, you might need to edit the .git/svn2git file. -i:: Import-only: don't perform a checkout after importing. This option ensures the working directory and index remain untouched and will not create them if they do not exist. --t <trunk_subdir>:: +-T <trunk_subdir>:: Name the SVN trunk. Default "trunk". --T <tag_subdir>:: +-t <tag_subdir>:: Name the SVN subdirectory for tags. Default "tags". -b <branch_subdir>:: diff --git a/Documentation/git.txt b/Documentation/git.txt index 5f068c2..875d487 100644 --- a/Documentation/git.txt +++ b/Documentation/git.txt @@ -422,7 +422,7 @@ gitlink:git-rev-parse[1]:: gitlink:git-send-email[1]:: Send patch e-mails out of "format-patch --mbox" output. -gitlink:git-symbolic-refs[1]:: +gitlink:git-symbolic-ref[1]:: Read and modify symbolic refs. gitlink:git-stripspace[1]:: diff --git a/Documentation/glossary.txt b/Documentation/glossary.txt index 520f4c5..2331be5 100644 --- a/Documentation/glossary.txt +++ b/Documentation/glossary.txt @@ -19,7 +19,7 @@ hash:: In git's context, synonym to object name. object database:: - Stores a set of "objects", and an individial object is identified + Stores a set of "objects", and an individual object is identified by its object name. The objects usually live in `$GIT_DIR/objects/`. blob object:: diff --git a/Documentation/howto/isolate-bugs-with-bisect.txt b/Documentation/howto/isolate-bugs-with-bisect.txt index 4009495..edbcd4c 100644 --- a/Documentation/howto/isolate-bugs-with-bisect.txt +++ b/Documentation/howto/isolate-bugs-with-bisect.txt @@ -24,7 +24,7 @@ Then do git bisect bad master <- mark "master" as the bad state git bisect good ORIG_HEAD <- mark ORIG_HEAD as good (or whatever other known-good - thing you booted laste) + thing you booted last) and at this point "git bisect" will churn for a while, and tell you what the mid-point between those two commits are, and check that state out as diff --git a/Documentation/repository-layout.txt b/Documentation/repository-layout.txt index 1b5f228..0347cab 100644 --- a/Documentation/repository-layout.txt +++ b/Documentation/repository-layout.txt @@ -21,7 +21,7 @@ outside world but sometimes useful for private repository. . You can be using `objects/info/alternates` mechanism, or `$GIT_ALTERNATE_OBJECT_DIRECTORIES` mechanism to 'borrow' objects from other object stores. A repository with this kind -of incompete object store is not suitable to be published for +of incomplete object store is not suitable to be published for use with dumb transports but otherwise is OK as long as `objects/info/alternates` points at the right object stores it borrows from. @@ -106,7 +106,7 @@ info/refs:: up-to-date if the repository is published for dumb transports. The `git-receive-pack` command, which is run on a remote repository when you `git push` into it, - runs `hooks/update` hook to help you achive this. + runs `hooks/update` hook to help you achieve this. info/grafts:: This file records fake commit ancestry information, to |