Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rgw: modify documents and help infos' descriptions to the usage of option date when executing command "log show" #6080

Merged
merged 1 commit into from Jan 8, 2016

Conversation

clever215
Copy link
Contributor

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

…tion date when executing command "log show"

DOCUMENTATION ceph#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>
@clever215 clever215 changed the title rgw: modify documents and help infos' descriptions to the usage of op… rgw: modify documents and help infos' descriptions to the usage of option date when executing command "log show" Sep 25, 2015
@smithfarm
Copy link
Contributor

Requiring the user to type YYYY-MM-DD-HH seems odd. If that is really required, I wonder if it is a bug that should be fixed instead of adapting the documentation to it.

@smithfarm
Copy link
Contributor

Also note that this does not pass "make check" (see bot failures, above - especially the "Console log" therein). It cannot be merged until that passes.

@clever215
Copy link
Contributor Author

@smithfarm I added this PR in Sept. and this Issue is existed. i.e. '-HH' (hour) must be appended.What weird is why loic-bot compiled failed, cause this part of codes does not change and I compiled successfully in local.

@clever215
Copy link
Contributor Author

@smithfarm log searching has its inside mechanism, which parameter 'YYYY-MM-DD-HH' will be transfered into timestamp as a key word. I try to repushed changes, now, this is not what i want to submit.

@smithfarm
Copy link
Contributor

@clever215 I'm not familiar with thehelp.t test but it appears that it is failing:

src/test/cli/radosgw-admin/help.t: failed
--- /home/jenkins/workspace/ceph/LABELS/ceph-centos-7-jenkins/src/test/cli/radosgw-admin/help.t
+++ ./src/test/cli/radosgw-admin/help.t.err
@@ -44,7 +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")
+                               (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)
# Ran 1 tests, 0 skipped, 1 failed.

@clever215
Copy link
Contributor Author

@smithfarm yeah, I see. radosgw-admin.cc and help.t are not in the same format that cause this failing.I try to fix it. Sorry about that!

@clever215
Copy link
Contributor Author

@smithfarm It's OK now!

@clever215
Copy link
Contributor Author

@smithfarm I wish it will be merged soon. Cause these notes mislead users for a long time.Happy weekends!

@clever215
Copy link
Contributor Author

@smithfarm Hi, How's that, I means this change?

@clever215
Copy link
Contributor Author

@yehudasa How do you think about this issue?

yehudasa added a commit that referenced this pull request Jan 8, 2016
rgw: modify documents and help infos' descriptions to the usage of option date when executing command "log show"

Reviewed-by: Yehuda Sadeh <yehuda@redhat.com>
@yehudasa yehudasa merged commit f854bb6 into ceph:master Jan 8, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants