From 54239abfc46cde2551435cf1cb777c702b31b2f5 Mon Sep 17 00:00:00 2001
From: =?utf8?q?Gustav=20H=C3=A5llberg?= <gustav@virtutech.com>
Date: Fri, 29 Jan 2010 15:48:22 +0100
Subject: [PATCH] improve "usage" strings to include optional "--"
MIME-Version: 1.0
Content-Type: text/plain; charset=utf8
Content-Transfer-Encoding: 8bit

Signed-off-by: Gustav HÃ¥llberg <gustav@virtutech.com>
---
 stgit/commands/branch.py   | 16 ++++++++--------
 stgit/commands/commit.py   |  2 +-
 stgit/commands/delete.py   |  2 +-
 stgit/commands/diff.py     |  2 +-
 stgit/commands/edit.py     |  2 +-
 stgit/commands/export.py   |  2 +-
 stgit/commands/files.py    |  2 +-
 stgit/commands/float.py    |  2 +-
 stgit/commands/fold.py     |  2 +-
 stgit/commands/goto.py     |  2 +-
 stgit/commands/hide.py     |  2 +-
 stgit/commands/id.py       |  2 +-
 stgit/commands/imprt.py    |  2 +-
 stgit/commands/log.py      |  2 +-
 stgit/commands/mail.py     |  2 +-
 stgit/commands/new.py      |  2 +-
 stgit/commands/patches.py  |  2 +-
 stgit/commands/pick.py     |  2 +-
 stgit/commands/pop.py      |  2 +-
 stgit/commands/publish.py  |  2 +-
 stgit/commands/pull.py     |  2 +-
 stgit/commands/push.py     |  2 +-
 stgit/commands/rebase.py   |  2 +-
 stgit/commands/refresh.py  |  2 +-
 stgit/commands/rename.py   |  2 +-
 stgit/commands/reset.py    |  2 +-
 stgit/commands/series.py   |  2 +-
 stgit/commands/show.py     |  2 +-
 stgit/commands/sink.py     |  2 +-
 stgit/commands/squash.py   |  2 +-
 stgit/commands/status.py   |  2 +-
 stgit/commands/sync.py     |  2 +-
 stgit/commands/uncommit.py |  4 ++--
 stgit/commands/unhide.py   |  2 +-
 34 files changed, 42 insertions(+), 42 deletions(-)

diff --git a/stgit/commands/branch.py b/stgit/commands/branch.py
index 8748c0a..614c3ae 100644
--- a/stgit/commands/branch.py
+++ b/stgit/commands/branch.py
@@ -26,15 +26,15 @@ from stgit.lib import log
 help = 'Branch operations: switch, list, create, rename, delete, ...'
 kind = 'stack'
 usage = ['',
-         '<branch>',
+         '[--] <branch>',
          '--list',
-         '--create <new-branch> [<committish>]',
-         '--clone [<new-branch>]',
-         '--rename <old-name> <new-name>',
-         '--protect [<branch>]',
-         '--unprotect [<branch>]',
-         '--delete [--force] <branch>',
-         '--description=<description> [<branch>]']
+         '--create [--] <new-branch> [<committish>]',
+         '--clone [--] [<new-branch>]',
+         '--rename [--] <old-name> <new-name>',
+         '--protect [--] [<branch>]',
+         '--unprotect [--] [<branch>]',
+         '--delete [--force] [--] <branch>',
+         '--description=<description> [--] [<branch>]']
 description = """
 Create, clone, switch between, rename, or delete development branches
 within a git repository.
diff --git a/stgit/commands/commit.py b/stgit/commands/commit.py
index dd8d6e6..7bdd8c6 100644
--- a/stgit/commands/commit.py
+++ b/stgit/commands/commit.py
@@ -24,7 +24,7 @@ from stgit import argparse
 help = 'Permanently store the applied patches into the stack base'
 kind = 'stack'
 usage = ['',
-         '<patchnames>',
+         '[--] <patchnames>',
          '-n NUM',
          '--all']
 description = """
diff --git a/stgit/commands/delete.py b/stgit/commands/delete.py
index fdcb5c9..b656a87 100644
--- a/stgit/commands/delete.py
+++ b/stgit/commands/delete.py
@@ -23,7 +23,7 @@ from stgit import argparse
 
 help = 'Delete patches'
 kind = 'patch'
-usage = ['[options] <patch1> [<patch2>] [<patch3>..<patch4>]']
+usage = ['[options] [--] <patch1> [<patch2>] [<patch3>..<patch4>]']
 description = """
 Delete the patches passed as arguments."""
 
