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: mention --show-mappings in crushtool manpage #14599

Merged
1 commit merged into from Apr 19, 2017

Conversation

Projects
None yet
1 participant
@smithfarm
Contributor

smithfarm commented Apr 18, 2017

@smithfarm smithfarm requested a review from Apr 18, 2017

@ghost

This comment has been minimized.

ghost commented Apr 18, 2017

--show-mappings shows the mapping for each value, one line per value

@smithfarm

This comment has been minimized.

Contributor

smithfarm commented Apr 18, 2017

@dachary What is a "value" in this context?

@smithfarm

This comment has been minimized.

Contributor

smithfarm commented Apr 18, 2017

Hmm, looking at the crushtool --help output and comparing with the manpage, it would seem there is more work here than just mentioning --show-mappings.

@smithfarm

This comment has been minimized.

Contributor

smithfarm commented Apr 18, 2017

For instance, the manpage says "The tool has four modes of operation: --compile, --decompile, --build, and --test", but the usage documentation in the source code does not support this at all.

@ghost

This comment has been minimized.

ghost commented Apr 18, 2017

What is a "value" in this context

It is the value of x which goes from --min-x (default to 0) to --max-x (defaults to 1023) unless it is set explicitly with --x

@smithfarm smithfarm changed the title from [DNM] doc: mention --show-mappings in crushtool manpage to doc: mention --show-mappings in crushtool manpage Apr 18, 2017

@smithfarm

This comment has been minimized.

Contributor

smithfarm commented Apr 18, 2017

@dachary How about now?

@ghost

This comment has been minimized.

ghost commented Apr 18, 2017

Note: Each Placement Group (PG) has an integer ID which can be obtained +from ceph pg dump (for example PG 2.2f means pool id 2, PG id 32). The pool id and the PG ID are combined by a function to get a value which is given to CRUSH to map it to OSDs. crushtool does not know about PG or pools and only runs simulations by mapping values in the range [--min-x,--max-x]

Displays the mappings for a range of PG ids (the bounds of which are
``--min-x``, which defaults to 0, and ``--max-x``, which defaults to
1023) or an individual PG id specified by ``--x``. For example::

This comment has been minimized.

@ghost

ghost Apr 18, 2017

I would just write "Display the mapping of each value. For example:". I don't think it's a good idea to mention PG ids at all in this context.

@smithfarm

This comment has been minimized.

Contributor

smithfarm commented Apr 18, 2017

@dachary Please go over it once more.

doc: mention --show-mappings in crushtool manpage
Fixes: http://tracker.ceph.com/issues/19649
Signed-off-by: Loic Dachary <ldachary@redhat.com>
Signed-off-by: Nathan Cutler <ncutler@suse.com>
@smithfarm

This comment has been minimized.

Contributor

smithfarm commented Apr 18, 2017

(added tracker URL)

@ghost

ghost approved these changes Apr 18, 2017

@ghost

This comment has been minimized.

ghost commented Apr 18, 2017

the help output is verified by a test, I suspect that's what causes the failure

@smithfarm

This comment has been minimized.

Contributor

smithfarm commented Apr 18, 2017

This PR only modifies the manpage, not the help output.

@smithfarm

This comment has been minimized.

Contributor

smithfarm commented Apr 18, 2017

Jenkins re-test this please

99% tests passed, 1 tests failed out of 166

Total Test time (real) = 1397.12 sec

The following tests FAILED:
	149 - osd-fast-mark-down.sh (Failed)
@smithfarm

This comment has been minimized.

Contributor

smithfarm commented Apr 19, 2017

@dachary Tests passed; OK to merge?

@ghost ghost merged commit 0011127 into ceph:master Apr 19, 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

@smithfarm smithfarm deleted the smithfarm:wip-crushtool-mappings branch Apr 19, 2017

This issue was closed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment