iOS config targets: disable "async" by default
[openssl.git] / Configurations / README
1 Intro
2 =====
3
4 This directory contains a few sets of files that are used for
5 configuration in diverse ways:
6
7     *.conf      Target platform configurations, please read
8                 'Configurations of OpenSSL target platforms' for more
9                 information.
10     *.tmpl      Build file templates, please read 'Build-file
11                 programming with the "unified" build system' as well
12                 as 'Build info files' for more information.
13     *.pm        Helper scripts / modules for the main `Configure`
14                 script.  See 'Configure helper scripts for more
15                 information.
16
17
18 Configurations of OpenSSL target platforms
19 ==========================================
20
21 Configuration targets are a collection of facts that we know about
22 different platforms and their capabilities.  We organise them in a
23 hash table, where each entry represent a specific target.
24
25 Note that configuration target names must be unique across all config
26 files.  The Configure script does check that a config file doesn't
27 have config targets that shadow config targets from other files.
28
29 In each table entry, the following keys are significant:
30
31         inherit_from    => Other targets to inherit values from.
32                            Explained further below. [1]
33         template        => Set to 1 if this isn't really a platform
34                            target.  Instead, this target is a template
35                            upon which other targets can be built.
36                            Explained further below.  [1]
37
38         sys_id          => System identity for systems where that
39                            is difficult to determine automatically.
40
41         enable          => Enable specific configuration features.
42                            This MUST be an array of words.
43         disable         => Disable specific configuration features.
44                            This MUST be an array of words.
45                            Note: if the same feature is both enabled
46                            and disabled, disable wins.
47
48         as              => The assembler command.  This is not always
49                            used (for example on Unix, where the C
50                            compiler is used instead).
51         asflags         => Default assembler command flags [4].
52         cpp             => The C preprocessor command, normally not
53                            given, as the build file defaults are
54                            usually good enough.
55         cppflags        => Default C preprocessor flags [4].
56         defines         => As an alternative, macro definitions may be
57                            given here instead of in `cppflags' [4].
58                            If given here, they MUST be as an array of
59                            the string such as "MACRO=value", or just
60                            "MACRO" for definitions without value.
61         includes        => As an alternative, inclusion directories
62                            may be given here instead of in `cppflags'
63                            [4].  If given here, the MUST be an array
64                            of strings, one directory specification
65                            each.
66         cc              => The C compiler command, usually one of "cc",
67                            "gcc" or "clang".  This command is normally
68                            also used to link object files and
69                            libraries into the final program.
70         cxx             => The C++ compiler command, usually one of
71                            "c++", "g++" or "clang++".  This command is
72                            also used when linking a program where at
73                            least one of the object file is made from
74                            C++ source.
75         cflags          => Defaults C compiler flags [4].
76         cxxflags        => Default  C++ compiler flags [4].  If unset,
77                            it gets the same value as cflags.
78
79         (linking is a complex thing, see [3] below)
80         ld              => Linker command, usually not defined
81                            (meaning the compiler command is used
82                            instead).
83                            (NOTE: this is here for future use, it's
84                            not implemented yet)
85         lflags          => Default flags used when linking apps,
86                            shared libraries or DSOs [4].
87         ex_libs         => Extra libraries that are needed when
88                            linking shared libraries, DSOs or programs.
89                            The value is also assigned to Libs.private
90                            in $(libdir)/pkgconfig/libcrypto.pc.
91
92         shared_cppflags => Extra C preprocessor flags used when
93                            processing C files for shared libraries.
94         shared_cflag    => Extra C compiler flags used when compiling
95                            for shared libraries, typically something
96                            like "-fPIC".
97         shared_ldflag   => Extra linking flags used when linking
98                            shared libraries.
99         module_cppflags
100         module_cflags
101         module_ldflags  => Has the same function as the corresponding
102                            `shared_' attributes, but for building DSOs.
103                            When unset, they get the same values as the
104                            corresponding `shared_' attributes.
105
106         ar              => The library archive command, the default is
107                            "ar".
108                            (NOTE: this is here for future use, it's
109                            not implemented yet)
110         arflags         => Flags to be used with the library archive
111                            command.  On Unix, this includes the
112                            command letter, 'r' by default.
113
114         ranlib          => The library archive indexing command, the
115                            default is 'ranlib' it it exists.
116
117         unistd          => An alternative header to the typical
118                            '<unistd.h>'.  This is very rarely needed.
119
120         shared_extension => File name extension used for shared
121                             libraries. 
122         obj_extension   => File name extension used for object files.
123                            On unix, this defaults to ".o" (NOTE: this
124                            is here for future use, it's not
125                            implemented yet)
126         exe_extension   => File name extension used for executable
127                            files.  On unix, this defaults to "" (NOTE:
128                            this is here for future use, it's not
129                            implemented yet)
130         shlib_variant   => A "variant" identifier inserted between the base
131                            shared library name and the extension.  On "unixy"
132                            platforms (BSD, Linux, Solaris, MacOS/X, ...) this
133                            supports installation of custom OpenSSL libraries
134                            that don't conflict with other builds of OpenSSL
135                            installed on the system.  The variant identifier
136                            becomes part of the SONAME of the library and also
137                            any symbol versions (symbol versions are not used or
138                            needed with MacOS/X).  For example, on a system
139                            where a default build would normally create the SSL
140                            shared library as 'libssl.so -> libssl.so.1.1' with
141                            the value of the symlink as the SONAME, a target
142                            definition that sets 'shlib_variant => "-abc"' will
143                            create 'libssl.so -> libssl-abc.so.1.1', again with
144                            an SONAME equal to the value of the symlink.  The
145                            symbol versions associated with the variant library
146                            would then be 'OPENSSL_ABC_<version>' rather than
147                            the default 'OPENSSL_<version>'. The string inserted
148                            into symbol versions is obtained by mapping all
149                            letters in the "variant" identifier to upper case
150                            and all non-alphanumeric characters to '_'.
151
152         thread_scheme   => The type of threads is used on the
153                            configured platform.  Currently known
154                            values are "(unknown)", "pthreads",
155                            "uithreads" (a.k.a solaris threads) and
156                            "winthreads".  Except for "(unknown)", the
157                            actual value is currently ignored but may
158                            be used in the future.  See further notes
159                            below [2].
160         dso_scheme      => The type of dynamic shared objects to build
161                            for.  This mostly comes into play with
162                            engines, but can be used for other purposes
163                            as well.  Valid values are "DLFCN"
164                            (dlopen() et al), "DLFCN_NO_H" (for systems
165                            that use dlopen() et al but do not have
166                            fcntl.h), "DL" (shl_load() et al), "WIN32"
167                            and "VMS".
168         perlasm_scheme  => The perlasm method used to create the
169                            assembler files used when compiling with
170                            assembler implementations.
171         shared_target   => The shared library building method used.
172                            This serves multiple purposes:
173                            - as index for targets found in shared_info.pl.
174                            - as linker script generation selector.
175                            To serve both purposes, the index for shared_info.pl
176                            should end with '-shared', and this suffix will be
177                            removed for use as a linker script generation
178                            selector.  Note that the latter is only used if
179                            'shared_defflag' is defined.
180         build_scheme    => The scheme used to build up a Makefile.
181                            In its simplest form, the value is a string
182                            with the name of the build scheme.
183                            The value may also take the form of a list
184                            of strings, if the build_scheme is to have
185                            some options.  In this case, the first
186                            string in the list is the name of the build
187                            scheme.
188                            Currently recognised build scheme is "unified".
189                            For the "unified" build scheme, this item
190                            *must* be an array with the first being the
191                            word "unified" and the second being a word
192                            to identify the platform family.
193
194         multilib        => On systems that support having multiple
195                            implementations of a library (typically a
196                            32-bit and a 64-bit variant), this is used
197                            to have the different variants in different
198                            directories.
199
200         bn_ops          => Building options (was just bignum options in
201                            the earlier history of this option, hence the
202                            name). This is a string of words that describe
203                            algorithms' implementation parameters that
204                            are optimal for the designated target platform,
205                            such as the type of integers used to build up
206                            the bignum, different ways to implement certain
207                            ciphers and so on. To fully comprehend the
208                            meaning, the best is to read the affected
209                            source.
210                            The valid words are:
211
212                            THIRTY_TWO_BIT       bignum limbs are 32 bits,
213                                                 this is default if no
214                                                 option is specified, it
215                                                 works on any supported
216                                                 system [unless "wider"
217                                                 limb size is implied in
218                                                 assembly code];
219                            BN_LLONG             bignum limbs are 32 bits,
220                                                 but 64-bit 'unsigned long
221                                                 long' is used internally
222                                                 in calculations;
223                            SIXTY_FOUR_BIT_LONG  bignum limbs are 64 bits
224                                                 and sizeof(long) is 8;
225                            SIXTY_FOUR_BIT       bignums limbs are 64 bits,
226                                                 but execution environment
227                                                 is ILP32;
228                            RC4_CHAR             RC4 key schedule is made
229                                                 up of 'unsigned char's;
230                            RC4_INT              RC4 key schedule is made
231                                                 up of 'unsigned int's;
232                            EXPORT_VAR_AS_FN     for shared libraries,
233                                                 export vars as
234                                                 accessor functions.
235
236         apps_aux_src    => Extra source to build apps/openssl and other
237                            apps, as needed by the target and that can be
238                            collected in a library.
239         apps_init_src   => Init source to build apps/openssl and other
240                            apps, as needed by the target.  This code
241                            cannot be placed in a library, as the rest
242                            of the code isn't expected to link to it
243                            explicitly.
244         cpuid_asm_src   => assembler implementation of cpuid code as
245                            well as OPENSSL_cleanse().
246                            Default to mem_clr.c
247         bn_asm_src      => Assembler implementation of core bignum
248                            functions.
249                            Defaults to bn_asm.c
250         ec_asm_src      => Assembler implementation of core EC
251                            functions.
252         des_asm_src     => Assembler implementation of core DES
253                            encryption functions.
254                            Defaults to 'des_enc.c fcrypt_b.c'
255         aes_asm_src     => Assembler implementation of core AES
256                            functions.
257                            Defaults to 'aes_core.c aes_cbc.c'
258         bf_asm_src      => Assembler implementation of core BlowFish
259                            functions.
260                            Defaults to 'bf_enc.c'
261         md5_asm_src     => Assembler implementation of core MD5
262                            functions.
263         sha1_asm_src    => Assembler implementation of core SHA1,
264                            functions, and also possibly SHA256 and
265                            SHA512 ones.
266         cast_asm_src    => Assembler implementation of core CAST
267                            functions.
268                            Defaults to 'c_enc.c'
269         rc4_asm_src     => Assembler implementation of core RC4
270                            functions.
271                            Defaults to 'rc4_enc.c rc4_skey.c'
272         rmd160_asm_src  => Assembler implementation of core RMD160
273                            functions.
274         rc5_asm_src     => Assembler implementation of core RC5
275                            functions.
276                            Defaults to 'rc5_enc.c'
277         wp_asm_src      => Assembler implementation of core WHIRLPOOL
278                            functions.
279         cmll_asm_src    => Assembler implementation of core CAMELLIA
280                            functions.
281                            Defaults to 'camellia.c cmll_misc.c cmll_cbc.c'
282         modes_asm_src   => Assembler implementation of cipher modes,
283                            currently the functions gcm_gmult_4bit and
284                            gcm_ghash_4bit.
285         padlock_asm_src => Assembler implementation of core parts of
286                            the padlock engine.  This is mandatory on
287                            any platform where the padlock engine might
288                            actually be built.
289
290
291 [1] as part of the target configuration, one can have a key called
292     'inherit_from' that indicate what other configurations to inherit
293     data from.  These are resolved recursively.
294
295     Inheritance works as a set of default values that can be overridden
296     by corresponding key values in the inheriting configuration.
297
298     Note 1: any configuration table can be used as a template.
299     Note 2: pure templates have the attribute 'template => 1' and
300             cannot be used as build targets.
301
302     If several configurations are given in the 'inherit_from' array,
303     the values of same attribute are concatenated with space
304     separation.  With this, it's possible to have several smaller
305     templates for different configuration aspects that can be combined
306     into a complete configuration.
307
308     instead of a scalar value or an array, a value can be a code block
309     of the form 'sub { /* your code here */ }'.  This code block will
310     be called with the list of inherited values for that key as
311     arguments.  In fact, the concatenation of strings is really done
312     by using 'sub { join(" ",@_) }' on the list of inherited values.
313
314     An example:
315
316         "foo" => {
317                 template => 1,
318                 haha => "ha ha",
319                 hoho => "ho",
320                 ignored => "This should not appear in the end result",
321         },
322         "bar" => {
323                 template => 1,
324                 haha => "ah",
325                 hoho => "haho",
326                 hehe => "hehe"
327         },
328         "laughter" => {
329                 inherit_from => [ "foo", "bar" ],
330                 hehe => sub { join(" ",(@_,"!!!")) },
331                 ignored => "",
332         }
333
334         The entry for "laughter" will become as follows after processing:
335
336         "laughter" => {
337                 haha => "ha ha ah",
338                 hoho => "ho haho",
339                 hehe => "hehe !!!",
340                 ignored => ""
341         }
342
343 [2] OpenSSL is built with threading capabilities unless the user
344     specifies 'no-threads'.  The value of the key 'thread_scheme' may
345     be "(unknown)", in which case the user MUST give some compilation
346     flags to Configure.
347
348 [3] OpenSSL has three types of things to link from object files or
349     static libraries:
350
351     - shared libraries; that would be libcrypto and libssl.
352     - shared objects (sometimes called dynamic libraries);  that would
353       be the engines.
354     - applications; those are apps/openssl and all the test apps.
355
356     Very roughly speaking, linking is done like this (words in braces
357     represent the configuration settings documented at the beginning
358     of this file):
359
360     shared libraries:
361         {ld} $(CFLAGS) {lflags} {shared_ldflag} -o libfoo.so \
362             foo/something.o foo/somethingelse.o {ex_libs}
363
364     shared objects:
365         {ld} $(CFLAGS) {lflags} {module_ldflags} -o libeng.so \
366             blah1.o blah2.o -lcrypto {ex_libs}
367
368     applications:
369         {ld} $(CFLAGS) {lflags} -o app \
370             app1.o utils.o -lssl -lcrypto {ex_libs}
371
372 [4] There are variants of these attribute, prefixed with `lib_',
373     `dso_' or `bin_'.  Those variants replace the unprefixed attribute
374     when building library, DSO or program modules specifically.
375
376 Historically, the target configurations came in form of a string with
377 values separated by colons.  This use is deprecated.  The string form
378 looked like this:
379
380    "target" => "{cc}:{cflags}:{unistd}:{thread_cflag}:{sys_id}:{lflags}:{bn_ops}:{cpuid_obj}:{bn_obj}:{ec_obj}:{des_obj}:{aes_obj}:{bf_obj}:{md5_obj}:{sha1_obj}:{cast_obj}:{rc4_obj}:{rmd160_obj}:{rc5_obj}:{wp_obj}:{cmll_obj}:{modes_obj}:{padlock_obj}:{perlasm_scheme}:{dso_scheme}:{shared_target}:{shared_cflag}:{shared_ldflag}:{shared_extension}:{ranlib}:{arflags}:{multilib}"
381
382
383 Build info files
384 ================
385
386 The build.info files that are spread over the source tree contain the
387 minimum information needed to build and distribute OpenSSL.  It uses a
388 simple and yet fairly powerful language to determine what needs to be
389 built, from what sources, and other relationships between files.
390
391 For every build.info file, all file references are relative to the
392 directory of the build.info file for source files, and the
393 corresponding build directory for built files if the build tree
394 differs from the source tree.
395
396 When processed, every line is processed with the perl module
397 Text::Template, using the delimiters "{-" and "-}".  The hashes
398 %config and %target are passed to the perl fragments, along with
399 $sourcedir and $builddir, which are the locations of the source
400 directory for the current build.info file and the corresponding build
401 directory, all relative to the top of the build tree.
402
403 To begin with, things to be built are declared by setting specific
404 variables:
405
406     PROGRAMS=foo bar
407     LIBS=libsomething
408     ENGINES=libeng
409     SCRIPTS=myhack
410     EXTRA=file1 file2
411
412 Note that the files mentioned for PROGRAMS, LIBS and ENGINES *must* be
413 without extensions.  The build file templates will figure them out.
414
415 For each thing to be built, it is then possible to say what sources
416 they are built from:
417
418     PROGRAMS=foo bar
419     SOURCE[foo]=foo.c common.c
420     SOURCE[bar]=bar.c extra.c common.c
421
422 It's also possible to tell some other dependencies:
423
424     DEPEND[foo]=libsomething
425     DEPEND[libbar]=libsomethingelse
426
427 (it could be argued that 'libsomething' and 'libsomethingelse' are
428 source as well.  However, the files given through SOURCE are expected
429 to be located in the source tree while files given through DEPEND are
430 expected to be located in the build tree)
431
432 It's also possible to depend on static libraries explicitly:
433
434     DEPEND[foo]=libsomething.a
435     DEPEND[libbar]=libsomethingelse.a
436
437 This should be rarely used, and care should be taken to make sure it's
438 only used when supported.  For example, native Windows build doesn't
439 support building static libraries and DLLs at the same time, so using
440 static libraries on Windows can only be done when configured
441 'no-shared'.
442
443 One some platforms, shared libraries come with a name that's different
444 from their static counterpart.  That's declared as follows:
445
446     SHARED_NAME[libfoo]=cygfoo-{- $config{shlibver} -}
447
448 The example is from Cygwin, which has a required naming convention.
449
450 Sometimes, it makes sense to rename an output file, for example a
451 library:
452
453     RENAME[libfoo]=libbar
454
455 That line has "libfoo" renamed to "libbar".  While it makes no
456 sense at all to just have a rename like that (why not just use
457 "libbar" everywhere?), it does make sense when it can be used
458 conditionally.  See a little further below for an example.
459
460 In some cases, it's desirable to include some source files in the
461 shared form of a library only:
462
463     SHARED_SOURCE[libfoo]=dllmain.c
464
465 For any file to be built, it's also possible to tell what extra
466 include paths the build of their source files should use:
467
468     INCLUDE[foo]=include
469
470 In some cases, one might want to generate some source files from
471 others, that's done as follows:
472
473     GENERATE[foo.s]=asm/something.pl $(CFLAGS)
474     GENERATE[bar.s]=asm/bar.S
475
476 The value of each GENERATE line is a command line or part of it.
477 Configure places no rules on the command line, except that the first
478 item must be the generator file.  It is, however, entirely up to the
479 build file template to define exactly how those command lines should
480 be handled, how the output is captured and so on.
481
482 Sometimes, the generator file itself depends on other files, for
483 example if it is a perl script that depends on other perl modules.
484 This can be expressed using DEPEND like this:
485
486     DEPEND[asm/something.pl]=../perlasm/Foo.pm
487
488 There may also be cases where the exact file isn't easily specified,
489 but an inclusion directory still needs to be specified.  INCLUDE can
490 be used in that case:
491
492     INCLUDE[asm/something.pl]=../perlasm
493
494 NOTE: GENERATE lines are limited to one command only per GENERATE.
495
496 As a last resort, it's possible to have raw build file lines, between
497 BEGINRAW and ENDRAW lines as follows:
498
499     BEGINRAW[Makefile(unix)]
500     haha.h: {- $builddir -}/Makefile
501         echo "/* haha */" > haha.h
502     ENDRAW[Makefile(unix)]
503
504 The word within square brackets is the build_file configuration item
505 or the build_file configuration item followed by the second word in the
506 build_scheme configuration item for the configured target within
507 parenthesis as shown above.  For example, with the following relevant
508 configuration items:
509
510    build_file   => "build.ninja"
511    build_scheme => [ "unified", "unix" ]
512
513 ... these lines will be considered:
514
515    BEGINRAW[build.ninja]
516    build haha.h: echo "/* haha */" > haha.h
517    ENDRAW[build.ninja]
518
519    BEGINRAW[build.ninja(unix)]
520    build hoho.h: echo "/* hoho */" > hoho.h
521    ENDRAW[build.ninja(unix)]
522
523 Should it be needed because the recipes within a RAW section might
524 clash with those generated by Configure, it's possible to tell it
525 not to generate them with the use of OVERRIDES, for example:
526
527     SOURCE[libfoo]=foo.c bar.c
528     
529     OVERRIDES=bar.o
530     BEGINRAW[Makefile(unix)]
531     bar.o: bar.c
532         $(CC) $(CFLAGS) -DSPECIAL -c -o $@ $<
533     ENDRAW[Makefile(unix)]
534
535 See the documentation further up for more information on configuration
536 items.
537
538 Finally, you can have some simple conditional use of the build.info
539 information, looking like this:
540
541     IF[1]
542      something
543     ELSIF[2]
544      something other
545     ELSE
546      something else
547     ENDIF
548
549 The expression in square brackets is interpreted as a string in perl,
550 and will be seen as true if perl thinks it is, otherwise false.  For
551 example, the above would have "something" used, since 1 is true.
552
553 Together with the use of Text::Template, this can be used as
554 conditions based on something in the passed variables, for example:
555
556     IF[{- $disabled{shared} -}]
557       LIBS=libcrypto
558       SOURCE[libcrypto]=...
559     ELSE
560       LIBS=libfoo
561       SOURCE[libfoo]=...
562     ENDIF
563
564 or:
565
566     # VMS has a cultural standard where all libraries are prefixed.
567     # For OpenSSL, the choice is 'ossl_'
568     IF[{- $config{target} =~ /^vms/ -}]
569      RENAME[libcrypto]=ossl_libcrypto
570      RENAME[libssl]=ossl_libssl
571     ENDIF
572
573
574 Build-file programming with the "unified" build system
575 ======================================================
576
577 "Build files" are called "Makefile" on Unix-like operating systems,
578 "descrip.mms" for MMS on VMS, "makefile" for nmake on Windows, etc.
579
580 To use the "unified" build system, the target configuration needs to
581 set the three items 'build_scheme', 'build_file' and 'build_command'.
582 In the rest of this section, we will assume that 'build_scheme' is set
583 to "unified" (see the configurations documentation above for the
584 details).
585
586 For any name given by 'build_file', the "unified" system expects a
587 template file in Configurations/ named like the build file, with
588 ".tmpl" appended, or in case of possible ambiguity, a combination of
589 the second 'build_scheme' list item and the 'build_file' name.  For
590 example, if 'build_file' is set to "Makefile", the template could be
591 Configurations/Makefile.tmpl or Configurations/unix-Makefile.tmpl.
592 In case both Configurations/unix-Makefile.tmpl and
593 Configurations/Makefile.tmpl are present, the former takes
594 precedence.
595
596 The build-file template is processed with the perl module
597 Text::Template, using "{-" and "-}" as delimiters that enclose the
598 perl code fragments that generate configuration-dependent content.
599 Those perl fragments have access to all the hash variables from
600 configdata.pem.
601
602 The build-file template is expected to define at least the following
603 perl functions in a perl code fragment enclosed with "{-" and "-}".
604 They are all expected to return a string with the lines they produce.
605
606     generatesrc - function that produces build file lines to generate
607                   a source file from some input.
608
609                   It's called like this:
610
611                         generatesrc(src => "PATH/TO/tobegenerated",
612                                     generator => [ "generatingfile", ... ]
613                                     generator_incs => [ "INCL/PATH", ... ]
614                                     generator_deps => [ "dep1", ... ]
615                                     generator => [ "generatingfile", ... ]
616                                     incs => [ "INCL/PATH", ... ],
617                                     deps => [ "dep1", ... ],
618                                     intent => one of "libs", "dso", "bin" );
619
620                   'src' has the name of the file to be generated.
621                   'generator' is the command or part of command to
622                   generate the file, of which the first item is
623                   expected to be the file to generate from.
624                   generatesrc() is expected to analyse and figure out
625                   exactly how to apply that file and how to capture
626                   the result.  'generator_incs' and 'generator_deps'
627                   are include directories and files that the generator
628                   file itself depends on.  'incs' and 'deps' are
629                   include directories and files that are used if $(CC)
630                   is used as an intermediary step when generating the
631                   end product (the file indicated by 'src').  'intent'
632                   indicates what the generated file is going to be
633                   used for.
634
635     src2obj     - function that produces build file lines to build an
636                   object file from source files and associated data.
637
638                   It's called like this:
639
640                         src2obj(obj => "PATH/TO/objectfile",
641                                 srcs => [ "PATH/TO/sourcefile", ... ],
642                                 deps => [ "dep1", ... ],
643                                 incs => [ "INCL/PATH", ... ]
644                                 intent => one of "lib", "dso", "bin" );
645
646                   'obj' has the intended object file with '.o'
647                   extension, src2obj() is expected to change it to
648                   something more suitable for the platform.
649                   'srcs' has the list of source files to build the
650                   object file, with the first item being the source
651                   file that directly corresponds to the object file.
652                   'deps' is a list of explicit dependencies.  'incs'
653                   is a list of include file directories.  Finally,
654                   'intent' indicates what this object file is going
655                   to be used for.
656
657     obj2lib     - function that produces build file lines to build a
658                   static library file ("libfoo.a" in Unix terms) from
659                   object files.
660
661                   called like this:
662
663                         obj2lib(lib => "PATH/TO/libfile",
664                                 objs => [ "PATH/TO/objectfile", ... ]);
665
666                   'lib' has the intended library file name *without*
667                   extension, obj2lib is expected to add that.  'objs'
668                   has the list of object files to build this library.
669
670     libobj2shlib - backward compatibility function that's used the
671                   same way as obj2shlib (described next), and was
672                   expected to build the shared library from the
673                   corresponding static library when that was suitable.
674                   NOTE: building a shared library from a static
675                   library is now DEPRECATED, as they no longer share
676                   object files.  Attempting to do this will fail.
677
678     obj2shlib   - function that produces build file lines to build a
679                   shareable object library file ("libfoo.so" in Unix
680                   terms) from the corresponding object files.
681
682                   called like this:
683
684                         obj2shlib(shlib => "PATH/TO/shlibfile",
685                                   lib => "PATH/TO/libfile",
686                                   objs => [ "PATH/TO/objectfile", ... ],
687                                   deps => [ "PATH/TO/otherlibfile", ... ]);
688
689                   'lib' has the base (static) library ffile name
690                   *without* extension.  This is useful in case
691                   supporting files are needed (such as import
692                   libraries on Windows).
693                   'shlib' has the corresponding shared library name
694                   *without* extension.  'deps' has the list of other
695                   libraries (also *without* extension) this library
696                   needs to be linked with.  'objs' has the list of
697                   object files to build this library.
698
699     obj2dso     - function that produces build file lines to build a
700                   dynamic shared object file from object files.
701
702                   called like this:
703
704                         obj2dso(lib => "PATH/TO/libfile",
705                                 objs => [ "PATH/TO/objectfile", ... ],
706                                 deps => [ "PATH/TO/otherlibfile",
707                                 ... ]);
708
709                   This is almost the same as obj2shlib, but the
710                   intent is to build a shareable library that can be
711                   loaded in runtime (a "plugin"...).
712
713     obj2bin     - function that produces build file lines to build an
714                   executable file from object files.
715
716                   called like this:
717
718                         obj2bin(bin => "PATH/TO/binfile",
719                                 objs => [ "PATH/TO/objectfile", ... ],
720                                 deps => [ "PATH/TO/libfile", ... ]);
721
722                   'bin' has the intended executable file name
723                   *without* extension, obj2bin is expected to add
724                   that.  'objs' has the list of object files to build
725                   this library.  'deps' has the list of library files
726                   (also *without* extension) that the programs needs
727                   to be linked with.
728
729     in2script   - function that produces build file lines to build a
730                   script file from some input.
731
732                   called like this:
733
734                         in2script(script => "PATH/TO/scriptfile",
735                                   sources => [ "PATH/TO/infile", ... ]);
736
737                   'script' has the intended script file name.
738                   'sources' has the list of source files to build the
739                   resulting script from.
740
741 In all cases, file file paths are relative to the build tree top, and
742 the build file actions run with the build tree top as current working
743 directory.
744
745 Make sure to end the section with these functions with a string that
746 you thing is appropriate for the resulting build file.  If nothing
747 else, end it like this:
748
749       "";       # Make sure no lingering values end up in the Makefile
750     -}
751
752
753 Configure helper scripts
754 ========================
755
756 Configure uses helper scripts in this directory:
757
758 Checker scripts
759 ---------------
760
761 These scripts are per platform family, to check the integrity of the
762 tools used for configuration and building.  The checker script used is
763 either {build_platform}-{build_file}-checker.pm or
764 {build_platform}-checker.pm, where {build_platform} is the second
765 'build_scheme' list element from the configuration target data, and
766 {build_file} is 'build_file' from the same target data.
767
768 If the check succeeds, the script is expected to end with a non-zero
769 expression.  If the check fails, the script can end with a zero, or
770 with a `die`.