Make the documentation of options more consistent.

Signed-off-by: Yann Dirson <ydirson@altern.org>

diff --git a/Documentation/COMMAND-TEMPLATE.txt b/Documentation/COMMAND-TEMPLATE.txt
index e49a44d3a9fc723b0fcb876ed3fcfe5983bb1bc6..7bc029a2655052709c0a34fed51240dc26a88c32 100644 (file)
--- a/Documentation/COMMAND-TEMPLATE.txt
+++ b/Documentation/COMMAND-TEMPLATE.txt
@@ -9,7 +9,8 @@ stg-NAME - stgdesc:NAME[]
 
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------

-stg NAME [OPTIONS] XXX
+[verse]
+'stg' NAME [OPTIONS] XXX

 
 DESCRIPTION
 -----------
 
 DESCRIPTION
 -----------

diff --git a/Documentation/stg-branch.txt b/Documentation/stg-branch.txt
index 28a9a28bf812770b63692e6e7cdb96481ab7e8a1..2efe7b1a5eb26fffa32e6cbc6b081224f6a9e917 100644 (file)
--- a/Documentation/stg-branch.txt
+++ b/Documentation/stg-branch.txt
@@ -9,25 +9,17 @@ stg-branch - stgdesc:branch[]
 
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------

-stg branch
-
-stg branch <branch>
-
-stg branch --list
-
-stg branch --create <newstack> [<commit-id>]
-
-stg branch --clone [<newstack>]
-
-stg branch --rename <oldname> <newname>
-
-stg branch --protect [<branch>]
-
-stg branch --unprotect [<branch>]
-
-stg branch --delete [--force] <branch>
-
-stg branch --convert
+[verse]
+'stg' branch
+'stg' branch <branch>
+'stg' branch --list
+'stg' branch --create <newstack> [<commit-id>]
+'stg' branch --clone [<newstack>]
+'stg' branch --rename <oldname> <newname>
+'stg' branch --protect [<branch>]
+'stg' branch --unprotect [<branch>]
+'stg' branch --delete [--force] <branch>
+'stg' branch --convert

 
 DESCRIPTION
 -----------
 
 DESCRIPTION
 -----------


@@ -40,16 +32,14 @@ no command, no argument::
 no command, one argument::
        Switch to the named <branch>.
 
 no command, one argument::
        Switch to the named <branch>.
 

---list::
--l::
+'stg' branch [-l | --list]::

        Display the list of branches in the current repository,
        suffixed by the branch description if any, and optionally
        prefixed by the letter flags 's' if the branch is an StGIT
        stack, and 'p' if the StGIT stack is protected.  The current
        branch is shown with a leading ">" character.
 
        Display the list of branches in the current repository,
        suffixed by the branch description if any, and optionally
        prefixed by the letter flags 's' if the branch is an StGIT
        stack, and 'p' if the StGIT stack is protected.  The current
        branch is shown with a leading ">" character.
 

---create::
--c::
+'stg' branch [-c | --create]::

        Create a new StGIT stack based at the specified commit, or at
        the current HEAD if not specified.  The repository HEAD is
        switched to the new stack.
        Create a new StGIT stack based at the specified commit, or at
        the current HEAD if not specified.  The repository HEAD is
        switched to the new stack.


@@ -61,7 +51,7 @@ commits from the correct branch.  It will warn if it cannot guess the
 parent branch (eg. if you do not specify a branch name as
 <commit-id>).
 
 parent branch (eg. if you do not specify a branch name as
 <commit-id>).
 

---clone::
+'stg' branch --clone::

        Clone the current stack, under the name <newstack> if
        specified, or using the current stack's name suffixed by a
        timestamp.
        Clone the current stack, under the name <newstack> if
        specified, or using the current stack's name suffixed by a
        timestamp.


@@ -73,20 +63,17 @@ the current stack.
 Cloning a GIT branch that is not an StGIT stack is similar to creating
 a new stack off the current branch.
 
 Cloning a GIT branch that is not an StGIT stack is similar to creating
 a new stack off the current branch.
 

