Date: Wednesday, January 17, 2007 @ 17:41:03
Author: marc
Path: /cvsroot/carob/carob/make-includes
Modified: README (1.2 -> 1.3)
First version of something looking like a documentation
--------+
README | 26 ++++++++++++++++++++++----
1 files changed, 22 insertions(+), 4 deletions(-)
Index: carob/make-includes/README
diff -u carob/make-includes/README:1.2 carob/make-includes/README:1.3
--- carob/make-includes/README:1.2 Mon Jan 8 20:57:41 2007
+++ carob/make-includes/README Wed Jan 17 17:41:03 2007
@@ -1,13 +1,31 @@
+HOWTO USE
+---------
+
Example:
make OS=freebsd CUSTOM="libmysequoia.mk warnings.mk" check
-To allow flags to be defined both using the command line and here in
-.mk files, respect the following convention:
+HOWTO CONTRIB
+-------------
+
+- CPPFLAGS / CXXFLAGS / LDFLAGS / LDLIBS / etc. are meant to be
+overriden on the command line. Values found in .mk files are only
+default suggestions and should not be needed to compile successfully.
+
+- To force a flag whatever is on the command line use prefixed names:
+MK_CXXFLAGS / MK_LDFLAGS / SHARED_LDFLAGS / etc.
+
+- in .mk files, never define using "=" but always append using "+="
+instead. You are not alone in this world!
+
+- never use "override". Interactions between override, "=", "+=" and
+the command line are too complex to be reliable.
+
+- x-os.mk, y-linker.mk and z-compiler.mk are loaded using OS, LINKER
+and COMPILER variables. CUSTOM="custom1 custom2" allows loading
+any number of .mk files. See main.mk code for details.
-command line: CXXFLAGS=-O3
-in .mk files: MK_CXXFLAGS=-g3
_______________________________________________
Carob-commits mailing list
[email protected]
https://forge.continuent.org/mailman/listinfo/carob-commits
