Make the documentation of options more consistent.

[stgit] / Documentation / stg-new.txt

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
 --------
-stg new [OPTIONS] <name>
+[verse]
+'stg' new [OPTIONS] <name>
 
 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.
 
+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
@@ -57,11 +61,6 @@ described in gitlink:git-commit-tree[1].
 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.