Improve the help message for commands

[stgit] / stgit / commands / new.py

diff --git a/stgit/commands/new.py b/stgit/commands/new.py
index c36e109..9efecc1 100644 (file)
--- a/stgit/commands/new.py
+++ b/stgit/commands/new.py
@@ -25,7 +25,14 @@ from stgit import stack, git
 
 
 help = 'create a new patch and make it the topmost one'
-usage = '%prog [options] <name>'
+usage = """%prog [options] <name>
+
+Create a new, empty patch and make it the topmost one. If the
+'--message' option is not passed, an editor is invoked with the
+.git/patchdescr.tmpl file used a as template, together with generated
+lines. By default, if there are local changes in the working tree, the
+command fails and a 'refresh' command is needed. This behaviour can be
+overridden with the '--force' option."""
 
 options = [make_option('-m', '--message',
                        help = 'use MESSAGE as the patch description'),