Improve man and documentation #56
Description
Description
Seems to me that actually man of blksnap tool and documentation is "minimal" and for understand how to use it "fast" is need for example to look to tests scripts and in some cases require also looking at the source code to understand better.
I think can be useful to improve man and blksnap help texts to make easier and faster do common blksnap usage. It might also be helpful to do some small howto's of some common usage examples.
Looking for example the man recently added in stable-2.0 an explanation could be made regarding "stretch_snapshot" which I think is quite important. "snapshot_create" and "snapshot_add" they would seem unclear at first glance, they don't take the actual snapshot (done by "snapshot_take") but they "prepare" to do it, maybe they could be called differently but I can't think of a clear name and maybe it's enough to specify better in the man and in the help of the tool, perhaps also specifying in "snapshot_take" that the preparation and addition of storage for the differences is required first.
Unfortunately I'm not good at explaining and also write in English so I think many people could improve/add documentation better and faster. If it won't be done by other contributors, I would eventually try to do it.
Usage tips
- Please use the 👍 reaction to show that you are interested into this.
- Please don't comment if you have no relevant information to add. It's just extra noise for everyone subscribed to this.
- Subscribe to receive notifications on status change and new comments, you can do also without add comment.