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