From e06c8743941a27c1a3f50396385268b9e812c32e Mon Sep 17 00:00:00 2001
From: Alistair Coles <alistair.coles@hpe.com>
Date: Wed, 25 Nov 2015 14:10:27 +0000
Subject: [PATCH] Improve swift-init usage statement

Clarify the behavior of strict and non-strict options.

Define what <server> and <config> specify on the command line.

Drive-by fix for missing param in search_tree docstring.

Change-Id: I89fff88a088bc73001464b1fa8240e14a61a117d
---
 bin/swift-init        | 24 +++++++++++++++++++-----
 swift/common/utils.py |  3 +++
 2 files changed, 22 insertions(+), 5 deletions(-)

diff --git a/bin/swift-init b/bin/swift-init
index 1037ce8eed..3fe18cdaa6 100755
--- a/bin/swift-init
+++ b/bin/swift-init
@@ -20,7 +20,21 @@ from optparse import OptionParser
 from swift.common.manager import Manager, UnknownCommandError, \
     KILL_WAIT, RUN_DIR
 
-USAGE = """%prog <server>[.config] [<server>[.config] ...] <command> [options]
+USAGE = \
+    """%prog <server>[.<config>] [<server>[.<config>] ...] <command> [options]
+
+where:
+    <server>  is the name of a swift service e.g. proxy-server.
+              The '-server' part of the name may be omitted.
+    <config>  is an explicit configuration filename without the
+              .conf extension. If <config> is specified then <server> should
+              refer to a directory containing the configuration file, e.g.:
+
+                  swift-init object.1 start
+
+              will start an object-server using the configuration file
+              /etc/swift/object-server/1.conf
+    <command> is a command from the list below.
 
 Commands:
 """ + '\n'.join(["%16s: %s" % x for x in Manager.list_commands()])
@@ -53,13 +67,13 @@ def main():
     # Changing behaviour if missing config
     parser.add_option('--strict', dest='strict', action='store_true',
                       help="Return non-zero status code if some config is "
-                           "missing. Default mode if server is explicitly "
-                           "named.")
+                           "missing. Default mode if all servers are "
+                           "explicitly named.")
     # a negative option for strict
     parser.add_option('--non-strict', dest='strict', action='store_false',
                       help="Return zero status code even if some config is "
-                           "missing. Default mode if server is one of aliases "
-                           "`all`, `main` or `rest`.")
+                           "missing. Default mode if any server is a glob or "
+                           "one of aliases `all`, `main` or `rest`.")
 
     options, args = parser.parse_args()
 
diff --git a/swift/common/utils.py b/swift/common/utils.py
index 554ab9e4fb..69aa0e8f50 100644
--- a/swift/common/utils.py
+++ b/swift/common/utils.py
@@ -2085,6 +2085,9 @@ def search_tree(root, glob_match, ext='', exts=None, dir_ext=None):
     :param glob_match: glob to match in root, matching dirs are traversed with
                        os.walk
     :param ext: only files that end in ext will be returned
+    :param exts: a list of file extensions; only files that end in one of these
+                 extensions will be returned; if set this list overrides any
+                 extension specified using the 'ext' param.
     :param dir_ext: if present directories that end with dir_ext will not be
                     traversed and instead will be returned as a matched path