Merge branch 'ah/doc-updates'
authorJunio C Hamano <gitster@pobox.com>
Tue, 30 Oct 2018 06:43:47 +0000 (15:43 +0900)
committerJunio C Hamano <gitster@pobox.com>
Tue, 30 Oct 2018 06:43:47 +0000 (15:43 +0900)
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'

1  2 
Documentation/git-update-ref.txt
Documentation/git-worktree.txt
Documentation/git.txt
index fda8516677237e9c0a8343f9ca96a1eb969b3492,86afd24c7f9dc14c5904897946486bba93cc0eb0..96714231179cac8242f1bd0f781503d607c4add3
@@@ -8,7 -8,7 +8,7 @@@ git-update-ref - Update the object nam
  SYNOPSIS
  --------
  [verse]
 -'git update-ref' [-m <reason>] (-d <ref> [<oldvalue>] | [--no-deref] [--create-reflog] <ref> <newvalue> [<oldvalue>] | --stdin [-z])
 +'git update-ref' [-m <reason>] [--no-deref] (-d <ref> [<oldvalue>] | [--create-reflog] <ref> <newvalue> [<oldvalue>] | --stdin [-z])
  
  DESCRIPTION
  -----------
@@@ -129,8 -129,8 +129,8 @@@ a line to the log file "$GIT_DIR/logs/<
  symbolic refs before creating the log name) describing the change
  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
  stored in <ref>, "newsha1" is the 40 character hexadecimal value of
  <newvalue> and "committer" is the committer's name, email address
@@@ -138,8 -138,8 +138,8 @@@ and date in the standard Git committer 
  
  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
  value supplied to the -m option.
  
index e2ee9fc21b400b01b006d5460698f0229e23ff9f,d707e611981a424b2f3821d07f111b032290e8a8..73520434f6b2dc4f07ac210bd50da8878c824ce5
@@@ -120,16 -120,8 +120,16 @@@ OPTION
  --force::
        By default, `add` refuses to create a new working tree when
        `<commit-ish>` is a branch name and is already checked out by
 -      another working tree and `remove` refuses to remove an unclean
 -      working tree. This option overrides these safeguards.
 +      another working tree, or if `<path>` is already assigned to some
 +      working tree but is missing (for instance, if `<path>` was deleted
 +      manually). This option overrides these safeguards. To add a missing but
 +      locked working tree path, specify `--force` twice.
 ++
 +`move` refuses to move a locked working tree unless `--force` is specified
 +twice.
 ++
 +`remove` refuses to remove an unclean working tree unless `--force` is used.
 +To remove a locked working tree, specify `--force` twice.
  
  -b <new-branch>::
  -B <new-branch>::
@@@ -270,8 -262,8 +270,8 @@@ Porcelain Forma
  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'
  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
- example:
+ if the value is true.  The first attribute of a worktree is always `worktree`,
an empty line indicates the end of the record.  For example:
  
  ------------
  $ git worktree list --porcelain
diff --combined Documentation/git.txt
index 2ac9b1c7fe00fea0772d5269121ffdf424435b96,495b9163eae899ca55eb482c6e910221824bfc52..00156d64aad51cd758e554ada68a52a3e55dfc0c
@@@ -76,7 -76,7 +76,7 @@@ Note that omitting the `=` in `git -c f
  `foo.bar` to the boolean true value (just like `[foo]bar` would in a
  config file). Including the equals but with an empty value (like `git -c
  foo.bar= ...`) sets `foo.bar` to the empty string which `git config
 ---bool` will convert to `false`.
 +--type=bool` will convert to `false`.
  
  --exec-path[=<path>]::
        Path to wherever your core Git programs are installed.
@@@ -402,11 -402,11 +402,11 @@@ Git so take care if using a foreign fro
        of Git object directories which can be used to search for Git
        objects. New objects will not be written to these directories.
  +
      Entries that begin with `"` (double-quote) will be interpreted
      as C-style quoted paths, removing leading and trailing
      double-quotes and respecting backslash escapes. E.g., the value
      `"path-with-\"-and-:-in-it":vanilla-path` has two paths:
      `path-with-"-and-:-in-it` and `vanilla-path`.
+ Entries that begin with `"` (double-quote) will be interpreted
+ as C-style quoted paths, removing leading and trailing
+ double-quotes and respecting backslash escapes. E.g., the value
+ `"path-with-\"-and-:-in-it":vanilla-path` has two paths:
+ `path-with-"-and-:-in-it` and `vanilla-path`.
  
  `GIT_DIR`::
        If the `GIT_DIR` environment variable is set then it
@@@ -599,8 -599,8 +599,8 @@@ trace messages into this file descripto
  +
  Alternatively, if the variable is set to an absolute path
  (starting with a '/' character), Git will interpret this
 -as a file path and will try to write the trace messages
 -into it.
 +as a file path and will try to append the trace messages
 +to it.
  +
  Unsetting the variable, or setting it to empty, "0" or
  "false" (case insensitive) disables trace messages.
@@@ -858,9 -858,7 +858,9 @@@ Reporting Bug
  
  Report bugs to the Git mailing list <git@vger.kernel.org> where the
  development and maintenance is primarily done.  You do not have to be
 -subscribed to the list to send a message there.
 +subscribed to the list to send a message there.  See the list archive
 +at https://public-inbox.org/git for previous bug reports and other
 +discussions.
  
  Issues which are security relevant should be disclosed privately to
  the Git Security mailing list <git-security@googlegroups.com>.