Re: [PATCH 5/5] doc: document reversive traversal and related modes

From: Jean-Noël AVILA <jn.avila@free.fr>
Date: Feb 1, 2026, 09:03 UTC
Message-ID: <4710431.LvFx2qVVIh@piment-oiseau>
In-Reply-To: <20260131214309.1899376-6-whatfield.git@gmail.com>

On Saturday, 31 January 2026 22:43:09 CET William Hatfield wrote:

Show 8 quoted lines

> Add documentation for the new --reverse-traversal, --append-superproject,
> and --reversive flags to git-submodule.adoc. These flags enable post-order
> traversal through nested submodule hierarchies, which is useful for
> cleanup operations and dependency-ordered processing.
> 
> The flags only take effect when used with --recursive.
> 
> Signed-off-by: William Hatfield <whatfield.git@gmail.com>

Hello,

git-submodule is being transitioned to `synopsis` style of markup. See https://lore.kernel.org/git/ 05e68e28257cd450463d253abe9b2995759bdc10.1769462744.git.gitgitgadget@gmail.com/

In the same move, there is some work on style consistency of the manual pages.

Below are the remarks on what changed:

Show 5 quoted lines

> ---
>  Documentation/git-submodule.adoc | 20 ++++++++++++++++++++
>  1 file changed, 20 insertions(+)
> 
> diff --git a/Documentation/git-submodule.adoc b/Documentation/git-

submodule.adoc

Show 8 quoted lines

> index 95beaee561..2be477952d 100644
> --- a/Documentation/git-submodule.adoc
> +++ b/Documentation/git-submodule.adoc
> @@ -437,6 +437,26 @@ options carefully.
>  	only in the submodules of the current repo, but also
>  	in any nested submodules inside those submodules (and so on).
> 
> +--reverse-traversal::

Now, options in description lists are backticked:

`--reverse-traversal`::

Show 5 quoted lines

> +	This option is only valid for the foreach command and requires
> +	`--recursive`.  Process nested submodules in post-order (deepest
> +	first) rather than the default pre-order.  This is useful for
> +	cleanup operations where nested submodules must be processed
> +	before their parents.

Please start the description with the actual action of the option. Then, you can add conditions, context, explanation:

Process nested [...]. This option is only valid [...]. This is useful [...]

Thanks