Table of Contents
This chapter describes the steps necessary to create a software release of LCDproc. It is intended to guide the release manager when creating a new release. (This is somewhat outdated now, that lcdproc development happens on github. We should revise this once things are fully in place.)
There is a checklist how to create a release on github in
docs/release-checklist.md
Any release of LCDproc is accompanied the the user guide and developer guide. Here is how to create these documentation packages.
Procedure 7.1. Steps to create the documentation package
Get the release tarball and extract it
and change to docs/lcdproc-user
.
Create the documentation package by running:
xmlto -o lcdproc-0-5-
A
-user-html xhtml lcdproc-user.docbook
Create a tarfile of the documentation package:
tar -czf lcdproc-0-5-
A
-user-html.tar.gz
lcdproc-0-5-A
-user-html
Repeat the above steps for the developers guide, replacing “-user” with “-dev” where appropriate.
Upload the files to the Sourceforge file release system.
The online documentation consists of the user and developer guide, each converted to a single file for viewing online.
Procedure 7.2. Steps to create the online documentation
Get the release tarball and extract it and change to
docs/lcdproc-user
.
Create the documentation file by running:
xmlto xhtml-nochunks lcdproc-user.docbook
Rename the file: mv lcdproc-user.html lcdproc-0-5-
A
-user.html
Repeat the above steps for the developers guide, replacing “-user” with “-dev” where appropriate.
Upload the files to our Sourceforge web site (not the file release system!)
and change htdocs/docs/index.html
to point to the new
files.