How should I document the installation steps for a given package?
Create a file /uns/src/package-version.BUILDING that documents how you installed the package, including what compiler and flags you used, any flags passed to configuration scripts, and any changes you made to the source to get it to work. Ideally, this file should be able to be executed (or its contents cut-and-pasted into a command shell) in order to exactly duplicate the installation. Store any changes to the source as diffs against the original, in a separate file /uns/srcpackage-version.patch. To keep track of exactly which commands you typed during installation, consider using the script program (run man 1 script for details). Emacs users can get the same benefits by doing the install from shell mode and then saving the shell buffer. Put the tarball in /uns/src and/or record its URL in the BUILDING file (probably in the form of a wget or curl command). This is important both to allow future maintainers to find the source and to help the department to prove that the software is leg
Related Questions
- Given ECR6 Managements software installation policy, can I arrange to have a software package installed on the facilitys computers by ECR6 Management?
- Is priority given to those using the officially arranged package trips rather than the independent traveller?
- What special steps must be taken to ensure proper installation of Air Cooling Coil Coating?
