Fixes to doc strings.

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>

diff --git a/stgit/commands/float.py b/stgit/commands/float.py
index 4da5f59..0e32f6b 100644 (file)
--- 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'
 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
 
 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 (file)
--- a/stgit/commands/init.py
+++ b/stgit/commands/init.py
@@ -24,15 +24,12 @@ from stgit.utils import *
 from stgit import stack, git
 
 
 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]
 
 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 = []
 
 
 options = []
 

diff --git a/stgit/commands/uncommit.py b/stgit/commands/uncommit.py
index 9798f19..0ee1585 100644 (file)
--- 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'
 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
 
 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