From 40e747e89d247b3a12e6cddf848d145bf403a72c Mon Sep 17 00:00:00 2001 From: Denton Liu Date: Mon, 16 Sep 2019 11:19:17 -0700 Subject: [PATCH] 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 [--] instead of set-branch ((-d|--default)|(-b|--branch )) [--] In addition to this, the original documentation was possibly confusing as it made it seem as if the `-b` option didn't accept a `` 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 Signed-off-by: Junio C Hamano --- Documentation/git-submodule.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt index 4daf144180..0474e7af0f 100644 --- a/Documentation/git-submodule.txt +++ b/Documentation/git-submodule.txt @@ -169,7 +169,8 @@ submodule with the `--init` option. If `--recursive` is specified, this command will recurse into the registered submodules, and update any nested submodules within. -- -set-branch ((-d|--default)|(-b|--branch )) [--] :: +set-branch (-b|--branch) [--] :: +set-branch (-d|--default) [--] :: Sets the default remote tracking branch for the submodule. The `--branch` option allows the remote branch to be specified. The `--default` option removes the submodule..branch configuration