Build Release PDFs

From NST Wiki
Jump to navigationJump to search

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

If you plan on including a snapshot of the documentation available its PDF form, you can invoke the following command:

[root@nst-dev-32 repo]# make release-pdfs

... Takes quite a bit of time and produces a lot of output
    as it attempts to build the PDF files ...

Completed. Archive created as:

ls -al "/root/repo/nst-2.11.0/nst-pdfs-2.11.0.tar.gz";
-rw-r--r--. 1 root root 1162562 2009-09-23 07:17 /root/repo/nst-2.11.0/nst-pdfs-2.11.0.tar.gz
[root@nst-dev-32 repo]#

This will produce the file: "nst-${VERSION}/nst-pdfs-${VERSION}.tar.gz" which you will need to upload to SourceForge and add to the release.

Note: Over time, it has become more and more difficult to get the PDF documents to build cleanly. The PDF documents might not build, or even worse, might partially build (include text but omit graphic images). So, we don't always include PDF documentation in the actual release (sometimes we skip this step).