No documentation or manpage
Bug #301957 reported by
Micon Frink
| Affects | Status | Importance | Assigned to | Milestone | |
|---|---|---|---|---|---|
| livecd-rootfs (Ubuntu) |
Confirmed
|
Wishlist
|
Unassigned | ||
Bug Description
Binary package hint: livecd-rootfs
No manpage
No readme
No -h or --help option
No Ubuntu Wiki Help
In short there is no way to learn what this script does or how to use it. Granted, someone using this should be able to read the code and discover what it's doing. But then again, what is the use of the tool if someone knows all the bash commands?
Bottom line: Get it documented!!!
| Changed in livecd-rootfs (Ubuntu): | |
| status: | New → Invalid |
Revision history for this message
| Oliver Grawert (ogra) wrote | #1 |
| Changed in livecd-rootfs (Ubuntu): | |
| status: | Invalid → Confirmed |
| importance: | Undecided → Wishlist |
To post a comment you must log in.
i think having documentation for packages we ship publically in the archive is a very valid request, even though the script is only used by the build system it should be documented how it is used. given that i doubt any developer finds the time to create such documentation i'll mark it wishlist, if anyone wants to write such docs, please attach a patch (or link a bzr branch with docs added)
@Ian, please at least leave a comment if you change the bug status.