From: Karel Zak <kzak@redhat.com>
Date: Thu, 27 Oct 2011 09:06:08 +0000 (+0200)
Subject: docs: add howto-build-sys.txt
X-Git-Tag: v2.21-rc1~266
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=aa594805265a1f2d0978e3e4bd2f1ec6a6c770f0;p=thirdparty%2Futil-linux.git

docs: add howto-build-sys.txt

Signed-off-by: Karel Zak <kzak@redhat.com>
---

diff --git a/Documentation/howto-build-sys.txt b/Documentation/howto-build-sys.txt
new file mode 100644
index 0000000000..22ae8fc6fd
--- /dev/null
+++ b/Documentation/howto-build-sys.txt
@@ -0,0 +1,30 @@
+util-linux build system
+=======================
+
+ - all util-linux specific autoconf macros use UL_ prefix
+
+ - utils in Makedile.am files are enabled/disabled according to BUILD_<NAME>
+   conditions (AM_CONDITIONAL), for example:
+
+	if BUILD_HWCLOCK
+	...
+	endif
+
+ - all BUILD_<NAME> in configure.am are always based on build_<name> variables,
+   for example:
+
+	AM_CONDITIONAL([BUILD_HWCLOCK], test "x$build_hwclock" = xyes)
+
+   the $build_<name> should be available in whole configure script
+
+ - AC_ARG_ENABLE() status is always stored in $enable_<name> variable, possible
+   setting:
+
+	"check" - util/feature is optional, if any subcomponent (function, lib,
+                  ...) is missing a warning is printed and the util/feature is
+                  disabled
+
+	"yes"	- util/feature is required, if any subcomponent (function, lib,
+                  ...) is missing an error is printed and ./configure aborted
+
+	"no"	- the util/feature is unwanted