doc: add ceph-kvstore-tool's man #17092
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tchaikov
reviewed
Aug 18, 2017
doc/man/8/ceph-kvstore-tool.rst
Outdated
| @@ -0,0 +1,79 @@ | |||
| orphan: | |||
doc/man/8/ceph-kvstore-tool.rst
Outdated
| Print all crc that belong to the prefix. | ||
|
|
||
| :command:`exists <prefix> [key]` | ||
| Query whether prefix or key is exist. |
There was a problem hiding this comment.
"exist" is a verb, not an adj.
might want to put:
Check if there is any KV pair stored with the URL encoded prefix. If
keyis also specified, check for thekeywith theprefixinstead.
doc/man/8/ceph-kvstore-tool.rst
Outdated
| Synopsis | ||
| ======== | ||
|
|
||
| | **ceph-kvstore-tool** <leveldb|rocksdb|bluestore-kv> <store path> command [args...] |
There was a problem hiding this comment.
use
*command*
as it is a metavar.
doc/man/8/ceph-kvstore-tool.rst
Outdated
| =========== | ||
|
|
||
| :program:`ceph-kvstore-tool` is a kvstore manipulation tool. It allows users to manipule | ||
| leveldb/rocksdb's data(likes OSD's omap) offline. |
There was a problem hiding this comment.
add a space before '('.
s/likes/like/
doc/man/8/ceph-kvstore-tool.rst
Outdated
| ======== | ||
|
|
||
| :program:`ceph-kvstore-tool` utility uses many commands for administration purpose | ||
| which are as follows: |
There was a problem hiding this comment.
s/administration/debugging/
liuchang0812
force-pushed
the
wip-man-kvstore-tool
branch
3 times, most recently
from
a932386
to
cdd0c59
Compare
|
make check succeeded |
@tchaikov thanks for your reviewing. updated |
|
jenkins test this please |
1 similar comment
|
jenkins test this please |
amitkumar50
reviewed
Aug 27, 2017
doc/man/8/ceph-kvstore-tool.rst
Outdated
|
|
||
| :command:`store-copy <path> [num-keys-per-tx]` | ||
| Copy all KV pairs to another directory specified by ``path``. | ||
| [num-keys-per-tx] is the number of KV pairs coped for a transaction. |
Signed-off-by: liuchang0812 <liuchang0812@gmail.com>
liuchang0812
force-pushed
the
wip-man-kvstore-tool
branch
from
cdd0c59
to
0667db4
Compare
liewegas
approved these changes
Aug 29, 2017
5 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: liuchang0812 liuchang0812@gmail.com