Skip to content

Commit 40e747e

Browse files
Denton-Lgitster
authored andcommitted
git-submodule.txt: fix AsciiDoc formatting error
In b57e811 (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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent b57e811 commit 40e747e

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

Documentation/git-submodule.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,8 @@ submodule with the `--init` option.
169169
If `--recursive` is specified, this command will recurse into the
170170
registered submodules, and update any nested submodules within.
171171
--
172-
set-branch ((-d|--default)|(-b|--branch <branch>)) [--] <path>::
172+
set-branch (-b|--branch) <branch> [--] <path>::
173+
set-branch (-d|--default) [--] <path>::
173174
Sets the default remote tracking branch for the submodule. The
174175
`--branch` option allows the remote branch to be specified. The
175176
`--default` option removes the submodule.<name>.branch configuration

0 commit comments

Comments
 (0)