[PATCH 0/3] WIP-8112 radosgw usage & man update

[PATCH 0/3] WIP-8112 radosgw usage & man update

[Abhishek Lekshmanan]

Hi,

This is a series of patches to update radosgw usage and man pages with
all the available help options. 1/3 is a minor format fix to display
the options in the same line.

Abhishek Lekshmanan (3):
  rgw: format help options to align with the rest
  rgw: list all available options during help()
  doc: update radosgw man page with available opts

 doc/man/8/radosgw.rst | 28 ++++++++++++++++++++++++++++
 src/rgw/rgw_main.cc   | 10 ++++++++--
 2 files changed, 36 insertions(+), 2 deletions(-)

-- 
1.9.1

Thanks,
         Abhishek

[PATCH 1/3] rgw: format help options to align with the rest

[Abhishek Lekshmanan]

Whitespace removal to make all help options align in a similar fashion

Signed-off-by: Abhishek Lekshmanan <abhishek.lekshmanan@gmail.com>
---
 src/rgw/rgw_main.cc | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/src/rgw/rgw_main.cc b/src/rgw/rgw_main.cc
index f6257d7..51cfebe 100644
--- a/src/rgw/rgw_main.cc
+++ b/src/rgw/rgw_main.cc
@@ -724,8 +724,8 @@ int usage()
 {
   cerr << "usage: radosgw [options...]" << std::endl;
   cerr << "options:\n";
-  cerr << "   --rgw-region=<region>     region in which radosgw runs\n";
-  cerr << "   --rgw-zone=<zone>         zone in which radosgw runs\n";
+  cerr << "  --rgw-region=<region>     region in which radosgw runs\n";
+  cerr << "  --rgw-zone=<zone>         zone in which radosgw runs\n";
   generic_server_usage();
   return 0;
 }
-- 
1.9.1

[PATCH 2/3] rgw: list all available options during help()

[Abhishek Lekshmanan]

Adding the available help arguments from the man page

Fixes: #8112
Signed-off-by: Abhishek Lekshmanan <abhishek.lekshmanan@gmail.com>
---
 src/rgw/rgw_main.cc | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/src/rgw/rgw_main.cc b/src/rgw/rgw_main.cc
index 51cfebe..29d6577 100644
--- a/src/rgw/rgw_main.cc
+++ b/src/rgw/rgw_main.cc
@@ -726,7 +726,13 @@ int usage()
   cerr << "options:\n";
   cerr << "  --rgw-region=<region>     region in which radosgw runs\n";
   cerr << "  --rgw-zone=<zone>         zone in which radosgw runs\n";
+  cerr << "  --rgw-socket-path=<path>  specify a unix domain socket path\n";
   generic_server_usage();
+  cerr << "  -m monaddress[:port]      connect to specified monitor\n";
+  cerr << "  --keyring=<path>          path to radosgw keyring\n";
+  cerr << "  --logfile=<logfile>       file to log debug output\n";
+  cerr << "  --debug-rgw=<log-level>/<memory-level>  Set radosgw debug level\n";
+
   return 0;
 }
 
-- 
1.9.1

[PATCH 3/3] doc: update radosgw man page with available opts

[Abhishek Lekshmanan]

Fixes:#8112
Signed-off-by: Abhishek Lekshmanan <abhishek.lekshmanan@gmail.com>
---
 doc/man/8/radosgw.rst | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/doc/man/8/radosgw.rst b/doc/man/8/radosgw.rst
index 5e5e3c0..7aa9655 100644
--- a/doc/man/8/radosgw.rst
+++ b/doc/man/8/radosgw.rst
@@ -32,10 +32,38 @@ Options
    Connect to specified monitor (instead of looking through
    ``ceph.conf``).
 
+.. option:: -i ID, --id ID
+
+   Set the ID portion of name for radosgw
+
+.. option:: -n TYPE.ID, --name TYPE.ID
+
+   Set the name for rados gateway (eg. client.radosgw.gateway)
+
+.. option:: --cluster NAME
+
+   Set the cluster name (default: ceph)
+
+.. option:: -d
+
+   Run in foreground, log to stderr
+
+.. option:: -f
+
+   Run in foreground, log to usual location
+
 .. option:: --rgw-socket-path=path
 
    Specify a unix domain socket path.
 
+.. option:: --rgw-region=region
+
+   The region where radosgw runs
+
+.. option:: --rgw-zone=zone
+
+   The zone where radosgw runs
+
 
 Configuration
 =============
-- 
1.9.1

Re: [PATCH 0/3] WIP-8112 radosgw usage & man update

[Yehuda Sadeh]

Applied (with very slight modifications).

Thanks,
Yehuda

On Thu, Jul 24, 2014 at 8:00 AM, Abhishek Lekshmanan
<abhishek.lekshmanan@gmail.com> wrote:
> Hi,
>
> This is a series of patches to update radosgw usage and man pages with
> all the available help options. 1/3 is a minor format fix to display
> the options in the same line.
>
> Abhishek Lekshmanan (3):
>   rgw: format help options to align with the rest
>   rgw: list all available options during help()
>   doc: update radosgw man page with available opts
>
>  doc/man/8/radosgw.rst | 28 ++++++++++++++++++++++++++++
>  src/rgw/rgw_main.cc   | 10 ++++++++--
>  2 files changed, 36 insertions(+), 2 deletions(-)
>
> --
> 1.9.1
>
> Thanks,
>          Abhishek
> --
> To unsubscribe from this list: send the line "unsubscribe ceph-devel" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH 0/3] WIP-8112 radosgw usage & man update

[Abhishek L]

[-- Attachment #1: Type: text/plain, Size: 692 bytes --]

Hi 

Actually there was a minor error in the above patchset, the help options
should have come before `generic_server_usage()` as the function exits
after that. I have updated this as a PR at https://github.com/ceph/ceph/pull/2248

This should hopefully close the issues http://tracker.ceph.com/issues/8112 
and related http://tracker.ceph.com/issues/8864. However as mentioned in #8112
teuthology shows some apache conf file location options being passed for
apache conf & rgw ops log etc. I'm not sure whether those (and a few
others options related to rgw seen in common/config_opts.h) should be
displayed in help. Let me know if any other options are to be documented
we can close this.


[-- Attachment #2.1: Type: text/plain, Size: 15 bytes --]

-- 
Abhishek

[-- Attachment #2.2: signature.asc --]
[-- Type: application/pgp-signature, Size: 472 bytes --]