Wiki » How to package mageia-doc

Two scripts has been written to help documentation package maintainers: build-pkg and update-doc.

Step-by-step procedure

Into the mageia-doc-trunk directory you will find something like this

mageia-doc-trunk/
|__build-pkg/
|__draklive/
|__installer/
|__mcc/
|__netinstall/
|__update-doc/

mcc, draklive, netinstall and installer directories contain the documentation built with Calenco and then imported
update-doc directory contains the script used to keep in sync the project under vcs with the documentation archives built by Calenco periodically
build-pkg directory contains the script used to build the source package you will use into the mageia-doc package

Enter the update-doc directory then launch the update-doc script. Be sure to make it executable

chmod +x update-doc.sh

./update-doc.sh

Read carefully its output!

The update-doc script outputs what's changed from the last commit for each documentation language. Read it carefully.

Additionally, to make extra sure that no new files were missed, run

$ svn status | grep ^?

It will return any files or directories that haven't been properly added, with a question mark at the beginning of the line, like this:

? new_directory ? old_directory/new_file

If that happens, then such items still need to be svn-added, like this:

$ svn add <such_item>

Edit the NEWS file in each directory (4), adding the date, your name, and the target release. Add which publication is updated or added.

Commit each family of publication in respective directory like:

svn ci -m "Update netinstall publications for 6.1"

Enter the build-pkg directory and edit the build-archive.sh file replacing, for example,

VERSION="3.4"

with

VERSION="3.5"

Then launch build-archive.sh with the command ./build-archive.sh

Then the process ends and you will find a compressed archive (*.xz) ready for the mageia-doc package.

Process with the classical packaging steps for this new release.