From: Richard Levitte <levitte@openssl.org>
Date: Fri, 10 Feb 2006 08:48:43 +0000 (+0000)
Subject: Document the building macros.
X-Git-Tag: OpenSSL_0_9_8k^2~1566
X-Git-Url: https://git.openssl.org/?p=openssl.git;a=commitdiff_plain;h=b480283c56cd7c93237aad1ef6b269b357b46c5f

Document the building macros.
---

diff --git a/Makefile.org b/Makefile.org
index da63e906b7..902bcd9a41 100644
--- a/Makefile.org
+++ b/Makefile.org
@@ -197,6 +197,19 @@ BUILDENV=	PLATFORM='${PLATFORM}' PROCESSOR='${PROCESSOR}' \
 # MAKEOVERRIDES= effectively "equalizes" GNU-ish and SysV-ish make flavors,
 # which in turn eliminates ambiguities in variable treatment with -e.
 
+# BUILD_CMD is a generic macro to build a given target in a given
+# subdirectory.  The target must be given through the shell variable
+# `target' and the subdirectory to build in must be given through `dir'.
+# This macro shouldn't be used directly, use RECURSIVE_BUILD_CMD or
+# BUILD_ONE_CMD instead.
+#
+# BUILD_ONE_CMD is a macro to build a given target in a given
+# subdirectory if that subdirectory is part of $(DIRS).  It requires
+# exactly the same shell variables as BUILD_CMD.
+#
+# RECURSIVE_BUILD_CMD is a macro to build a given target in all
+# subdirectories defined in $(DIRS).  It requires that the target
+# is given through the shell variable `target'.
 BUILD_CMD=  if [ -d "$$dir" ]; then \
 	    (	cd $$dir && echo "making $$target in $$dir..." && \
 		$(CLEARENV) && $(MAKE) -e $(BUILDENV) TOP=.. DIR=$$dir $$target \