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

doc: fix a typo #13930

Merged
merged 1 commit into from Mar 16, 2017

Conversation

Projects
None yet
2 participants
@drunkard
Contributor

drunkard commented Mar 13, 2017

No description provided.

| --statedir PATH directory in which ceph state is preserved (default /var/lib/ceph)
| --sysconfdir PATH directory in which ceph configuration files are found (default /etc/ceph)
| --setuser USER use the given user for subprocesses, rather than ceph or root
| --setgroup GROUP use the given group for subprocesses, rather than ceph or root

This comment has been minimized.

@tchaikov

tchaikov Mar 15, 2017

Contributor

we should either use ".. options::" directive or just put --option without any indent.

i am posting #13969 to address this. could you help review it?

This comment has been minimized.

@drunkard

drunkard Mar 16, 2017

Contributor

It used to be, changed format refer to ceph-disk --help, the commit was:

commit d355a38
Author: Loic Dachary ldachary@redhat.com
Date: Thu Feb 25 17:20:54 2016 +0700

doc: update ceph-disk to refer to ceph-disk --help

The ceph-disk page is often obsolete, mostly because maintaining
it requires a significant amount of copy/paste and re-formatting.
Now that the --help of ceph-disk has been updated to include a more
verbose explanation of each subcommand, simplify the man page to
give an overview of the subcommands and suggest the --help is used
to get more information.

Signed-off-by: Loic Dachary <loic@dachary.org>

This comment has been minimized.

@drunkard

drunkard Mar 16, 2017

Contributor

So, I should revoke this commit?

I still didn't get why people applied d355a38, just because it's out of maintaince? To me current version is too short, not that easy to understand.

This comment has been minimized.

@tchaikov

tchaikov Mar 16, 2017

Contributor

i'd recommend drop this commit. please refer to the commit message of d355a38.

This comment has been minimized.

@drunkard

drunkard Mar 16, 2017

Contributor

OK, dropped. Thanks for reviewing. :)

destroy Destroy a Ceph OSD
zap Zap/erase/destroy a device's partition table (and contents)
trigger Trigger an event (caled by udev)
| prepare Prepare a directory or disk for a Ceph OSD

This comment has been minimized.

@tchaikov

tchaikov Mar 15, 2017

Contributor

likewise, we should not formatting using |. sphinx can take care of this, see #13969.

This comment has been minimized.

@drunkard

drunkard Mar 16, 2017

Contributor

But without | the html output merged these to one line, how should this be fixed?

This comment has been minimized.

@tchaikov

tchaikov Mar 16, 2017

Contributor

in #13969, i am using "definition-list" to document the subcommand. they are not cluttered into a single line, you can test by building the html.

http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#definition-lists

@@ -488,7 +488,7 @@ default pools.
you create a new pool, its default ruleset is ``0``.
CRUSH rules defines placement and replication strategies or distribution policies
CRUSH rules defines placement and replication strategies or distribution policies

This comment has been minimized.

@tchaikov

tchaikov Mar 15, 2017

Contributor

i think it should be "define" not "defines"

This comment has been minimized.

@drunkard

drunkard Mar 16, 2017

Contributor

Sorry, wasn't noticed that, updated.

doc: typo fix in rados/operations/crush-map
Signed-off-by: Drunkard Zhang <gongfan193@gmail.com>

@tchaikov tchaikov changed the title from doc: minor fixes about formats and typos to doc: minor a typo Mar 16, 2017

@tchaikov tchaikov changed the title from doc: minor a typo to doc: fix a typo Mar 16, 2017

@tchaikov tchaikov merged commit f2499ad into ceph:master Mar 16, 2017

3 checks passed

Signed-off-by all commits in this PR are signed
Details
Unmodifed Submodules submodules for project are unmodified
Details
default Build finished.
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment