Merge branch 'ah/doc-updates'

Doc updates.

* ah/doc-updates:
  doc: fix formatting in git-update-ref
  doc: fix indentation of listing blocks in gitweb.conf.txt
  doc: fix descripion for 'git tag --format'
  doc: fix inappropriate monospace formatting
  doc: fix ASCII art tab spacing
  doc: clarify boundaries of 'git worktree list --porcelain'
This commit is contained in:
Junio C Hamano
2018-10-30 15:43:47 +09:00
12 changed files with 92 additions and 79 deletions

View File

@ -187,6 +187,12 @@ This option is only applicable when listing tags without annotation lines.
`--create-reflog`, but currently does not negate the setting of `--create-reflog`, but currently does not negate the setting of
`core.logAllRefUpdates`. `core.logAllRefUpdates`.
--format=<format>::
A string that interpolates `%(fieldname)` from a tag ref being shown
and the object it points at. The format is the same as
that of linkgit:git-for-each-ref[1]. When unspecified,
defaults to `%(refname:strip=2)`.
<tagname>:: <tagname>::
The name of the tag to create, delete, or describe. The name of the tag to create, delete, or describe.
The new tag name must pass all checks defined by The new tag name must pass all checks defined by
@ -198,12 +204,6 @@ This option is only applicable when listing tags without annotation lines.
The object that the new tag will refer to, usually a commit. The object that the new tag will refer to, usually a commit.
Defaults to HEAD. Defaults to HEAD.
<format>::
A string that interpolates `%(fieldname)` from a tag ref being shown
and the object it points at. The format is the same as
that of linkgit:git-for-each-ref[1]. When unspecified,
defaults to `%(refname:strip=2)`.
CONFIGURATION CONFIGURATION
------------- -------------
By default, 'git tag' in sign-with-default mode (-s) will use your By default, 'git tag' in sign-with-default mode (-s) will use your

View File

@ -129,8 +129,8 @@ a line to the log file "$GIT_DIR/logs/<ref>" (dereferencing all
symbolic refs before creating the log name) describing the change symbolic refs before creating the log name) describing the change
in ref value. Log lines are formatted as: in ref value. Log lines are formatted as:
. oldsha1 SP newsha1 SP committer LF oldsha1 SP newsha1 SP committer LF
+
Where "oldsha1" is the 40 character hexadecimal value previously Where "oldsha1" is the 40 character hexadecimal value previously
stored in <ref>, "newsha1" is the 40 character hexadecimal value of stored in <ref>, "newsha1" is the 40 character hexadecimal value of
<newvalue> and "committer" is the committer's name, email address <newvalue> and "committer" is the committer's name, email address
@ -138,8 +138,8 @@ and date in the standard Git committer ident format.
Optionally with -m: Optionally with -m:
. oldsha1 SP newsha1 SP committer TAB message LF oldsha1 SP newsha1 SP committer TAB message LF
+
Where all fields are as described above and "message" is the Where all fields are as described above and "message" is the
value supplied to the -m option. value supplied to the -m option.

View File

@ -11,6 +11,7 @@ SYNOPSIS
[verse] [verse]
'git-upload-pack' [--[no-]strict] [--timeout=<n>] [--stateless-rpc] 'git-upload-pack' [--[no-]strict] [--timeout=<n>] [--stateless-rpc]
[--advertise-refs] <directory> [--advertise-refs] <directory>
DESCRIPTION DESCRIPTION
----------- -----------
Invoked by 'git fetch-pack', learns what Invoked by 'git fetch-pack', learns what

View File

@ -270,8 +270,8 @@ Porcelain Format
The porcelain format has a line per attribute. Attributes are listed with a The porcelain format has a line per attribute. Attributes are listed with a
label and value separated by a single space. Boolean attributes (like 'bare' label and value separated by a single space. Boolean attributes (like 'bare'
and 'detached') are listed as a label only, and are only present if and only and 'detached') are listed as a label only, and are only present if and only
if the value is true. An empty line indicates the end of a worktree. For if the value is true. The first attribute of a worktree is always `worktree`,
example: an empty line indicates the end of the record. For example:
------------ ------------
$ git worktree list --porcelain $ git worktree list --porcelain

View File