---rename::
--r::
+'stg' branch [-r | --rename]::

        Rename the stack named <oldname> to <newname>.
 
        Rename the stack named <oldname> to <newname>.
 

---protect::
--p::
+'stg' branch [-p | --protect]::

        Protect the named stack or the current one, preventing
        further StGIT operations from modifying this stack.
 
        Protect the named stack or the current one, preventing
        further StGIT operations from modifying this stack.
 

---unprotect::
--u::
+'stg' branch [-u | --unprotect]::

        Remove a "protected" flag previously set with '--protect'.
 
        Remove a "protected" flag previously set with '--protect'.
 

---delete::
+'stg' branch --delete::

        Delete the named <branch>.  If there are any patches left in
        the series, StGIT will refuse to delete it, unless '--force'
        is specified.
        Delete the named <branch>.  If there are any patches left in
        the series, StGIT will refuse to delete it, unless '--force'
        is specified.


@@ -100,7 +87,7 @@ the "master" branch if it exists.
 Branch "master" is treated specially (see bug #8732), in that only the
 StGIT metadata are removed, the GIT branch itself is not destroyed.
 
 Branch "master" is treated specially (see bug #8732), in that only the
 StGIT metadata are removed, the GIT branch itself is not destroyed.
 

---convert::
+'stg' branch --convert::

        Switch current stack between old and new format.
 
 OPTIONS
        Switch current stack between old and new format.
 
 OPTIONS

diff --git a/Documentation/stg-clone.txt b/Documentation/stg-clone.txt
index 126b0f2f4ccb8e8b0392dbe47922648e89486e8d..19a8b79c6a3e28fed289a558e7541cbfdbf901b5 100644 (file)
--- a/Documentation/stg-clone.txt
+++ b/Documentation/stg-clone.txt
@@ -9,7 +9,8 @@ stg-clone - stgdesc:clone[]
 
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------

-stg clone [OPTIONS] <repository> <dir>
+[verse]
+'stg' clone <repository> <dir>

 
 DESCRIPTION
 -----------
 
 DESCRIPTION
 -----------


@@ -26,11 +27,6 @@ commands of stglink:branch[].
 The target directory named by <dir> will be created by this command,
 and must not exist beforehand.
 
 The target directory named by <dir> will be created by this command,
 and must not exist beforehand.
 

-OPTIONS
--------
-
-No specific options.
-

 StGIT
 -----
 Part of the StGIT suite - see gitlink:stg[1].
 StGIT
 -----
 Part of the StGIT suite - see gitlink:stg[1].

diff --git a/Documentation/stg-cp.txt b/Documentation/stg-cp.txt
index d28c619f3ae461762dd322ab788b1d41ae36981b..23149258cfb7791b5a79d57bc52ce5c670fae153 100644 (file)
--- a/Documentation/stg-cp.txt
+++ b/Documentation/stg-cp.txt
@@ -9,9 +9,9 @@ stg-cp - stgdesc:cp[]
 
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------

-stg cp [OPTIONS] <file|dir> <newname>
-
-stg cp [OPTIONS] <files|dirs...> <dir>
+[verse]
+'stg' cp [OPTIONS] <file|dir> <newname>
+'stg' cp [OPTIONS] <files|dirs...> <dir>

 
 DESCRIPTION
 -----------
 
 DESCRIPTION
 -----------


@@ -44,6 +44,9 @@ that directory would be overwritten.
 FUTURE OPTIONS
 --------------
 
 FUTURE OPTIONS
 --------------
 

+No options are supported yet.  The following options may be
+implemented in the future.
+

 --all::
        Also copy files not known to Git when copying a directory.
 
 --all::
        Also copy files not known to Git when copying a directory.
 

diff --git a/Documentation/stg-init.txt b/Documentation/stg-init.txt
index e692a04ed38cf822b59536036df5debb3a6c3f10..03877e0428014793f7b7df78845ad20c7e3d2789 100644 (file)
--- a/Documentation/stg-init.txt
+++ b/Documentation/stg-init.txt
@@ -9,7 +9,8 @@ stg-init - stgdesc:init[]
 
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------

-stg init [OPTIONS]
+[verse]
+'stg' init

 
 DESCRIPTION
 -----------
 
 DESCRIPTION
 -----------


@@ -23,11 +24,6 @@ This operation is for example suitable to start working using the
 an StGIT stack are stglink:clone[] and the '--create' and '--clone'
 commands of stglink:branch[].
 
 an StGIT stack are stglink:clone[] and the '--create' and '--clone'
 commands of stglink:branch[].
 

-OPTIONS
--------
-
-No specific options.
-

 StGIT
 -----
 Part of the StGIT suite - see gitlink:stg[1].
 StGIT
 -----
 Part of the StGIT suite - see gitlink:stg[1].

diff --git a/Documentation/stg-new.txt b/Documentation/stg-new.txt
index 57755594b73b54a7799ad427534c2087179f0529..009659af82eeb5a08657e2f212233f2fd52b8621 100644 (file)
--- a/Documentation/stg-new.txt
+++ b/Documentation/stg-new.txt
@@ -9,7 +9,8 @@ stg-new - stgdesc:new[]
 
 SYNOPSIS
 --------
 
 SYNOPSIS
 --------

-stg new [OPTIONS] <name>
+[verse]
+'stg' new [OPTIONS] <name>

 
 DESCRIPTION
 -----------
 
 DESCRIPTION
 -----------


@@ -20,6 +21,9 @@ is made the new top of the stack.  The local changes in the working
 tree are not included in the patch. A stglink:refresh[] command is
 needed for this.
 
 tree are not included in the patch. A stglink:refresh[] command is
 needed for this.
 

+The given <name> must be unique in the stack, and may only contain
+alphanumeric characters, dashes and underscores.
+

 An editor will be launched to edit the commit message to be used for
 the patch, unless the '--message' flag already specified one.  The
 'patchdescr.tmpl' template file is used if available to pre-fill the
 An editor will be launched to edit the commit message to be used for
 the patch, unless the '--message' flag already specified one.  The
 'patchdescr.tmpl' template file is used if available to pre-fill the


@@ -57,11 +61,6 @@ described in gitlink:git-commit-tree[1].
 OPTIONS
 -------
 
 OPTIONS
 -------
 

-<name>::
-       The short name that will be used as to identify the patch in
-       other StGIT commands.  Must be unique in the stack.  May only
-       contain alphanumeric characters, dashes and underscores.
-

 --message=<message>::
 -m <message>::
        Use <message> as the patch description.
 --message=<message>::
 -m <message>::
        Use <message> as the patch description.

diff --git a/Documentation/stg.txt b/Documentation/stg.txt
index 47934a560acf78d23468008eb1859910842cb5e0..a91b60016b79796ef32c45e71572bf4117e0f7cd 100644 (file)
--- a/Documentation/stg.txt
+++ b/Documentation/stg.txt
@@ -10,7 +10,9 @@ stg - manage stacks of patches using the GIT content tracker
 SYNOPSIS
 --------
 [verse]
 SYNOPSIS
 --------
 [verse]

-'stg' [--version] [--help] <command> [OPTIONS] [ARGS]
+'stg' [--version | --help]
+'stg' [--help <command> | <command> --help]
+'stg' <command> [COMMAND OPTIONS] [ARGS]

 
 DESCRIPTION
 -----------
 
 DESCRIPTION
 -----------


@@ -52,6 +54,10 @@ patches; there may be regular GIT commits below your stack base.
 OPTIONS
 -------
 
 OPTIONS
 -------
 

+The following generic option flags are available.  Additional options
+are available per-command, and documented in the command-specific
+documentation.
+

 --version::
        Prints the StGIT suite version that the 'stg' program came
        from, as well as version of other components used, such as GIT
 --version::
        Prints the StGIT suite version that the 'stg' program came
        from, as well as version of other components used, such as GIT