Build Release Documents

From NST Wiki
Revision as of 07:33, 28 February 2012 by Rwh (talk | contribs)
Jump to navigationJump to search

***NOTE*** This step is optional.

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@nst-dev-32 repo]# ./configure --config-dir include/dist --on-line-docs

   ... output from configuration ...

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

   ... output from HTML build ...

[root@nst-dev-32 repo]# /bin/rm -fr /var/www/html/nst-online
[root@nst-dev-32 repo]# /bin/cp -a tmp/public_html/nst /var/www/html/nst-online
[root@nst-dev-32 repo]# firefox
[root@nst-dev-32 repo]# 

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

[root@nst-dev-32 repo]# make release-docs SFUSER=YOUR_SF_ACCOUNT_ID

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-${VERSION}.tar.gz" to SourceForge.

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@nst-dev-32 repo]# ssh -t ${SFUSER}, create

Requesting a new shell for "${SFUSER}" and waiting for it to start.
queued... starting...
This is an interactive shell created for user SFUSERID,nst.
Use the "timeleft" command to see how much time remains before shutdown.
Use the "shutdown" command to destroy the shell before the time limit.
For path information and login help, type "sf-help".

-bash-3.2$ cd /home/groups/n/ns/nst
-bash-3.2$ cd htdocs
-bash-3.2$ ls
1.4.2  1.5.0  1.8.0  nst
-bash-3.2$ rm -fr 1.4.2
-bash-3.2$ exit
Connection to shell-24004 closed.
Connection to closed.
[root@nst-dev-32 repo]#