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
-----------
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.
---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.
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.
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>.
---protect::
--p::
+'stg' branch [-p | --protect]::
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'.
---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.
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
SYNOPSIS
--------
-stg new [OPTIONS] <name>
+[verse]
+'stg' new [OPTIONS] <name>
DESCRIPTION
-----------
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
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.
SYNOPSIS
--------
[verse]
-'stg' [--version] [--help] <command> [OPTIONS] [ARGS]
+'stg' [--version | --help]
+'stg' [--help <command> | <command> --help]
+'stg' <command> [COMMAND OPTIONS] [ARGS]
DESCRIPTION
-----------
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