Update BUILD to reflect the dev package option

[ric-plt/lib/rmr.git] / BUILD

diff --git a/BUILD b/BUILD
index 37a5045..811490d 100644 (file)
--- a/BUILD
+++ b/BUILD
@@ -44,6 +44,28 @@ To build RMr, the usual CMake steps are followed:
 This will create a .deb (provided the system supports this) in
 the build directory.  It's that simple.
 
+The following flags may be given on the 'cmake' command line
+(options) which are outside of "normal" CMake flags and affect
+the configuration:
+
+  -DBUILD_DOC=1         Man pages generated
+  -DDEV_PKG=1                  Development package configuration
+  -DMAN_PREFIX=<path>  Supply a path where man pages are installed (default: /usr/share/man)
+  -DPACK_EXTERNALS=1   Include external libraries used to build in the run-time package
+  -DPRESERVE_PTYPE=1   Do not change the processor type when naming deb packages
+  -DSKIP_EXTERNALS=1   Do not use Nano/NNG submodules when building; uee installed packages
+
+
+Packages
+The build can be configured to generate either a run-time or
+development package. The run-time generation is the default and
+the -DDEV_PKG=1 option must be given to generate the development
+package.  The run-time package contains only the shared library
+files (*.so), and the development package contains the headers,
+man pages (if the man option is set) and archive (.a) files.
+Resulting package names are illustrated in the CI section below.
+
+
 Continuous Integration Build
 Use the Dockerfile in the ci/ subdirectory. This installs all
 the required tools, then builds RMr and executes the unit and
@@ -58,18 +80,12 @@ packages available from the image.  Currently, both .deb and
 
 The following is a sample YAML file generated during this process:
 
-   # package types which might be listed below
    ---
-   pkg_types:
-     - deb
-     - rpm
-   packages:
-     - development:
-       deb: /tmp/rmr-dev_1.0.34_x86_64.deb
-       rpm: /tmp/rmr-dev-1.0.34-x86_64.rpm
-     - runtime:
-       deb: /tmp/rmr_1.0.34_x86_64.deb
-       rpm: /tmp/rmr-1.0.34-x86_64.rpm
+   files:
+     - /tmp/rmr-dev_1.0.34_x86_64.deb
+     - /tmp/rmr-dev-1.0.34-x86_64.rpm
+     - /tmp/rmr_1.0.34_x86_64.deb
+     - /tmp/rmr-1.0.34-x86_64.rpm
    ...