diff options
author | Denton Liu <liu.denton@gmail.com> | 2019-09-16 11:19:17 -0700 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2019-09-16 12:27:00 -0700 |
commit | 40e747e89d247b3a12e6cddf848d145bf403a72c (patch) | |
tree | 8d9a4936f33aaa214c6eaa590c34a39341837ecc /compat | |
parent | submodule: teach set-branch subcommand (diff) | |
download | tgif-40e747e89d247b3a12e6cddf848d145bf403a72c.tar.xz |
git-submodule.txt: fix AsciiDoc formatting error
In b57e8119e6 (submodule: teach set-branch subcommand, 2019-02-08), the
`set-branch` subcommand was added for submodules. When the documentation
was written, the syntax for a "index term" in AsciiDoc was
accidentally used. This caused the documentation to be rendered as
set-branch -d|--default)|(-b|--branch <branch> [--] <path>
instead of
set-branch ((-d|--default)|(-b|--branch <branch>)) [--] <path>
In addition to this, the original documentation was possibly confusing
as it made it seem as if the `-b` option didn't accept a `<branch>`
argument.
Break `--default` and `--branch` into their own separate invocations to
make it obvious that these options are mutually exclusive. Also, this
removes the surrounding parentheses so that the "index term" syntax is
not triggered.
Signed-off-by: Denton Liu <liu.denton@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'compat')
0 files changed, 0 insertions, 0 deletions