posaune

[projects.git] / doc / mbuild.8

diff --git a/doc/mbuild.8 b/doc/mbuild.8
index 3c26a7c..b1d4ef6 100644 (file)
--- a/doc/mbuild.8
+++ b/doc/mbuild.8
@@ -13,10 +13,17 @@ consists of 3 phases: configuration - compile - pack
 configuration
 is done by the
 .B mconfigure
-script. It determins the verion number from the git/subversion status. A
+script. The configuration step has the following tasks:
+
+Determination of version and build number. The version number can be set in a 
 .B PAKET.changelog
-file is needed. Per 
-default this script also performs compile and pack step.
+file, can be set by the -v option of
+.B mconfigure
+or be set by the project itself in the
+.B PAKET.prepare
+script. The build number is always taken from the CM system: With SVN it is the global version number, with
+GIT the build number is taken from the tag. On build a tag in the form project_version-build is expected. If not
+present a tag in the form v_version-build is searched. Verion may be 0.0 if set elsewhere.
 
 If a
 .B PAKET.prepare
@@ -35,7 +42,9 @@ file is present in the debian directory, it is called in the ~/build directory.
 compile
 To perform the compile step a
 .B PAKET.build
-script is needed in the 
+script or a
+.B PAKET.cmake
+file is needed in the 
 .B debian 
 directory.
 .TP
@@ -52,7 +61,7 @@ directory.
 A standard copyright file is included. An user defined file can be used by copying it to debian/copyright
 in the PAKET.prepare script.
 .br
-A standard README.debian file is included. An user defined file can be used by defining a debian/PAKET.README.debian.
+
 .SH FILES
 .TP
 PAKET.changelog
@@ -71,6 +80,10 @@ Any executable script file executed in configure step in the ../build directory
 PAKET.build
 Any executable script file executing the build in the ../build directory
 .TP
+PAKET.cmake
+cmake file (CMakeLists.txt) for building C/C++ code. If a cross compile option is set in the mconfigure
+script, according definitions are included.
+.TP
 PAKET.cp
 An executable script file copying the artefacts to target paths preposed by $1:
 .br