X-Git-Url: https://git.distorted.org.uk/~mdw/stgit/blobdiff_plain/4ec677417c8bfb4d30b2cd7482c5ceca9b542fc8..d0c5824b591c3e99d693cffbefc777d6bd7c2ccb:/Documentation/stg-new.txt diff --git a/Documentation/stg-new.txt b/Documentation/stg-new.txt index 698816b..fbf2f67 100644 --- a/Documentation/stg-new.txt +++ b/Documentation/stg-new.txt @@ -9,7 +9,8 @@ stg-new - stgdesc:new[] SYNOPSIS -------- -stg new [OPTIONS] +[verse] +'stg' new [OPTIONS] [name] DESCRIPTION ----------- @@ -20,6 +21,10 @@ 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 must be unique in the stack, and may only contain +alphanumeric characters, dashes and underscores. If no name is given, +one is generated from the first line of the commit message. + 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 +62,6 @@ described in gitlink:git-commit-tree[1]. OPTIONS ------- -:: - 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=:: -m :: Use as the patch description. @@ -112,4 +112,4 @@ GIT CONFIGURATION VARIABLES StGIT ----- -Part of the StGIT suite - see gitlink:stg[7]. +Part of the StGIT suite - see gitlink:stg[1].