{"thread":{"id":"7567","subject":"[PATCH 1/3] Fix doc cross-refs.","startedAt":"2007-04-08T15:12:00Z","lastAt":"2007-04-08T15:12:16Z","messageCount":4,"participants":["Yann Dirson"],"isPatch":true,"patchVersion":1,"patchTotal":3},"messages":[{"id":"38882","messageId":"20070408150822.8884.67664.stgit@gandelf.nowhere.earth","threadId":"7567","inReplyTo":null,"subject":"[PATCH 0/3] More stgit doc updates","fromName":"Yann Dirson","fromEmail":"ydirson@altern.org","sentAt":"2007-04-08T15:12:00Z","receivedAt":"2007-04-08T15:12:00Z","isPatch":true,"sender":{"key":"ydirson@altern.org","avatar":"https://avatars.githubusercontent.com/u/1190950?v=4"},"body":"This set of patches fixes a couple of things and tries to improve the\ndoc.\n\n-- \nYann Dirson    <ydirson@altern.org> |\nDebian-related: <dirson@debian.org> |   Support Debian GNU/Linux:\n                                    |  Freedom, Power, Stability, Gratis\n     http://ydirson.free.fr/        | Check <http://www.debian.org/>\n"},{"id":"38880","messageId":"20070408151205.8884.44977.stgit@gandelf.nowhere.earth","threadId":"7567","inReplyTo":"20070408150822.8884.67664.stgit@gandelf.nowhere.earth","subject":"[PATCH 1/3] Fix doc cross-refs.","fromName":"Yann Dirson","fromEmail":"ydirson@altern.org","sentAt":"2007-04-08T15:12:06Z","receivedAt":"2007-04-08T15:12:06Z","isPatch":true,"sender":{"key":"ydirson@altern.org","avatar":"https://avatars.githubusercontent.com/u/1190950?v=4"},"body":"\n\n\nSigned-off-by: Yann Dirson <ydirson@altern.org>\n---\n\n Documentation/stg-branch.txt |    2 +-\n Documentation/stg-clone.txt  |    4 ++--\n Documentation/stg-init.txt   |    4 ++--\n 3 files changed, 5 insertions(+), 5 deletions(-)\n\ndiff --git a/Documentation/stg-branch.txt b/Documentation/stg-branch.txt\nindex 53f333b..28a9a28 100644\n--- a/Documentation/stg-branch.txt\n+++ b/Documentation/stg-branch.txt\n@@ -56,7 +56,7 @@ no command, one argument::\n +\n StGIT will try to detect the branch off which the new stack is forked,\n as well as the remote repository from which that parent branch is\n-taken (if any), so running stgdesc:pull[] will effectively pull new\n+taken (if any), so running stglink:pull[] will effectively pull new\n commits from the correct branch.  It will warn if it cannot guess the\n parent branch (eg. if you do not specify a branch name as\n <commit-id>).\ndiff --git a/Documentation/stg-clone.txt b/Documentation/stg-clone.txt\nindex 73c0d92..126b0f2 100644\n--- a/Documentation/stg-clone.txt\n+++ b/Documentation/stg-clone.txt\n@@ -20,8 +20,8 @@ a patch stack.\n \n This operation is for example suitable to start working using the\n \"tracking branch\" workflow (see gitlink:stg[1]).  Other means to setup\n-an StGIT stack are stgdesc:init[] and the '--create' and '--clone'\n-commands of stgdesc:branch[].\n+an StGIT stack are stglink:init[] and the '--create' and '--clone'\n+commands of stglink:branch[].\n \n The target directory named by <dir> will be created by this command,\n and must not exist beforehand.\ndiff --git a/Documentation/stg-init.txt b/Documentation/stg-init.txt\nindex 33fd387..e692a04 100644\n--- a/Documentation/stg-init.txt\n+++ b/Documentation/stg-init.txt\n@@ -20,8 +20,8 @@ valid file in refs/heads/.\n \n This operation is for example suitable to start working using the\n \"development branch\" workflow (see gitlink:stg[1]).  Other means to setup\n-an StGIT stack are stgdesc:clone[] and the '--create' and '--clone'\n-commands of stgdesc:branch[].\n+an StGIT stack are stglink:clone[] and the '--create' and '--clone'\n+commands of stglink:branch[].\n \n OPTIONS\n -------\n"},{"id":"38883","messageId":"20070408151211.8884.26754.stgit@gandelf.nowhere.earth","threadId":"7567","inReplyTo":"20070408150822.8884.67664.stgit@gandelf.nowhere.earth","subject":"[PATCH 2/3] Make the documentation of options more consistent.","fromName":"Yann Dirson","fromEmail":"ydirson@altern.org","sentAt":"2007-04-08T15:12:11Z","receivedAt":"2007-04-08T15:12:11Z","isPatch":true,"sender":{"key":"ydirson@altern.org","avatar":"https://avatars.githubusercontent.com/u/1190950?v=4"},"body":"\n\n\nSigned-off-by: Yann Dirson <ydirson@altern.org>\n---\n\n Documentation/COMMAND-TEMPLATE.txt |    3 +-\n Documentation/stg-branch.txt       |   51 +++++++++++++-----------------------\n Documentation/stg-clone.txt        |    8 +-----\n Documentation/stg-cp.txt           |    9 ++++--\n Documentation/stg-init.txt         |    8 +-----\n Documentation/stg-new.txt          |   11 ++++----\n Documentation/stg.txt              |    8 +++++-\n 7 files changed, 43 insertions(+), 55 deletions(-)\n\ndiff --git a/Documentation/COMMAND-TEMPLATE.txt b/Documentation/COMMAND-TEMPLATE.txt\nindex e49a44d..7bc029a 100644\n--- a/Documentation/COMMAND-TEMPLATE.txt\n+++ b/Documentation/COMMAND-TEMPLATE.txt\n@@ -9,7 +9,8 @@ stg-NAME - stgdesc:NAME[]\n \n SYNOPSIS\n --------\n-stg NAME [OPTIONS] XXX\n+[verse]\n+'stg' NAME [OPTIONS] XXX\n \n DESCRIPTION\n -----------\ndiff --git a/Documentation/stg-branch.txt b/Documentation/stg-branch.txt\nindex 28a9a28..2efe7b1 100644\n--- a/Documentation/stg-branch.txt\n+++ b/Documentation/stg-branch.txt\n@@ -9,25 +9,17 @@ stg-branch - stgdesc:branch[]\n \n SYNOPSIS\n --------\n-stg branch\n-\n-stg branch <branch>\n-\n-stg branch --list\n-\n-stg branch --create <newstack> [<commit-id>]\n-\n-stg branch --clone [<newstack>]\n-\n-stg branch --rename <oldname> <newname>\n-\n-stg branch --protect [<branch>]\n-\n-stg branch --unprotect [<branch>]\n-\n-stg branch --delete [--force] <branch>\n-\n-stg branch --convert\n+[verse]\n+'stg' branch\n+'stg' branch <branch>\n+'stg' branch --list\n+'stg' branch --create <newstack> [<commit-id>]\n+'stg' branch --clone [<newstack>]\n+'stg' branch --rename <oldname> <newname>\n+'stg' branch --protect [<branch>]\n+'stg' branch --unprotect [<branch>]\n+'stg' branch --delete [--force] <branch>\n+'stg' branch --convert\n \n DESCRIPTION\n -----------\n@@ -40,16 +32,14 @@ no command, no argument::\n no command, one argument::\n \tSwitch to the named <branch>.\n \n---list::\n--l::\n+'stg' branch [-l | --list]::\n \tDisplay the list of branches in the current repository,\n \tsuffixed by the branch description if any, and optionally\n \tprefixed by the letter flags 's' if the branch is an StGIT\n \tstack, and 'p' if the StGIT stack is protected.  The current\n \tbranch is shown with a leading \">\" character.\n \n---create::\n--c::\n+'stg' branch [-c | --create]::\n \tCreate a new StGIT stack based at the specified commit, or at\n \tthe current HEAD if not specified.  The repository HEAD is\n \tswitched to the new stack.\n@@ -61,7 +51,7 @@ commits from the correct branch.  It will warn if it cannot guess the\n parent branch (eg. if you do not specify a branch name as\n <commit-id>).\n \n---clone::\n+'stg' branch --clone::\n \tClone the current stack, under the name <newstack> if\n \tspecified, or using the current stack's name suffixed by a\n \ttimestamp.\n@@ -73,20 +63,17 @@ the current stack.\n Cloning a GIT branch that is not an StGIT stack is similar to creating\n a new stack off the current branch.\n \n---rename::\n--r::\n+'stg' branch [-r | --rename]::\n \tRename the stack named <oldname> to <newname>.\n \n---protect::\n--p::\n+'stg' branch [-p | --protect]::\n \tProtect the named stack or the current one, preventing\n \tfurther StGIT operations from modifying this stack.\n \n---unprotect::\n--u::\n+'stg' branch [-u | --unprotect]::\n \tRemove a \"protected\" flag previously set with '--protect'.\n \n---delete::\n+'stg' branch --delete::\n \tDelete the named <branch>.  If there are any patches left in\n \tthe series, StGIT will refuse to delete it, unless '--force'\n \tis specified.\n@@ -100,7 +87,7 @@ the \"master\" branch if it exists.\n Branch \"master\" is treated specially (see bug #8732), in that only the\n StGIT metadata are removed, the GIT branch itself is not destroyed.\n \n---convert::\n+'stg' branch --convert::\n \tSwitch current stack between old and new format.\n \n OPTIONS\ndiff --git a/Documentation/stg-clone.txt b/Documentation/stg-clone.txt\nindex 126b0f2..19a8b79 100644\n--- a/Documentation/stg-clone.txt\n+++ b/Documentation/stg-clone.txt\n@@ -9,7 +9,8 @@ stg-clone - stgdesc:clone[]\n \n SYNOPSIS\n --------\n-stg clone [OPTIONS] <repository> <dir>\n+[verse]\n+'stg' clone <repository> <dir>\n \n DESCRIPTION\n -----------\n@@ -26,11 +27,6 @@ commands of stglink:branch[].\n The target directory named by <dir> will be created by this command,\n and must not exist beforehand.\n \n-OPTIONS\n--------\n-\n-No specific options.\n-\n StGIT\n -----\n Part of the StGIT suite - see gitlink:stg[1].\ndiff --git a/Documentation/stg-cp.txt b/Documentation/stg-cp.txt\nindex d28c619..2314925 100644\n--- a/Documentation/stg-cp.txt\n+++ b/Documentation/stg-cp.txt\n@@ -9,9 +9,9 @@ stg-cp - stgdesc:cp[]\n \n SYNOPSIS\n --------\n-stg cp [OPTIONS] <file|dir> <newname>\n-\n-stg cp [OPTIONS] <files|dirs...> <dir>\n+[verse]\n+'stg' cp [OPTIONS] <file|dir> <newname>\n+'stg' cp [OPTIONS] <files|dirs...> <dir>\n \n DESCRIPTION\n -----------\n@@ -44,6 +44,9 @@ that directory would be overwritten.\n FUTURE OPTIONS\n --------------\n \n+No options are supported yet.  The following options may be\n+implemented in the future.\n+\n --all::\n \tAlso copy files not known to Git when copying a directory.\n \ndiff --git a/Documentation/stg-init.txt b/Documentation/stg-init.txt\nindex e692a04..03877e0 100644\n--- a/Documentation/stg-init.txt\n+++ b/Documentation/stg-init.txt\n@@ -9,7 +9,8 @@ stg-init - stgdesc:init[]\n \n SYNOPSIS\n --------\n-stg init [OPTIONS]\n+[verse]\n+'stg' init\n \n DESCRIPTION\n -----------\n@@ -23,11 +24,6 @@ This operation is for example suitable to start working using the\n an StGIT stack are stglink:clone[] and the '--create' and '--clone'\n commands of stglink:branch[].\n \n-OPTIONS\n--------\n-\n-No specific options.\n-\n StGIT\n -----\n Part of the StGIT suite - see gitlink:stg[1].\ndiff --git a/Documentation/stg-new.txt b/Documentation/stg-new.txt\nindex 5775559..009659a 100644\n--- a/Documentation/stg-new.txt\n+++ b/Documentation/stg-new.txt\n@@ -9,7 +9,8 @@ stg-new - stgdesc:new[]\n \n SYNOPSIS\n --------\n-stg new [OPTIONS] <name>\n+[verse]\n+'stg' new [OPTIONS] <name>\n \n DESCRIPTION\n -----------\n@@ -20,6 +21,9 @@ is made the new top of the stack.  The local changes in the working\n tree are not included in the patch. A stglink:refresh[] command is\n needed for this.\n \n+The given <name> must be unique in the stack, and may only contain\n+alphanumeric characters, dashes and underscores.\n+\n An editor will be launched to edit the commit message to be used for\n the patch, unless the '--message' flag already specified one.  The\n 'patchdescr.tmpl' template file is used if available to pre-fill the\n@@ -57,11 +61,6 @@ described in gitlink:git-commit-tree[1].\n OPTIONS\n -------\n \n-<name>::\n-\tThe short name that will be used as to identify the patch in\n-\tother StGIT commands.  Must be unique in the stack.  May only\n-\tcontain alphanumeric characters, dashes and underscores.\n-\n --message=<message>::\n -m <message>::\n \tUse <message> as the patch description.\ndiff --git a/Documentation/stg.txt b/Documentation/stg.txt\nindex 47934a5..a91b600 100644\n--- a/Documentation/stg.txt\n+++ b/Documentation/stg.txt\n@@ -10,7 +10,9 @@ stg - manage stacks of patches using the GIT content tracker\n SYNOPSIS\n --------\n [verse]\n-'stg' [--version] [--help] <command> [OPTIONS] [ARGS]\n+'stg' [--version | --help]\n+'stg' [--help <command> | <command> --help]\n+'stg' <command> [COMMAND OPTIONS] [ARGS]\n \n DESCRIPTION\n -----------\n@@ -52,6 +54,10 @@ patches; there may be regular GIT commits below your stack base.\n OPTIONS\n -------\n \n+The following generic option flags are available.  Additional options\n+are available per-command, and documented in the command-specific\n+documentation.\n+\n --version::\n \tPrints the StGIT suite version that the 'stg' program came\n \tfrom, as well as version of other components used, such as GIT\n"},{"id":"38881","messageId":"20070408151216.8884.71420.stgit@gandelf.nowhere.earth","threadId":"7567","inReplyTo":"20070408150822.8884.67664.stgit@gandelf.nowhere.earth","subject":"[PATCH 3/3] Stop advertising 'pull' as the only operation blocked on protected stacks.","fromName":"Yann Dirson","fromEmail":"ydirson@altern.org","sentAt":"2007-04-08T15:12:16Z","receivedAt":"2007-04-08T15:12:16Z","isPatch":true,"sender":{"key":"ydirson@altern.org","avatar":"https://avatars.githubusercontent.com/u/1190950?v=4"},"body":"\n\n\nSigned-off-by: Yann Dirson <ydirson@altern.org>\n---\n\n stgit/commands/branch.py |    4 ++--\n 1 files changed, 2 insertions(+), 2 deletions(-)\n\ndiff --git a/stgit/commands/branch.py b/stgit/commands/branch.py\nindex eff0121..5f79f7e 100644\n--- a/stgit/commands/branch.py\n+++ b/stgit/commands/branch.py\n@@ -58,13 +58,13 @@ options = [make_option('-c', '--create',\n                        help = 'list branches contained in this repository',\n                        action = 'store_true'),\n            make_option('-p', '--protect',\n-                       help = 'prevent \"stg pull\" from modifying this branch',\n+                       help = 'prevent StGIT from modifying this branch',\n                        action = 'store_true'),\n            make_option('-r', '--rename',\n                        help = 'rename an existing development branch',\n                        action = 'store_true'),\n            make_option('-u', '--unprotect',\n-                       help = 'allow \"stg pull\" to modify this branch',\n+                       help = 'allow StGIT to modify this branch',\n                        action = 'store_true')]\n \n \n"}]}