Build: make it possibly to specify subdirs in build.info

[openssl.git] / Configurations / README

diff --git a/Configurations/README b/Configurations/README
index 6ae981f9aaa6c5aa77ee37c04f7f551438cef69e..10463aadeef0a3d53c7d2dfe74dbd763bea3f9dd 100644 (file)
--- a/Configurations/README
+++ b/Configurations/README
@@ -169,7 +169,14 @@ In each table entry, the following keys are significant:
                            assembler files used when compiling with
                            assembler implementations.
         shared_target   => The shared library building method used.
                            assembler files used when compiling with
                            assembler implementations.
         shared_target   => The shared library building method used.

-                           This is a target found in Makefile.shared.
+                           This serves multiple purposes:
+                           - as index for targets found in shared_info.pl.
+                           - as linker script generation selector.
+                           To serve both purposes, the index for shared_info.pl
+                           should end with '-shared', and this suffix will be
+                           removed for use as a linker script generation
+                           selector.  Note that the latter is only used if
+                           'shared_defflag' is defined.

         build_scheme    => The scheme used to build up a Makefile.
                            In its simplest form, the value is a string
                            with the name of the build scheme.
         build_scheme    => The scheme used to build up a Makefile.
                            In its simplest form, the value is a string
                            with the name of the build scheme.


@@ -233,7 +240,7 @@ In each table entry, the following keys are significant:
                            apps, as needed by the target.  This code
                            cannot be placed in a library, as the rest
                            of the code isn't expected to link to it
                            apps, as needed by the target.  This code
                            cannot be placed in a library, as the rest
                            of the code isn't expected to link to it

-                           explicitely.
+                           explicitly.

         cpuid_asm_src   => assembler implementation of cpuid code as
                            well as OPENSSL_cleanse().
                            Default to mem_clr.c
         cpuid_asm_src   => assembler implementation of cpuid code as
                            well as OPENSSL_cleanse().
                            Default to mem_clr.c


@@ -393,7 +400,13 @@ $sourcedir and $builddir, which are the locations of the source
 directory for the current build.info file and the corresponding build
 directory, all relative to the top of the build tree.
 
 directory for the current build.info file and the corresponding build
 directory, all relative to the top of the build tree.
 

-To begin with, things to be built are declared by setting specific
+'Configure' only knows inherently about the top build.info file.  For
+any other directory that has one, further directories to look into
+must be indicated like this:
+
+    SUBDIRS=something someelse
+
+On to things to be built; they are declared by setting specific

 variables:
 
     PROGRAMS=foo bar
 variables:
 
     PROGRAMS=foo bar


@@ -460,6 +473,10 @@ include paths the build of their source files should use:
 
     INCLUDE[foo]=include
 
 
     INCLUDE[foo]=include
 

+It's also possible to specify C macros that should be defined:
+
+    DEFINE[foo]=FOO BAR=1
+

 In some cases, one might want to generate some source files from
 others, that's done as follows:
 
 In some cases, one might want to generate some source files from
 others, that's done as follows: