From: Junio C Hamano Date: Tue, 30 Oct 2018 06:43:47 +0000 (+0900) Subject: Merge branch 'ah/doc-updates' X-Git-Tag: v2.20.0-rc0~106 X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/90d228b0d702d105dc2738f49528deb5fdb0e201?hp=-c 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' --- 90d228b0d702d105dc2738f49528deb5fdb0e201 diff --combined Documentation/git-update-ref.txt index fda8516677,86afd24c7f..9671423117 --- a/Documentation/git-update-ref.txt +++ b/Documentation/git-update-ref.txt @@@ -8,7 -8,7 +8,7 @@@ git-update-ref - Update the object nam SYNOPSIS -------- [verse] -'git update-ref' [-m ] (-d [] | [--no-deref] [--create-reflog] [] | --stdin [-z]) +'git update-ref' [-m ] [--no-deref] (-d [] | [--create-reflog] [] | --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 , "newsha1" is the 40 character hexadecimal value of 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. diff --combined Documentation/git-worktree.txt index e2ee9fc21b,d707e61198..73520434f6 --- a/Documentation/git-worktree.txt +++ b/Documentation/git-worktree.txt @@@ -120,16 -120,8 +120,16 @@@ OPTION --force:: By default, `add` refuses to create a new working tree when `` 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 `` is already assigned to some + working tree but is missing (for instance, if `` 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 :: -B :: @@@ -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 2ac9b1c7fe,495b9163ea..00156d64aa --- a/Documentation/git.txt +++ b/Documentation/git.txt @@@ -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 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 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 .