Doc update.
* ja/doc-cleanup:
init doc: --shared=0xxx does not give umask but perm bits
doc: git-init: clarify file modes in octal.
doc: git-http-push: describe the refs as pattern pairs
doc: uniformize <URL> placeholders' case
doc: use three dots for indicating repetition instead of star
doc: git-ls-files: express options as optional alternatives
doc: use only hyphens as word separators in placeholders
doc: express grammar placeholders between angle brackets
doc: split placeholders as individual tokens
doc: fix git credential synopsis
@ -5,9 +5,9 @@ The `GIT_AUTHOR_DATE` and `GIT_COMMITTER_DATE` environment variables
@@ -5,9 +5,9 @@ The `GIT_AUTHOR_DATE` and `GIT_COMMITTER_DATE` environment variables
support the following date formats:
Git internal format::
It is `<unix timestamp> <time zone offset>`, where `<unix
timestamp>` is the number of seconds since the UNIX epoch.
`<time zone offset>` is a positive or negative offset from UTC.
It is `<unix-timestamp> <time-zone-offset>`, where
`<unix-timestamp>` is the number of seconds since the UNIX epoch.
`<time-zone-offset>` is a positive or negative offset from UTC.
For example CET (which is 1 hour ahead of UTC) is `+0100`.
@ -43,7 +43,7 @@ You could omit `<branch>`, in which case the command degenerates to
@@ -43,7 +43,7 @@ You could omit `<branch>`, in which case the command degenerates to
rather expensive side-effects to show only the tracking information,
Specifying `-b` causes a new branch to be created as if
linkgit:git-branch[1] were called and then checked out. In
@ -52,11 +52,11 @@ if exists, for the current branch.
@@ -52,11 +52,11 @@ if exists, for the current branch.
`--track` without `-b` implies branch creation; see the
description of `--track` below.
+
If `-B` is given, `<new_branch>` is created if it doesn't exist; otherwise, it
If `-B` is given, `<new-branch>` is created if it doesn't exist; otherwise, it
is reset. This is the transactional equivalent of
+
------------
$ git branch -f <branch> [<start point>]
$ git branch -f <branch> [<start-point>]
$ git checkout <branch>
------------
+
@ -145,13 +145,13 @@ as `ours` (i.e. "our shared canonical history"), while what you did
@@ -145,13 +145,13 @@ as `ours` (i.e. "our shared canonical history"), while what you did
on your side branch as `theirs` (i.e. "one contributor's work on top
of it").
-b <new_branch>::
Create a new branch named `<new_branch>` and start it at
`<start_point>`; see linkgit:git-branch[1] for details.
-b <new-branch>::
Create a new branch named `<new-branch>` and start it at
`<start-point>`; see linkgit:git-branch[1] for details.
-B <new_branch>::
Creates the branch `<new_branch>` and start it at `<start_point>`;
if it already exists, then reset it to `<start_point>`. This is
-B <new-branch>::
Creates the branch `<new-branch>` and start it at `<start-point>`;
if it already exists, then reset it to `<start-point>`. This is
`<commit>` is not a branch name. See the "DETACHED HEAD" section
below for details.
--orphan <new_branch>::
Create a new 'orphan' branch, named `<new_branch>`, started from
`<start_point>` and switch to it. The first commit made on this
--orphan <new-branch>::
Create a new 'orphan' branch, named `<new-branch>`, started from
`<start-point>` and switch to it. The first commit made on this
new branch will have no parents and it will be the root of a new
history totally disconnected from all the other branches and
commits.
+
The index and the working tree are adjusted as if you had previously run
`git checkout <start_point>`. This allows you to start a new history
that records a set of paths similar to `<start_point>` by easily running
`git checkout <start-point>`. This allows you to start a new history
that records a set of paths similar to `<start-point>` by easily running
`git commit -a` to make the root commit.
+
This can be useful when you want to publish the tree from a commit
@ -229,7 +229,7 @@ whose full history contains proprietary or otherwise encumbered bits of
@@ -229,7 +229,7 @@ whose full history contains proprietary or otherwise encumbered bits of
code.
+
If you want to start a disconnected history that records a set of paths
that is totally different from the one of `<start_point>`, then you should
that is totally different from the one of `<start-point>`, then you should
clear the index and the working tree right after creating the orphan
branch by running `git rm -rf .` from the top level of the working tree.
Afterwards you will be ready to prepare your new files, repopulating the
@ -341,10 +341,10 @@ As a special case, you may use `A...B` as a shortcut for the
@@ -341,10 +341,10 @@ As a special case, you may use `A...B` as a shortcut for the
merge base of `A` and `B` if there is exactly one merge base. You can
leave out at most one of `A` and `B`, in which case it defaults to `HEAD`.
<new_branch>::
<new-branch>::
Name for the new branch.
<start_point>::
<start-point>::
The name of a commit at which to start the new branch; see
linkgit:git-branch[1] for details. Defaults to `HEAD`.
@ -8,7 +8,7 @@ git-cherry-pick - Apply the changes introduced by some existing commits
@@ -8,7 +8,7 @@ git-cherry-pick - Apply the changes introduced by some existing commits
@ -211,7 +211,7 @@ objects from the source repository into a pack in the cloned repository.
@@ -211,7 +211,7 @@ objects from the source repository into a pack in the cloned repository.
via ssh, this specifies a non-default path for the command
run on the other end.
--template=<template_directory>::
--template=<template-directory>::
Specify the directory from which templates will be used;
(See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
@ -294,7 +294,7 @@ or `--mirror` is given)
@@ -294,7 +294,7 @@ or `--mirror` is given)
superproject's recorded SHA-1. Equivalent to passing `--remote` to
`git submodule update`.
--separate-git-dir=<git dir>::
--separate-git-dir=<git-dir>::
Instead of placing the cloned repository where it is supposed
to be, place the cloned repository at the specified directory,
then make a filesystem-agnostic Git symbolic link to there.
@ -9,8 +9,8 @@ git-cvsexportcommit - Export a single commit to a CVS checkout
@@ -9,8 +9,8 @@ git-cvsexportcommit - Export a single commit to a CVS checkout
@ -9,7 +9,7 @@ git-diff-files - Compares files in the working tree and the index
@@ -9,7 +9,7 @@ git-diff-files - Compares files in the working tree and the index
@ -9,7 +9,7 @@ git-diff-index - Compare a tree to the working tree or index
@@ -9,7 +9,7 @@ git-diff-index - Compare a tree to the working tree or index
@ -9,7 +9,7 @@ git-http-fetch - Download from a remote Git repository via HTTP
@@ -9,7 +9,7 @@ git-http-fetch - Download from a remote Git repository via HTTP
@ -9,7 +9,7 @@ git-http-push - Push objects over HTTP/DAV to another repository
@@ -9,7 +9,7 @@ git-http-push - Push objects over HTTP/DAV to another repository
@ -63,16 +63,15 @@ of such patterns separated by a colon ":" (this means that a ref name
@@ -63,16 +63,15 @@ of such patterns separated by a colon ":" (this means that a ref name
cannot have a colon in it). A single pattern '<name>' is just a
shorthand for '<name>:<name>'.
Each pattern pair consists of the source side (before the colon)
and the destination side (after the colon). The ref to be
pushed is determined by finding a match that matches the source
side, and where it is pushed is determined by using the
destination side.
Each pattern pair '<src>:<dst>' consists of the source side (before
the colon) and the destination side (after the colon). The ref to be
pushed is determined by finding a match that matches the source side,
and where it is pushed is determined by using the destination side.
- It is an error if <src> does not match exactly one of the
- It is an error if '<src>' does not match exactly one of the
local refs.
- If <dst> does not match any remote ref, either
- If '<dst>' does not match any remote ref, either
* it has to start with "refs/"; <dst> is used as the
@ -9,10 +9,10 @@ git-init - Create an empty Git repository or reinitialize an existing one
@@ -9,10 +9,10 @@ git-init - Create an empty Git repository or reinitialize an existing one
@ -57,12 +57,12 @@ values are 'sha1' and (if enabled) 'sha256'. 'sha1' is the default.
@@ -57,12 +57,12 @@ values are 'sha1' and (if enabled) 'sha256'. 'sha1' is the default.
+
include::object-format-disclaimer.txt[]
--template=<template_directory>::
--template=<template-directory>::
Specify the directory from which templates will be used. (See the "TEMPLATE
DIRECTORY" section below.)
--separate-git-dir=<git dir>::
--separate-git-dir=<git-dir>::
Instead of initializing the repository as a directory to either `$GIT_DIR` or
`./.git/`, create a text file there containing the path to the actual
@ -79,7 +79,7 @@ repository. If not specified, fall back to the default name (currently
@@ -79,7 +79,7 @@ repository. If not specified, fall back to the default name (currently
`master`, but this is subject to change in the future; the name can be
customized via the `init.defaultBranch` configuration variable).
@ -361,7 +361,7 @@ These options can be used to modify 'git p4 submit' behavior.
@@ -361,7 +361,7 @@ These options can be used to modify 'git p4 submit' behavior.
p4/master. See the "Sync options" section above for more
information.
--commit <sha1>|<sha1..sha1>::
--commit (<sha1>|<sha1>..<sha1>)::
Submit only the specified commit or range of commits, instead of the full
list of changes that are in the current Git branch.
@ -17,12 +17,12 @@ The command takes various subcommands, and different options
@@ -17,12 +17,12 @@ The command takes various subcommands, and different options
@ -47,7 +47,7 @@ subcommands are available to perform operations on the remotes.
@@ -47,7 +47,7 @@ subcommands are available to perform operations on the remotes.
'add'::
Add a remote named <name> for the repository at
<url>. The command `git fetch <name>` can then be used to create and
<URL>. The command `git fetch <name>` can then be used to create and
update remote-tracking branches <name>/<branch>.
+
With `-f` option, `git fetch <name>` is run immediately after
@ -152,7 +152,7 @@ With `--push`, push URLs are manipulated instead of fetch URLs.
@@ -152,7 +152,7 @@ With `--push`, push URLs are manipulated instead of fetch URLs.
With `--add`, instead of changing existing URLs, new URL is added.
+
With `--delete`, instead of changing existing URLs, all URLs matching
regex <url> are deleted for remote <name>. Trying to delete all
regex <URL> are deleted for remote <name>. Trying to delete all
non-push URLs is an error.
+
Note that the push URL and the fetch URL, even though they can
@ -132,7 +132,7 @@ because the hostnames differ. Nor would it match `foo.example.com`; Git
@@ -132,7 +132,7 @@ because the hostnames differ. Nor would it match `foo.example.com`; Git
compares hostnames exactly, without considering whether two hosts are part of
the same domain. Likewise, a config entry for `http://example.com` would not
match: Git compares the protocols exactly. However, you may use wildcards in
the domain name and other pattern matching techniques as with the `http.<url>.*`
the domain name and other pattern matching techniques as with the `http.<URL>.*`
options.
If the "pattern" URL does include a path component, then this too must match
@ -29,17 +29,17 @@ This is designed to be as compact as possible.
@@ -29,17 +29,17 @@ This is designed to be as compact as possible.
commit <hash>
Author: <author>
<title line>
<title-line>
* 'medium'
commit <hash>
Author: <author>
Date: <author date>
Date: <author-date>
<title line>
<title-line>
<full commit message>
<full-commit-message>
* 'full'
@ -47,25 +47,25 @@ This is designed to be as compact as possible.
@@ -47,25 +47,25 @@ This is designed to be as compact as possible.
Author: <author>
Commit: <committer>
<title line>
<title-line>
<full commit message>
<full-commit-message>
* 'fuller'
commit <hash>
Author: <author>
AuthorDate: <author date>
AuthorDate: <author-date>
Commit: <committer>
CommitDate: <committer date>
CommitDate: <committer-date>
<title line>
<title-line>
<full commit message>
<full-commit-message>
* 'reference'
<abbrev hash> (<title line>, <short author date>)
<abbrev-hash> (<title-line>, <short-author-date>)
+
This format is used to refer to another commit in a commit message and
is the same as `--pretty='format:%C(auto)%h (%s, %ad)'`. By default,
@ -78,10 +78,10 @@ placeholders, its output is not affected by other options like
@@ -78,10 +78,10 @@ placeholders, its output is not affected by other options like
From <hash> <date>
From: <author>
Date: <author date>
Subject: [PATCH] <title line>
Date: <author-date>
Subject: [PATCH] <title-line>
<full commit message>
<full-commit-message>
* 'mboxrd'
+
@ -101,9 +101,9 @@ commits are displayed, but not the way the diff is shown e.g. with
@@ -101,9 +101,9 @@ commits are displayed, but not the way the diff is shown e.g. with
`git log --raw`. To get full object names in a raw diff format,
use `--no-abbrev`.
* 'format:<string>'
* 'format:<format-string>'
+
The 'format:<string>' format allows you to specify which information
The 'format:<format-string>' format allows you to specify which information
you want to show. It works a little bit like printf format,
with the notable exception that you get a newline with '%n'