Documentation: added a doc for bbolt command-line. #540
Conversation
There was a problem hiding this comment.
Many thanks for pulling this together @ishan16696. Please see initial suggestions below 🙏🏻
|
Hi @jmhbnz , |
There was a problem hiding this comment.
Hey @ishan16696 - Thanks for making those changes, I think overall this is a great start.
A few more suggestions for you to consider but overall looks pretty good 👍🏻
| @@ -0,0 +1,374 @@ | |||
| # Introduction to bbolt command line | |||
There was a problem hiding this comment.
I see we have a mix of bbolt help and additional descriptions of command. Could we improve bbolt help at the same time? Just add the description you added to bbolt help
There was a problem hiding this comment.
Could we improve bbolt help at the same time? Just add the description you added to bbolt help
I didn't get it exactly, should I add a help command for every other command
bbolt <command> -h eg: bbolt info -h , Is this you are asking ?
There was a problem hiding this comment.
I have already mentioned this in help command:
you can use `help` with any command: `bbolt [command] -h` for more information about command.
There was a problem hiding this comment.
does it make sense to mention it separately as well ? I have no strong opinion. Either way is fine for me
Signed-off-by: Ishan Tyagi <[email protected]>
ishan16696
force-pushed
the
doc/bboltCLI
branch
from
eed0419
to
81634ce
Compare
|
The first draft doc is good enough, we can iterate on top of it in separate PRs. |
|
Thank you @ishan16696 ! |
This PR adds a document for basic bbolt CLI commands to inspect bbolt database.
Fix: #519
Note:
As mentioned in this comment: #519 (comment) I have not added
surgerycommand in this PR.