FS#16276 - aif example files should be more comprehensive

Attached to Project: Release Engineering
Opened by Felix (thetrivialstuff) - Sunday, 20 September 2009, 04:17 GMT
Last edited by Dieter Plaetinck (Dieter_be) - Thursday, 09 December 2010, 10:23 GMT
Task Type Bug Report
Category AIF
Status Closed
Assigned To No-one
Architecture All
Severity Low
Priority Low
Reported Version 2009.08
Due in Version Undecided
Due Date Undecided
Percent Complete 100%
Votes 0
Private No

Details

Description: The example files should be more extensively commented, and should lay out all the options for the environment variables, as there is currently no other documentation explaining them.

For example, under the old /arch/quickinst script the choices of package source were "cd" or "ftp"; in aif they are now "cd" and "net" but both of the example scripts use "cd" (even on the netinstall CD image) so the only way for a user to know that "ftp" was renamed is to look in /usr/lib/aif/core/libs/lib-pacman.sh.
This task depends upon

Closed by  Dieter Plaetinck (Dieter_be)
Thursday, 09 December 2010, 10:23 GMT
Reason for closing:  Implemented
Comment by Dieter Plaetinck (Dieter_be) - Wednesday, 11 November 2009, 12:13 GMT
well i think the example files are commented enough. we should however have better documentation explaining those variables, i agree.
there is an aif readme and the official installation guide in the aif git repo. i welcome any contributions.
Comment by Dieter Plaetinck (Dieter_be) - Thursday, 09 December 2010, 10:23 GMT
currently the official install guide refers to the aif examples, so yeah it's pretty important to explain the vars in the example files.
which is what I now did.
"clarify SOURCE, SYNC_URL and HARDWARELCOCK variables" @
http://projects.archlinux.org/aif.git/commit/?id=06b8ca8f164fe4add2c02fe51675af1702e23200

Loading...