diff --git a/stgit/commands/diff.py b/stgit/commands/diff.py
index 631e42d..05bf297 100644
--- a/stgit/commands/diff.py
+++ b/stgit/commands/diff.py
@@ -27,7 +27,7 @@ from stgit.lib import git as gitlib
 
 help = 'Show the tree diff'
 kind = 'wc'
-usage = ['[options] [<files or dirs>]']
+usage = ['[options] [--] [<files or dirs>]']
 description = """
 Show the diff (default) or diffstat between the current working copy
 or a tree-ish object and another tree-ish object (defaulting to HEAD).
diff --git a/stgit/commands/edit.py b/stgit/commands/edit.py
index 42eb792..f3f731f 100644
--- a/stgit/commands/edit.py
+++ b/stgit/commands/edit.py
@@ -26,7 +26,7 @@ from stgit.out import *
 
 help = 'edit a patch description or diff'
 kind = 'patch'
-usage = ['[options] [<patch>]']
+usage = ['[options] [--] [<patch>]']
 description = """
 Edit the description and author information of the given patch (or the
 current patch if no patch name was given). With --diff, also edit the
diff --git a/stgit/commands/export.py b/stgit/commands/export.py
index 1236b01..4285612 100644
--- a/stgit/commands/export.py
+++ b/stgit/commands/export.py
@@ -28,7 +28,7 @@ from stgit.lib import git as gitlib
 
 help = 'Export patches to a directory'
 kind = 'patch'
-usage = ['[options] [<patch1>] [<patch2>] [<patch3>..<patch4>]']
+usage = ['[options] [--] [<patch1>] [<patch2>] [<patch3>..<patch4>]']
 description = """
 Export a range of applied patches to a given directory (defaults to
 'patches-<branch>') in a standard unified GNU diff format. A template
diff --git a/stgit/commands/files.py b/stgit/commands/files.py
index a2ed6a2..7d56b53 100644
--- a/stgit/commands/files.py
+++ b/stgit/commands/files.py
@@ -26,7 +26,7 @@ from stgit.lib import git as gitlib
 
 help = 'Show the files modified by a patch (or the current patch)'
 kind = 'patch'
-usage = ['[options] [[<branch>:]<patch>]']
+usage = ['[options] [--] [[<branch>:]<patch>]']
 description = """
 List the files modified by the given patch (defaulting to the current
 one). Passing the '--stat' option shows the diff statistics for the
diff --git a/stgit/commands/float.py b/stgit/commands/float.py
index 9316398..bb89567 100644
--- a/stgit/commands/float.py
+++ b/stgit/commands/float.py
@@ -25,7 +25,7 @@ from stgit import argparse
 
 help = 'Push patches to the top, even if applied'
 kind = 'stack'
