From: Yann Dirson <ydirson@altern.org>
To: Catalin Marinas <catalin.marinas@gmail.com>
Cc: git@vger.kernel.org
Subject: [PATCH] Fixes to doc strings.
Date: Thu, 01 Feb 2007 23:28:28 +0100 [thread overview]
Message-ID: <20070201222752.29383.56882.stgit@gandelf.nowhere.earth> (raw)
At least the docstring for "branch" is still very confusing, but
that's hard to fix. We'll likely have to wait for the post-1.0
command-line redesign.
Signed-off-by: Yann Dirson <ydirson@altern.org>
---
stgit/commands/float.py | 2 +-
stgit/commands/init.py | 11 ++++-------
stgit/commands/uncommit.py | 2 +-
3 files changed, 6 insertions(+), 9 deletions(-)
diff --git a/stgit/commands/float.py b/stgit/commands/float.py
index 4da5f59..0e32f6b 100644
--- a/stgit/commands/float.py
+++ b/stgit/commands/float.py
@@ -24,7 +24,7 @@ from stgit.utils import *
from stgit import stack, git
help = 'push patches to the top, even if applied'
-usage = """%prog [options] [<patches> | <series>]
+usage = """%prog [<patches> | -s [<series>] ]
Push a patch or a range of patches to the top even if applied. The
necessary pop and push operations will be performed to accomplish
diff --git a/stgit/commands/init.py b/stgit/commands/init.py
index 0326f9a..df2235f 100644
--- a/stgit/commands/init.py
+++ b/stgit/commands/init.py
@@ -24,15 +24,12 @@ from stgit.utils import *
from stgit import stack, git
-help = 'initialise the tree for use with StGIT'
+help = 'initialise the current branch for use with StGIT'
usage = """%prog [options]
-Initialise a GIT repository to be used with StGIT. Note that the
-repository must be already initialised with git-init-db and the
-.git/HEAD link must point to a valid file in refs/heads/. For people
-switching between multiple branches in the same repository, the 'init'
-command has to be run on all the individual branches intended to be
-used with StGIT."""
+Initialise the current GIT branch to be used as an StGIT stack. Note
+that the you must already be in a GIT repository and .git/HEAD must
+point to a valid file in refs/heads/."""
options = []
diff --git a/stgit/commands/uncommit.py b/stgit/commands/uncommit.py
index 9798f19..0ee1585 100644
--- a/stgit/commands/uncommit.py
+++ b/stgit/commands/uncommit.py
@@ -25,7 +25,7 @@ from stgit.utils import *
from stgit import stack, git
help = 'turn regular GIT commits into StGIT patches'
-usage = """%prog [options] [<patchname1> [<patchname2> ... ]]
+usage = """%prog [<patchname1> [<patchname2> ... ] | -n [<prefix>]]
Take one or more git commits at the base of the current stack and turn
them into StGIT patches. The new patches are created as applied patches
reply other threads:[~2007-02-01 22:29 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20070201222752.29383.56882.stgit@gandelf.nowhere.earth \
--to=ydirson@altern.org \
--cc=catalin.marinas@gmail.com \
--cc=git@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).