@ -303,7 +303,7 @@ number of pitfalls:
attribute. If you decide to use the `working-tree-encoding` attribute attribute. If you decide to use the `working-tree-encoding` attribute
in your repository, then it is strongly recommended to ensure that all in your repository, then it is strongly recommended to ensure that all
clients working with the repository support it. clients working with the repository support it.
+
For example, Microsoft Visual Studio resources files (`*.rc`) or For example, Microsoft Visual Studio resources files (`*.rc`) or
PowerShell script files (`*.ps1`) are sometimes encoded in UTF-16. PowerShell script files (`*.ps1`) are sometimes encoded in UTF-16.
If you declare `*.ps1` as files as UTF-16 and you add `foo.ps1` with If you declare `*.ps1` as files as UTF-16 and you add `foo.ps1` with
@ -311,7 +311,7 @@ number of pitfalls:
stored as UTF-8 internally. A client without `working-tree-encoding` stored as UTF-8 internally. A client without `working-tree-encoding`
support will checkout `foo.ps1` as UTF-8 encoded file. This will support will checkout `foo.ps1` as UTF-8 encoded file. This will
typically cause trouble for the users of this file. typically cause trouble for the users of this file.
+
If a Git client, that does not support the `working-tree-encoding` If a Git client, that does not support the `working-tree-encoding`
attribute, adds a new file `bar.ps1`, then `bar.ps1` will be attribute, adds a new file `bar.ps1`, then `bar.ps1` will be
stored "as-is" internally (in this example probably as UTF-16). stored "as-is" internally (in this example probably as UTF-16).

View File

@ -67,7 +67,8 @@ submodule.<name>.fetchRecurseSubmodules::
submodule.<name>.ignore:: submodule.<name>.ignore::
Defines under what circumstances "git status" and the diff family show Defines under what circumstances "git status" and the diff family show
a submodule as modified. The following values are supported: a submodule as modified. The following values are supported:
+
--
all;; The submodule will never be considered modified (but will all;; The submodule will never be considered modified (but will
nonetheless show up in the output of status and commit when it has nonetheless show up in the output of status and commit when it has
been staged). been staged).
@ -87,9 +88,11 @@ submodule.<name>.ignore::
If this option is also present in the submodules entry in .git/config If this option is also present in the submodules entry in .git/config
of the superproject, the setting there will override the one found in of the superproject, the setting there will override the one found in
.gitmodules. .gitmodules.
Both settings can be overridden on the command line by using the Both settings can be overridden on the command line by using the
"--ignore-submodule" option. The 'git submodule' commands are not "--ignore-submodule" option. The 'git submodule' commands are not
affected by this setting. affected by this setting.
--
submodule.<name>.shallow:: submodule.<name>.shallow::
When set to true, a clone of this submodule will be performed as a When set to true, a clone of this submodule will be performed as a

View File

@ -169,11 +169,15 @@ ACTIVE SUBMODULES
A submodule is considered active, A submodule is considered active,
(a) if `submodule.<name>.active` is set to `true` a. if `submodule.<name>.active` is set to `true`
+
or or
(b) if the submodule's path matches the pathspec in `submodule.active`
b. if the submodule's path matches the pathspec in `submodule.active`
+
or or
(c) if `submodule.<name>.url` is set.
c. if `submodule.<name>.url` is set.
and these are evaluated in this order. and these are evaluated in this order.

View File

@ -19,10 +19,12 @@ end of a line is ignored. See *perlsyn*(1) for details.
An example: An example:
------------------------------------------------
# gitweb configuration file for http://git.example.org # gitweb configuration file for http://git.example.org
# #
our $projectroot = "/srv/git"; # FHS recommendation our $projectroot = "/srv/git"; # FHS recommendation
our $site_name = 'Example.org >> Repos'; our $site_name = 'Example.org >> Repos';
------------------------------------------------
The configuration file is used to override the default settings that The configuration file is used to override the default settings that
@ -357,6 +359,7 @@ $home_link_str::
+ +
For example, the following setting produces a breadcrumb trail like For example, the following setting produces a breadcrumb trail like
"home / dev / projects / ..." where "projects" is the home link. "home / dev / projects / ..." where "projects" is the home link.
+
---------------------------------------------------------------------------- ----------------------------------------------------------------------------
our @extra_breadcrumbs = ( our @extra_breadcrumbs = (
[ 'home' => 'https://www.example.org/' ], [ 'home' => 'https://www.example.org/' ],
@ -901,6 +904,7 @@ To enable blame, pickaxe search, and snapshot support (allowing "tar.gz" and
"zip" snapshots), while allowing individual projects to turn them off, put "zip" snapshots), while allowing individual projects to turn them off, put
the following in your GITWEB_CONFIG file: the following in your GITWEB_CONFIG file:
--------------------------------------------------------------------------------
$feature{'blame'}{'default'} = [1]; $feature{'blame'}{'default'} = [1];
$feature{'blame'}{'override'} = 1; $feature{'blame'}{'override'} = 1;
@ -909,6 +913,7 @@ the following in your GITWEB_CONFIG file:
$feature{'snapshot'}{'default'} = ['zip', 'tgz']; $feature{'snapshot'}{'default'} = ['zip', 'tgz'];
$feature{'snapshot'}{'override'} = 1; $feature{'snapshot'}{'override'} = 1;
--------------------------------------------------------------------------------
If you allow overriding for the snapshot feature, you can specify which If you allow overriding for the snapshot feature, you can specify which
snapshot formats are globally disabled. You can also add any command-line snapshot formats are globally disabled. You can also add any command-line