-usage = ['<patches>',
+usage = ['[--] <patches>',
          '-s <series>']
 description = """
 Push a patch or a range of patches to the top even if applied. The
diff --git a/stgit/commands/fold.py b/stgit/commands/fold.py
index ce0459e..4e3afbf 100644
--- a/stgit/commands/fold.py
+++ b/stgit/commands/fold.py
@@ -24,7 +24,7 @@ from stgit import argparse, stack, git
 
 help = 'Integrate a GNU diff patch into the current patch'
 kind = 'patch'
-usage = ['[options] [<file>]']
+usage = ['[options] [--] [<file>]']
 description = """
 Apply the given GNU diff file (or the standard input) onto the top of
 the current patch. With the '--threeway' option, the patch is applied
diff --git a/stgit/commands/goto.py b/stgit/commands/goto.py
index 839b75c..d201a91 100644
--- a/stgit/commands/goto.py
+++ b/stgit/commands/goto.py
@@ -22,7 +22,7 @@ from stgit.argparse import opt
 
 help = 'Push or pop patches to the given one'
 kind = 'stack'
-usage = ['<patch-name>']
+usage = ['[options] [--] <patch-name>']
 description = """
 Push/pop patches to/from the stack until the one given on the command
 line becomes current."""
diff --git a/stgit/commands/hide.py b/stgit/commands/hide.py
index 54b0df8..dfb6b6f 100644
--- a/stgit/commands/hide.py
+++ b/stgit/commands/hide.py
@@ -22,7 +22,7 @@ from stgit.argparse import opt
 
 help = 'Hide a patch in the series'
 kind = 'stack'
-usage = ['[options] <patch-range>']
+usage = ['[options] [--] <patch-range>']
 description = """
 Hide a range of unapplied patches so that they are no longer shown in
 the plain 'series' command output."""
diff --git a/stgit/commands/id.py b/stgit/commands/id.py
index 654ff72..dc3d249 100644
--- a/stgit/commands/id.py
+++ b/stgit/commands/id.py
@@ -22,7 +22,7 @@ from stgit import argparse
 
 help = 'Print the git hash value of a StGit reference'
 kind = 'repo'
-usage = ['[options] [id]']
+usage = ['[options] [--] [<id>]']
 description = """
 Print the SHA1 value of a Git id (defaulting to HEAD). In addition to the
 standard Git id's like heads and tags, this command also accepts
diff --git a/stgit/commands/imprt.py b/stgit/commands/imprt.py
index a2d0e50..1b12f39 100644
--- a/stgit/commands/imprt.py
+++ b/stgit/commands/imprt.py
@@ -27,7 +27,7 @@ from stgit import argparse, stack, git
 name = 'import'
 help = 'Import a GNU diff file as a new patch'
 kind = 'patch'
-usage = ['[options] [<file>|<url>]']
+usage = ['[options] [--] [<file>|<url>]']
 description = """
 Create a new patch and apply the given GNU diff file (or the standard
 input). By default, the file name is used as the patch name but this
diff --git a/stgit/commands/log.py b/stgit/commands/log.py
index 92aaf0b..b028f52 100644
--- a/stgit/commands/log.py
+++ b/stgit/commands/log.py
@@ -28,7 +28,7 @@ from stgit.out import out
 
 help = 'Display the patch changelog'
 kind = 'stack'
-usage = ['[options] [<patches>]']
+usage = ['[options] [--] [<patches>]']
 description = """
 List the history of the patch stack: the stack log. If one or more
 patch names are given, limit the list to the log entries that touch
diff --git a/stgit/commands/mail.py b/stgit/commands/mail.py
index abd42e4..e0da9f3 100644
--- a/stgit/commands/mail.py
+++ b/stgit/commands/mail.py
@@ -28,7 +28,7 @@ from stgit.lib import git as gitlib
 
 help = 'Send a patch or series of patches by e-mail'
 kind = 'patch'
-usage = [' [options] [<patch1>] [<patch2>] [<patch3>..<patch4>]']
+usage = [' [options] [--] [<patch1>] [<patch2>] [<patch3>..<patch4>]']
 description = r"""
 Send a patch or a range of patches by e-mail using the SMTP server
 specified by the 'stgit.smtpserver' configuration option, or the
diff --git a/stgit/commands/new.py b/stgit/commands/new.py
index 741508a..d5c5382 100644
--- a/stgit/commands/new.py
+++ b/stgit/commands/new.py
@@ -23,7 +23,7 @@ from stgit.config import config
 
 help = 'Create a new, empty patch'
 kind = 'patch'
-usage = ['[options] [<name>]']
+usage = ['[options] [--] [<name>]']
 description = """
 Create a new, empty patch on the current stack. The new patch is
 created on top of the currently applied patches, and is made the new
diff --git a/stgit/commands/patches.py b/stgit/commands/patches.py
index 54fac21..b9508a3 100644
--- a/stgit/commands/patches.py
+++ b/stgit/commands/patches.py
@@ -25,7 +25,7 @@ from stgit import argparse, stack, git
 
 help = 'Show the applied patches modifying a file'
 kind = 'stack'
-usage = ['[options] [<files or dirs>]']
+usage = ['[options] [--] [<files or dirs>]']
 description = """
 Show the applied patches modifying the given files. Without arguments,
 it shows the patches affected by the local tree modifications. The
diff --git a/stgit/commands/pick.py b/stgit/commands/pick.py
index e8bafa9..8414702 100644
--- a/stgit/commands/pick.py
+++ b/stgit/commands/pick.py
@@ -25,7 +25,7 @@ from stgit.stack import Series
 
 help = 'Import a patch from a different branch or a commit object'
 kind = 'patch'
-usage = ['[options] ([<patch1>] [<patch2>] [<patch3>..<patch4>])|<commit>']
+usage = ['[options] [--] ([<patch1>] [<patch2>] [<patch3>..<patch4>])|<commit>']
 description = """
 Import one or more patches from a different branch or a commit object
 into the current series. By default, the name of the imported patch is
diff --git a/stgit/commands/pop.py b/stgit/commands/pop.py
index deb7290..f67cc0a 100644
--- a/stgit/commands/pop.py
+++ b/stgit/commands/pop.py
@@ -23,7 +23,7 @@ from stgit.argparse import opt
 
 help = 'Pop one or more patches from the stack'
 kind = 'stack'
-usage = ['[options] [<patch1>] [<patch2>] [<patch3>..<patch4>]']
+usage = ['[options] [--] [<patch1>] [<patch2>] [<patch3>..<patch4>]']
 description = """
 Pop the topmost patch or a range of patches from the stack. The
 command fails if there are conflicts or local changes (and --keep was
diff --git a/stgit/commands/publish.py b/stgit/commands/publish.py
index 391a6a2..93e4d28 100644
--- a/stgit/commands/publish.py
+++ b/stgit/commands/publish.py
@@ -25,7 +25,7 @@ from stgit import utils
 
 help = 'Push the stack changes to a merge-friendly branch'
 kind = 'stack'
-usage = ['[options] [branch]']
+usage = ['[options] [--] [branch]']
 description = """
 This command commits a set of changes on a separate (called public) branch
 based on the modifications of the given or current stack. The history of the
diff --git a/stgit/commands/pull.py b/stgit/commands/pull.py
index f6d1398..8b09b40 100644
--- a/stgit/commands/pull.py
+++ b/stgit/commands/pull.py
@@ -25,7 +25,7 @@ from stgit import argparse, stack, git
 
 help = 'Pull changes from a remote repository'
 kind = 'stack'
-usage = ['[options] [<repository>]']
+usage = ['[options] [--] [<repository>]']
 description = """
 Pull the latest changes from the given remote repository (defaulting
 to branch.<name>.remote, or 'origin' if not set). This command works
diff --git a/stgit/commands/push.py b/stgit/commands/push.py
index 7ec7d08..3dc9c8c 100644
--- a/stgit/commands/push.py
+++ b/stgit/commands/push.py
@@ -23,7 +23,7 @@ from stgit.argparse import opt
 
 help = 'Push one or more patches onto the stack'
 kind = 'stack'
-usage = ['[options] [<patch1>] [<patch2>] [<patch3>..<patch4>]']
+usage = ['[options] [--] [<patch1>] [<patch2>] [<patch3>..<patch4>]']
 description = """
 Push one or more patches (defaulting to the first unapplied one) onto
 the stack. The 'push' operation allows patch reordering by commuting
diff --git a/stgit/commands/rebase.py b/stgit/commands/rebase.py
index b949a5c..53ad1ea 100644
--- a/stgit/commands/rebase.py
+++ b/stgit/commands/rebase.py
@@ -23,7 +23,7 @@ from stgit import argparse, stack, git
 
 help = 'Move the stack base to another point in history'
 kind = 'stack'
-usage = ['[options] <new-base-id>']
+usage = ['[options] [--] <new-base-id>']
 description = """
 Pop all patches from current stack, move the stack base to the given
 <new-base-id> and push the patches back.
diff --git a/stgit/commands/refresh.py b/stgit/commands/refresh.py
index c5a0aeb..ca68bbe 100644
--- a/stgit/commands/refresh.py
+++ b/stgit/commands/refresh.py
@@ -26,7 +26,7 @@ from stgit import argparse, utils
 
 help = 'Generate a new commit for the current patch'
 kind = 'patch'
-usage = ['[options] [<files or dirs>]']
+usage = ['[options] [--] [<files or dirs>]']
 description = """
 Include the latest work tree and index changes in the current patch.
 This command generates a new git commit object for the patch; the old
diff --git a/stgit/commands/rename.py b/stgit/commands/rename.py
index 8a593ac..db898cb 100644
--- a/stgit/commands/rename.py
+++ b/stgit/commands/rename.py
@@ -24,7 +24,7 @@ from stgit import argparse, stack, git
 
 help = 'Rename a patch'
 kind = 'patch'
-usage = ['[options] [oldpatch] <newpatch>']
+usage = ['[options] [--] [oldpatch] <newpatch>']
 description = """
 Rename <oldpatch> into <newpatch> in a series. If <oldpatch> is not
 given, the top-most patch will be renamed."""
diff --git a/stgit/commands/reset.py b/stgit/commands/reset.py
index 7dfd4a0..f47bfce 100644
--- a/stgit/commands/reset.py
+++ b/stgit/commands/reset.py
@@ -25,7 +25,7 @@ from stgit import argparse
 
 help = 'Reset the patch stack to an earlier state'
 kind = 'stack'
-usage = ['[options] <state> [<patchnames>]']
+usage = ['[options] [--] <state> [<patchnames>]']
 description = """
 Reset the patch stack to an earlier state. The state is specified with
 a commit id from a stack log; "stg log" lets you view this log, and
diff --git a/stgit/commands/series.py b/stgit/commands/series.py
index 5873801..f3d3f83 100644
--- a/stgit/commands/series.py
+++ b/stgit/commands/series.py
@@ -25,7 +25,7 @@ from stgit import argparse
 
 help = 'Print the patch series'
 kind = 'stack'
-usage = ['[options] [<patch-range>]']
+usage = ['[options] [--] [<patch-range>]']
 description = """
 Show all the patches in the series, or just those in the given range,
 ordered from top to bottom.
diff --git a/stgit/commands/show.py b/stgit/commands/show.py
index 45c3a56..aaa46c4 100644
--- a/stgit/commands/show.py
+++ b/stgit/commands/show.py
@@ -24,7 +24,7 @@ from stgit.lib import git as gitlib
 
 help = 'Show the commit corresponding to a patch'
 kind = 'patch'
-usage = ['[options] [<patch1>] [<patch2>] [<patch3>..<patch4>]']
+usage = ['[options] [--] [<patch1>] [<patch2>] [<patch3>..<patch4>]']
 description = """
 Show the commit log and the diff corresponding to the given patches.
 The output is similar to that generated by 'git show'."""
diff --git a/stgit/commands/sink.py b/stgit/commands/sink.py
index 4677a75..eadc27d 100644
--- a/stgit/commands/sink.py
+++ b/stgit/commands/sink.py
@@ -23,7 +23,7 @@ from stgit import argparse
 
 help = 'Send patches deeper down the stack'
 kind = 'stack'
-usage = ['[-t <target patch>] [-n] [<patches>]']
+usage = ['[-t <target patch>] [-n] [--] [<patches>]']
 description = """
 This is the opposite operation of linkstg:float[]: move the specified
 patches down the stack.  It is for example useful to group stable
diff --git a/stgit/commands/squash.py b/stgit/commands/squash.py
index 96b8da2..261b264 100644
--- a/stgit/commands/squash.py
+++ b/stgit/commands/squash.py
@@ -25,7 +25,7 @@ from stgit.lib import git, transaction
 
 help = 'Squash two or more patches into one'
 kind = 'stack'
-usage = ['[options] <patches>']
+usage = ['[options] [--] <patches>']
 description = """
 Squash two or more patches, creating one big patch that contains all
 their changes. In more detail:
diff --git a/stgit/commands/status.py b/stgit/commands/status.py
index 730b47c..8ea6526 100644
--- a/stgit/commands/status.py
+++ b/stgit/commands/status.py
@@ -24,7 +24,7 @@ from stgit import argparse, stack, git
 
 help = 'Show the tree status'
 kind = 'wc'
-usage = ['[options] [<files or dirs>]']
+usage = ['[options] [--] [<files or dirs>]']
 description = """
 Show the status of the whole working copy or the given files. The
 command also shows the files in the current directory which are not
diff --git a/stgit/commands/sync.py b/stgit/commands/sync.py
index ea949d6..d765aa6 100644
--- a/stgit/commands/sync.py
+++ b/stgit/commands/sync.py
@@ -25,7 +25,7 @@ from stgit import argparse, stack, git
 
 help = 'Synchronise patches with a branch or a series'
 kind = 'patch'
-usage = ['[options] [<patch1>] [<patch2>] [<patch3>..<patch4>]']
+usage = ['[options] [--] [<patch1>] [<patch2>] [<patch3>..<patch4>]']
 description = """
 For each of the specified patches perform a three-way merge with the
 same patch in the specified branch or series. The command can be used
diff --git a/stgit/commands/uncommit.py b/stgit/commands/uncommit.py
index bcc8bac..72ba88c 100644
--- a/stgit/commands/uncommit.py
+++ b/stgit/commands/uncommit.py
@@ -25,8 +25,8 @@ from stgit import argparse, utils
 
 help = 'Turn regular git commits into StGit patches'
 kind = 'stack'
-usage = ['<patch-name-1> [<patch-name-2> ...]',
-         '-n NUM [<prefix>]',
+usage = ['[--] <patch-name-1> [<patch-name-2> ...]',
+         '-n NUM [--] [<prefix>]',
          '-t <committish> [-x]']
 description = """
 Take one or more git commits at the base of the current stack and turn
diff --git a/stgit/commands/unhide.py b/stgit/commands/unhide.py
index 656ddea..89750e2 100644
--- a/stgit/commands/unhide.py
+++ b/stgit/commands/unhide.py
@@ -22,7 +22,7 @@ from stgit.argparse import opt
 
 help = 'Unhide a hidden patch'
 kind = 'stack'
-usage = ['[options] <patch-range>']
+usage = ['[options] [--] <patch-range>']
 description = """
 Unhide a hidden range of patches so that they are shown in the plain
 'stg series' command output."""
-- 
2.11.0