Preseed commands and parameters should be enumerated and explained
| Affects | Status | Importance | Assigned to | Milestone | |
|---|---|---|---|---|---|
| installation-guide (Ubuntu) |
New
|
Undecided
|
Unassigned | ||
Bug Description
The Preseed documentation strategy seems to be primarily examples with comments and explanations, but it is not complete. From a user's perspective, it is very frustrating to read through the documentation and not find simple answer to questions like: What does the number between the minimum and maximum size for a partition mean? Or, is partition size specified in cylinders, blocks, segments, extents, bytes, kilobytes, kibibytes, megabytes or mebibytes? These are documented, but it requires digging through the source repositories to find them-- http://
My suggestion: Enumerate and explain each command, sub-command, and parameter. Say what is optional and what is require. List valid input for each parameter, including data type, unit, or valid string values. And if there is a default, say what it is.
Full Backus-Naur Form documentation like is available in the developer docs isn't necessary, but links to Primary Sources would be very helpful.
Examples of good web-based documentation:
http://
http://
http://
http://
http://
| description: | updated |
