Documentation: Correct various misspellings and typos.
Fix minor typos throughout the documentation. Signed-off-by: Brian Hetro <whee@smaertness.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>maint
parent
db21872395
commit
027830755d
|
@ -283,7 +283,7 @@ core.excludesfile::
|
||||||
|
|
||||||
core.editor::
|
core.editor::
|
||||||
Commands such as `commit` and `tag` that lets you edit
|
Commands such as `commit` and `tag` that lets you edit
|
||||||
messages by lauching an editor uses the value of this
|
messages by launching an editor uses the value of this
|
||||||
variable when it is set, and the environment variable
|
variable when it is set, and the environment variable
|
||||||
`GIT_EDITOR` is not set. The order of preference is
|
`GIT_EDITOR` is not set. The order of preference is
|
||||||
`GIT_EDITOR` environment, `core.editor`, `VISUAL` and
|
`GIT_EDITOR` environment, `core.editor`, `VISUAL` and
|
||||||
|
@ -500,10 +500,10 @@ gitcvs.dbuser, gitcvs.dbpass::
|
||||||
'gitcvs.dbuser' supports variable substitution (see
|
'gitcvs.dbuser' supports variable substitution (see
|
||||||
gitlink:git-cvsserver[1] for details).
|
gitlink:git-cvsserver[1] for details).
|
||||||
|
|
||||||
All gitcvs variables except for 'gitcvs.allbinary' can also specifed
|
All gitcvs variables except for 'gitcvs.allbinary' can also be
|
||||||
as 'gitcvs.<access_method>.<varname>' (where 'access_method' is one
|
specified as 'gitcvs.<access_method>.<varname>' (where 'access_method'
|
||||||
of "ext" and "pserver") to make them apply only for the given access
|
is one of "ext" and "pserver") to make them apply only for the given
|
||||||
method.
|
access method.
|
||||||
|
|
||||||
http.sslVerify::
|
http.sslVerify::
|
||||||
Whether to verify the SSL certificate when fetching or pushing
|
Whether to verify the SSL certificate when fetching or pushing
|
||||||
|
@ -615,7 +615,7 @@ pack.compression::
|
||||||
not set, defaults to -1.
|
not set, defaults to -1.
|
||||||
|
|
||||||
pack.deltaCacheSize::
|
pack.deltaCacheSize::
|
||||||
The maxium memory in bytes used for caching deltas in
|
The maximum memory in bytes used for caching deltas in
|
||||||
gitlink:git-pack-objects[1].
|
gitlink:git-pack-objects[1].
|
||||||
A value of 0 means no limit. Defaults to 0.
|
A value of 0 means no limit. Defaults to 0.
|
||||||
|
|
||||||
|
|
|
@ -52,7 +52,7 @@ A commit encapsulates:
|
||||||
- committer name and email and the commit time.
|
- committer name and email and the commit time.
|
||||||
|
|
||||||
While parent object ids are provided on the command line, author and
|
While parent object ids are provided on the command line, author and
|
||||||
commiter information is taken from the following environment variables,
|
committer information is taken from the following environment variables,
|
||||||
if set:
|
if set:
|
||||||
|
|
||||||
GIT_AUTHOR_NAME
|
GIT_AUTHOR_NAME
|
||||||
|
|
|
@ -139,7 +139,7 @@ See also <<FILES>>.
|
||||||
FILES
|
FILES
|
||||||
-----
|
-----
|
||||||
|
|
||||||
If not set explicitely with '--file', there are three files where
|
If not set explicitly with '--file', there are three files where
|
||||||
git-config will search for configuration options:
|
git-config will search for configuration options:
|
||||||
|
|
||||||
.git/config::
|
.git/config::
|
||||||
|
|
|
@ -241,7 +241,7 @@ been well tested in the wild.
|
||||||
+
|
+
|
||||||
Frontends should prefer the `raw` format if the source material
|
Frontends should prefer the `raw` format if the source material
|
||||||
already uses UNIX-epoch format, can be coaxed to give dates in that
|
already uses UNIX-epoch format, can be coaxed to give dates in that
|
||||||
format, or its format is easiliy convertible to it, as there is no
|
format, or its format is easily convertible to it, as there is no
|
||||||
ambiguity in parsing.
|
ambiguity in parsing.
|
||||||
|
|
||||||
`now`::
|
`now`::
|
||||||
|
@ -343,7 +343,7 @@ Zero or more `filemodify`, `filedelete`, `filecopy`, `filerename`
|
||||||
and `filedeleteall` commands
|
and `filedeleteall` commands
|
||||||
may be included to update the contents of the branch prior to
|
may be included to update the contents of the branch prior to
|
||||||
creating the commit. These commands may be supplied in any order.
|
creating the commit. These commands may be supplied in any order.
|
||||||
However it is recommended that a `filedeleteall` command preceed
|
However it is recommended that a `filedeleteall` command precede
|
||||||
all `filemodify`, `filecopy` and `filerename` commands in the same
|
all `filemodify`, `filecopy` and `filerename` commands in the same
|
||||||
commit, as `filedeleteall`
|
commit, as `filedeleteall`
|
||||||
wipes the branch clean (see below).
|
wipes the branch clean (see below).
|
||||||
|
@ -402,7 +402,7 @@ Here `<committish>` is any of the following:
|
||||||
+
|
+
|
||||||
The reason fast-import uses `:` to denote a mark reference is this character
|
The reason fast-import uses `:` to denote a mark reference is this character
|
||||||
is not legal in a Git branch name. The leading `:` makes it easy
|
is not legal in a Git branch name. The leading `:` makes it easy
|
||||||
to distingush between the mark 42 (`:42`) and the branch 42 (`42`
|
to distinguish between the mark 42 (`:42`) and the branch 42 (`42`
|
||||||
or `refs/heads/42`), or an abbreviated SHA-1 which happened to
|
or `refs/heads/42`), or an abbreviated SHA-1 which happened to
|
||||||
consist only of base-10 digits.
|
consist only of base-10 digits.
|
||||||
+
|
+
|
||||||
|
@ -487,7 +487,7 @@ start with double quote (`"`).
|
||||||
If an `LF` or double quote must be encoded into `<path>` shell-style
|
If an `LF` or double quote must be encoded into `<path>` shell-style
|
||||||
quoting should be used, e.g. `"path/with\n and \" in it"`.
|
quoting should be used, e.g. `"path/with\n and \" in it"`.
|
||||||
|
|
||||||
The value of `<path>` must be in canoncial form. That is it must not:
|
The value of `<path>` must be in canonical form. That is it must not:
|
||||||
|
|
||||||
* contain an empty directory component (e.g. `foo//bar` is invalid),
|
* contain an empty directory component (e.g. `foo//bar` is invalid),
|
||||||
* end with a directory separator (e.g. `foo/` is invalid),
|
* end with a directory separator (e.g. `foo/` is invalid),
|
||||||
|
@ -733,7 +733,7 @@ of the next line, even if `<raw>` did not end with an `LF`.
|
||||||
Delimited format::
|
Delimited format::
|
||||||
A delimiter string is used to mark the end of the data.
|
A delimiter string is used to mark the end of the data.
|
||||||
fast-import will compute the length by searching for the delimiter.
|
fast-import will compute the length by searching for the delimiter.
|
||||||
This format is primarly useful for testing and is not
|
This format is primarily useful for testing and is not
|
||||||
recommended for real data.
|
recommended for real data.
|
||||||
+
|
+
|
||||||
....
|
....
|
||||||
|
@ -873,7 +873,7 @@ to remove the dummy branch.
|
||||||
Import Now, Repack Later
|
Import Now, Repack Later
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
As soon as fast-import completes the Git repository is completely valid
|
As soon as fast-import completes the Git repository is completely valid
|
||||||
and ready for use. Typicallly this takes only a very short time,
|
and ready for use. Typically this takes only a very short time,
|
||||||
even for considerably large projects (100,000+ commits).
|
even for considerably large projects (100,000+ commits).
|
||||||
|
|
||||||
However repacking the repository is necessary to improve data
|
However repacking the repository is necessary to improve data
|
||||||
|
@ -942,8 +942,8 @@ Memory Utilization
|
||||||
------------------
|
------------------
|
||||||
There are a number of factors which affect how much memory fast-import
|
There are a number of factors which affect how much memory fast-import
|
||||||
requires to perform an import. Like critical sections of core
|
requires to perform an import. Like critical sections of core
|
||||||
Git, fast-import uses its own memory allocators to ammortize any overheads
|
Git, fast-import uses its own memory allocators to amortize any overheads
|
||||||
associated with malloc. In practice fast-import tends to ammoritize any
|
associated with malloc. In practice fast-import tends to amortize any
|
||||||
malloc overheads to 0, due to its use of large block allocations.
|
malloc overheads to 0, due to its use of large block allocations.
|
||||||
|
|
||||||
per object
|
per object
|
||||||
|
@ -1000,7 +1000,7 @@ per active tree
|
||||||
~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~
|
||||||
Trees (aka directories) use just 12 bytes of memory on top of the
|
Trees (aka directories) use just 12 bytes of memory on top of the
|
||||||
memory required for their entries (see ``per active file'' below).
|
memory required for their entries (see ``per active file'' below).
|
||||||
The cost of a tree is virtually 0, as its overhead ammortizes out
|
The cost of a tree is virtually 0, as its overhead amortizes out
|
||||||
over the individual file entries.
|
over the individual file entries.
|
||||||
|
|
||||||
per active file entry
|
per active file entry
|
||||||
|
|
|
@ -10,7 +10,7 @@ SYNOPSIS
|
||||||
--------
|
--------
|
||||||
[verse]
|
[verse]
|
||||||
git-fmt-merge-msg [--summary | --no-summary] <$GIT_DIR/FETCH_HEAD
|
git-fmt-merge-msg [--summary | --no-summary] <$GIT_DIR/FETCH_HEAD
|
||||||
git-fmt-merge-msg [--summary | --no-summray] -F <file>
|
git-fmt-merge-msg [--summary | --no-summary] -F <file>
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
|
|
|
@ -118,7 +118,7 @@ include::diff-options.txt[]
|
||||||
|
|
||||||
--suffix=.<sfx>::
|
--suffix=.<sfx>::
|
||||||
Instead of using `.patch` as the suffix for generated
|
Instead of using `.patch` as the suffix for generated
|
||||||
filenames, use specifed suffix. A common alternative is
|
filenames, use specified suffix. A common alternative is
|
||||||
`--suffix=.txt`.
|
`--suffix=.txt`.
|
||||||
+
|
+
|
||||||
Note that you would need to include the leading dot `.` if you
|
Note that you would need to include the leading dot `.` if you
|
||||||
|
|
|
@ -89,7 +89,7 @@ See Also
|
||||||
Other
|
Other
|
||||||
-----
|
-----
|
||||||
git-gui is actually maintained as an independent project, but stable
|
git-gui is actually maintained as an independent project, but stable
|
||||||
versions are distributed as part of the Git suite for the convience
|
versions are distributed as part of the Git suite for the convenience
|
||||||
of end users.
|
of end users.
|
||||||
|
|
||||||
A git-gui development repository can be obtained from:
|
A git-gui development repository can be obtained from:
|
||||||
|
|
|
@ -34,7 +34,7 @@ commit-id::
|
||||||
the local end after the transfer is complete.
|
the local end after the transfer is complete.
|
||||||
|
|
||||||
--stdin::
|
--stdin::
|
||||||
Instead of a commit id on the commandline (which is not expected in this
|
Instead of a commit id on the command line (which is not expected in this
|
||||||
case), 'git-http-fetch' expects lines on stdin in the format
|
case), 'git-http-fetch' expects lines on stdin in the format
|
||||||
|
|
||||||
<commit-id>['\t'<filename-as-in--w>]
|
<commit-id>['\t'<filename-as-in--w>]
|
||||||
|
|
|
@ -44,7 +44,7 @@ OPTIONS
|
||||||
the local end after the transfer is complete.
|
the local end after the transfer is complete.
|
||||||
|
|
||||||
--stdin::
|
--stdin::
|
||||||
Instead of a commit id on the commandline (which is not expected in this
|
Instead of a commit id on the command line (which is not expected in this
|
||||||
case), 'git-local-fetch' expects lines on stdin in the format
|
case), 'git-local-fetch' expects lines on stdin in the format
|
||||||
|
|
||||||
<commit-id>['\t'<filename-as-in--w>]
|
<commit-id>['\t'<filename-as-in--w>]
|
||||||
|
|
|
@ -37,7 +37,7 @@ OPTIONS
|
||||||
--name-only::
|
--name-only::
|
||||||
Instead of printing both the SHA-1 and the name, print only
|
Instead of printing both the SHA-1 and the name, print only
|
||||||
the name. If given with --tags the usual tag prefix of
|
the name. If given with --tags the usual tag prefix of
|
||||||
"tags/" is also ommitted from the name, matching the output
|
"tags/" is also omitted from the name, matching the output
|
||||||
of gitlink::git-describe[1] more closely. This option
|
of gitlink::git-describe[1] more closely. This option
|
||||||
cannot be combined with --stdin.
|
cannot be combined with --stdin.
|
||||||
|
|
||||||
|
|
|
@ -78,7 +78,7 @@ The hook should exit with non-zero status if it wants to disallow
|
||||||
updating the named ref. Otherwise it should exit with zero.
|
updating the named ref. Otherwise it should exit with zero.
|
||||||
|
|
||||||
Successful execution (a zero exit status) of this hook does not
|
Successful execution (a zero exit status) of this hook does not
|
||||||
ensure the ref will actully be updated, it is only a prerequisite.
|
ensure the ref will actually be updated, it is only a prerequisite.
|
||||||
As such it is not a good idea to send notices (e.g. email) from
|
As such it is not a good idea to send notices (e.g. email) from
|
||||||
this hook. Consider using the post-receive hook instead.
|
this hook. Consider using the post-receive hook instead.
|
||||||
|
|
||||||
|
|
|
@ -30,7 +30,7 @@ Entries older than `expire` time, or entries older than
|
||||||
tip, are removed from the reflog. This is typically not used
|
tip, are removed from the reflog. This is typically not used
|
||||||
directly by the end users -- instead, see gitlink:git-gc[1].
|
directly by the end users -- instead, see gitlink:git-gc[1].
|
||||||
|
|
||||||
The subcommand "show" (which is also the default, in the absense of any
|
The subcommand "show" (which is also the default, in the absence of any
|
||||||
subcommands) will take all the normal log options, and show the log of
|
subcommands) will take all the normal log options, and show the log of
|
||||||
`HEAD`, which will cover all recent actions, including branch switches.
|
`HEAD`, which will cover all recent actions, including branch switches.
|
||||||
It is basically an alias for 'git log -g --abbrev-commit
|
It is basically an alias for 'git log -g --abbrev-commit
|
||||||
|
|
|
@ -14,7 +14,7 @@ DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
This script is used to combine all objects that do not currently
|
This script is used to combine all objects that do not currently
|
||||||
reside in a "pack", into a pack. It can also be used to re-organise
|
reside in a "pack", into a pack. It can also be used to re-organize
|
||||||
existing packs into a single, more efficient pack.
|
existing packs into a single, more efficient pack.
|
||||||
|
|
||||||
A pack is a collection of objects, individually compressed, with
|
A pack is a collection of objects, individually compressed, with
|
||||||
|
|
|
@ -113,7 +113,7 @@ e.g. "2 hours ago".
|
||||||
`--date=rfc` (or `--date=rfc2822`) shows timestamps in RFC 2822
|
`--date=rfc` (or `--date=rfc2822`) shows timestamps in RFC 2822
|
||||||
format, often found in E-mail messages.
|
format, often found in E-mail messages.
|
||||||
+
|
+
|
||||||
`--date=short` shows only date but not time, in `YYYY-MM-DD` fomat.
|
`--date=short` shows only date but not time, in `YYYY-MM-DD` format.
|
||||||
+
|
+
|
||||||
`--date=default` shows timestamps in the original timezone
|
`--date=default` shows timestamps in the original timezone
|
||||||
(either committer's or author's).
|
(either committer's or author's).
|
||||||
|
|
|
@ -99,7 +99,7 @@ COMMANDS
|
||||||
|
|
||||||
This works similarly to 'svn update' or 'git-pull' except that
|
This works similarly to 'svn update' or 'git-pull' except that
|
||||||
it preserves linear history with 'git-rebase' instead of
|
it preserves linear history with 'git-rebase' instead of
|
||||||
'git-merge' for ease of dcommit-ing with git-svn.
|
'git-merge' for ease of dcommiting with git-svn.
|
||||||
|
|
||||||
This accepts all options that 'git-svn fetch' and 'git-rebase'
|
This accepts all options that 'git-svn fetch' and 'git-rebase'
|
||||||
accepts. However '--fetch-all' only fetches from the current
|
accepts. However '--fetch-all' only fetches from the current
|
||||||
|
@ -551,7 +551,7 @@ listed below are allowed:
|
||||||
Keep in mind that the '*' (asterisk) wildcard of the local ref
|
Keep in mind that the '*' (asterisk) wildcard of the local ref
|
||||||
(left of the ':') *must* be the farthest right path component;
|
(left of the ':') *must* be the farthest right path component;
|
||||||
however the remote wildcard may be anywhere as long as it's own
|
however the remote wildcard may be anywhere as long as it's own
|
||||||
independent path componet (surrounded by '/' or EOL). This
|
independent path component (surrounded by '/' or EOL). This
|
||||||
type of configuration is not automatically created by 'init' and
|
type of configuration is not automatically created by 'init' and
|
||||||
should be manually entered with a text-editor or using
|
should be manually entered with a text-editor or using
|
||||||
gitlink:git-config[1]
|
gitlink:git-config[1]
|
||||||
|
|
|
@ -285,7 +285,7 @@ want to appear as the hunk header, like this:
|
||||||
Note. A single level of backslashes are eaten by the
|
Note. A single level of backslashes are eaten by the
|
||||||
configuration file parser, so you would need to double the
|
configuration file parser, so you would need to double the
|
||||||
backslashes; the pattern above picks a line that begins with a
|
backslashes; the pattern above picks a line that begins with a
|
||||||
backslash, and zero or more occurences of `sub` followed by
|
backslash, and zero or more occurrences of `sub` followed by
|
||||||
`section` followed by open brace, to the end of line.
|
`section` followed by open brace, to the end of line.
|
||||||
|
|
||||||
There are a few built-in patterns to make this easier, and `tex`
|
There are a few built-in patterns to make this easier, and `tex`
|
||||||
|
@ -394,7 +394,7 @@ abc -foo -bar
|
||||||
the attributes given to path `t/abc` are computed as follows:
|
the attributes given to path `t/abc` are computed as follows:
|
||||||
|
|
||||||
1. By examining `t/.gitattributes` (which is in the same
|
1. By examining `t/.gitattributes` (which is in the same
|
||||||
diretory as the path in question), git finds that the first
|
directory as the path in question), git finds that the first
|
||||||
line matches. `merge` attribute is set. It also finds that
|
line matches. `merge` attribute is set. It also finds that
|
||||||
the second line matches, and attributes `foo` and `bar`
|
the second line matches, and attributes `foo` and `bar`
|
||||||
are unset.
|
are unset.
|
||||||
|
@ -410,7 +410,7 @@ the attributes given to path `t/abc` are computed as follows:
|
||||||
a match, and `foo` is set, `bar` is reverted to unspecified
|
a match, and `foo` is set, `bar` is reverted to unspecified
|
||||||
state, and `baz` is unset.
|
state, and `baz` is unset.
|
||||||
|
|
||||||
As the result, the attributes assignement to `t/abc` becomes:
|
As the result, the attributes assignment to `t/abc` becomes:
|
||||||
|
|
||||||
----------------------------------------------------------------
|
----------------------------------------------------------------
|
||||||
foo set to true
|
foo set to true
|
||||||
|
|
|
@ -176,7 +176,7 @@ hook does on its standard input.
|
||||||
This hook does not affect the outcome of `git-receive-pack`, as it
|
This hook does not affect the outcome of `git-receive-pack`, as it
|
||||||
is called after the real work is done.
|
is called after the real work is done.
|
||||||
|
|
||||||
This supersedes the <<post-update,'post-update'>> hook in that it get's
|
This supersedes the <<post-update,'post-update'>> hook in that it gets
|
||||||
both old and new values of all the refs in addition to their
|
both old and new values of all the refs in addition to their
|
||||||
names.
|
names.
|
||||||
|
|
||||||
|
|
|
@ -339,7 +339,7 @@ $ git pull . remotes/bob/master
|
||||||
-------------------------------------
|
-------------------------------------
|
||||||
|
|
||||||
Note that git pull always merges into the current branch,
|
Note that git pull always merges into the current branch,
|
||||||
regardless of what else is given on the commandline.
|
regardless of what else is given on the command line.
|
||||||
|
|
||||||
Later, Bob can update his repo with Alice's latest changes using
|
Later, Bob can update his repo with Alice's latest changes using
|
||||||
|
|
||||||
|
|
|
@ -4,7 +4,7 @@ ______________________________________________
|
||||||
|
|
||||||
Git is a fast distributed revision control system.
|
Git is a fast distributed revision control system.
|
||||||
|
|
||||||
This manual is designed to be readable by someone with basic unix
|
This manual is designed to be readable by someone with basic UNIX
|
||||||
command-line skills, but no previous knowledge of git.
|
command-line skills, but no previous knowledge of git.
|
||||||
|
|
||||||
<<repositories-and-branches>> and <<exploring-git-history>> explain how
|
<<repositories-and-branches>> and <<exploring-git-history>> explain how
|
||||||
|
@ -217,7 +217,7 @@ commits will help understand how the git organizes history.
|
||||||
|
|
||||||
In the following, we say that commit X is "reachable" from commit Y
|
In the following, we say that commit X is "reachable" from commit Y
|
||||||
if commit X is an ancestor of commit Y. Equivalently, you could say
|
if commit X is an ancestor of commit Y. Equivalently, you could say
|
||||||
that Y is a descendent of X, or that there is a chain of parents
|
that Y is a descendant of X, or that there is a chain of parents
|
||||||
leading from commit Y to commit X.
|
leading from commit Y to commit X.
|
||||||
|
|
||||||
[[history-diagrams]]
|
[[history-diagrams]]
|
||||||
|
@ -1911,7 +1911,7 @@ gitlink:git-update-server-info[1], and the documentation
|
||||||
link:hooks.html[Hooks used by git].)
|
link:hooks.html[Hooks used by git].)
|
||||||
|
|
||||||
Advertise the url of proj.git. Anybody else should then be able to
|
Advertise the url of proj.git. Anybody else should then be able to
|
||||||
clone or pull from that url, for example with a commandline like:
|
clone or pull from that url, for example with a command line like:
|
||||||
|
|
||||||
-------------------------------------------------
|
-------------------------------------------------
|
||||||
$ git clone http://yourserver.com/~you/proj.git
|
$ git clone http://yourserver.com/~you/proj.git
|
||||||
|
@ -2531,7 +2531,7 @@ them again with gitlink:git-am[1].
|
||||||
Other tools
|
Other tools
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
There are numerous other tools, such as stgit, which exist for the
|
There are numerous other tools, such as StGIT, which exist for the
|
||||||
purpose of maintaining a patch series. These are outside of the scope of
|
purpose of maintaining a patch series. These are outside of the scope of
|
||||||
this manual.
|
this manual.
|
||||||
|
|
||||||
|
@ -3961,8 +3961,8 @@ This is a work in progress.
|
||||||
|
|
||||||
The basic requirements:
|
The basic requirements:
|
||||||
- It must be readable in order, from beginning to end, by
|
- It must be readable in order, from beginning to end, by
|
||||||
someone intelligent with a basic grasp of the unix
|
someone intelligent with a basic grasp of the UNIX
|
||||||
commandline, but without any special knowledge of git. If
|
command line, but without any special knowledge of git. If
|
||||||
necessary, any other prerequisites should be specifically
|
necessary, any other prerequisites should be specifically
|
||||||
mentioned as they arise.
|
mentioned as they arise.
|
||||||
- Whenever possible, section headings should clearly describe
|
- Whenever possible, section headings should clearly describe
|
||||||
|
|
Loading…
Reference in New Issue