Build Release Documents

Once you've verified that the new distribution looks good and you've checked in the XML release files, you are ready to build a snapshot of the documentation at the time of release. Since this build takes a long time to complete, it is recommended that one configure and build just the HTML document first and review its content. The following commands can be used to build a "release" version of the HTML documentation:

[root@quesadilla nst]# ./configure --config-dir include/dist --on-line-docs


   ... output from configuration ...


[root@quesadilla nst]# make -C html all IF_RELEASE_DOCS='@param(0)'


   ... output from HTML build ...


[root@quesadilla fc2]# firefox http://127.0.0.1/nst
[root@quesadilla fc2]# 

Once the above ouput looks reasonable, you can proceed to the final build (which takes a LONG time) by invoking:

[root@quesadilla nst]# make release-docs

This will take care of building the documentation for the release and storing a copy at the proper location at SourceForge. In addition, you will need to upload the file: "nst-docs-1.8.1.tar.gz" to SourceForge and add it to the release

Note:

The documentation produced will have minimal references to other versions of the NST. The goal is to capture a "instance" of the documentation specific to the release.

As SourceForge does not like projects to use too much disk space on the web server, you will need to log into SourceForge and "trim off" old snapshots of the documentation. This can be done in the following manner:

[root@dhcp138 fc6]# ssh USERID@shell.sourceforge.net
-bash-3.00$ cd /home/groups/n/ns/nst
-bash-3.00$ ls htdocs
1.4.0  1.4.1  1.4.2  1.5.0  nst
-bash-3.00$ rm -fr htdocs/1.4.0
-bash-3.00$ exit
logout
Connection to shell.sourceforge.net closed.
-bash-3.00$