Skip to content

Commit

Permalink
rgw: modify documents and help infos' descriptions to the usage of op…
Browse files Browse the repository at this point in the history
…tion date when executing command "log show"

DOCUMENTATION #13235

This modification concerns documents and help infos. To the documents, we delete original incorrect instruction about the usage of the option date which induces user to type the
value of date in the format of "YYYY-MM-DD" when executing "log show" command, and we add the actual usage of "YYYY-MM-DD-hh". To the help infos, we add the NOTE to make user
notice that the usage of option date here is different with default's and of cource we give the right formatting.

Signed-off-by: Kongming Wu <wu.kongming@h3c.com>
  • Loading branch information
clever215 committed May 2, 2001
1 parent fd861bb commit f93fef1
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 1 deletion.
4 changes: 3 additions & 1 deletion doc/man/8/radosgw-admin.rst
Expand Up @@ -148,6 +148,7 @@ which are as follows:

:command:`log show`
Dump a log from specific object or (bucket + date + bucket-id).
(NOTE: required to specify formatting of date to "YYYY-MM-DD-hh")

:command:`log rm`
Remove log object.
Expand Down Expand Up @@ -436,7 +437,8 @@ Remove a bucket::

Show the logs of a bucket from April 1st, 2012::

$ radosgw-admin log show --bucket=foo --date=2012-04-01
$ radosgw-admin log show --bucket=foo \
--date=2012-04-01-01 --bucket-id=default.14193.1

Show usage information for user from March 1st to (but not including) April 1st, 2012::

Expand Down
2 changes: 2 additions & 0 deletions src/rgw/rgw_admin.cc
Expand Up @@ -87,6 +87,8 @@ void _usage()
cout << " log list list log objects\n";
cout << " log show dump a log from specific object or (bucket + date\n";
cout << " + bucket-id)\n";
cout << " (NOTE: required to specify formatting of date\n";
cout << " to \"YYYY-MM-DD-hh\")\n";
cout << " log rm remove log object\n";
cout << " usage show show usage (by user, date range)\n";
cout << " usage trim trim usage (by user, date range)\n";
Expand Down
2 changes: 2 additions & 0 deletions src/test/cli/radosgw-admin/help.t
Expand Up @@ -44,6 +44,8 @@
log list list log objects
log show dump a log from specific object or (bucket + date
+ bucket-id)
(NOTE: required to specify formatting of date
to "YYYY-MM-DD-hh")
log rm remove log object
usage show show usage (by user, date range)
usage trim trim usage (by user, date range)
Expand Down

0 comments on commit f93fef1

Please sign in to comment.