X-Git-Url: https://git.openssl.org/gitweb/?p=openssl.git;a=blobdiff_plain;f=Configurations%2FREADME;h=0b82dedca903723a9fa5e9ded5c4a6e8d64be24e;hp=75907a6d5c4ecccdfa64063db6827ba1360fd407;hb=475592e2419c5cb3098dfea4c9229d0c09ea7010;hpb=ddf1847dc81c30e80e7027c928720bf869264bd4 diff --git a/Configurations/README b/Configurations/README index 75907a6d5c..0b82dedca9 100644 --- a/Configurations/README +++ b/Configurations/README @@ -17,24 +17,25 @@ In each table entry, the following keys are significant: sys_id => System identity for systems where that is difficult to determine automatically. - cc => The compiler command, usually one of "cc", + cc => The C compiler command, usually one of "cc", "gcc" or "clang". This command is normally also used to link object files and libraries into the final program. + cxx => The C++ compiler command, usually one of + "c++", "g++" or "clang++". This command is + also used when linking a program where at + least one of the object file is made from + C++ source. cflags => Flags that are used at all times when - compiling. - debug_cflags => Extra compilation flags used when making a - debug build (when Configure receives the - --debug option). Typically something like - "-g -O0". - release_cflags => Extra compilation flags used when making a - release build (when Configure receives the - --release option, or doesn't receive the - --debug option). Typically something like - "-O" or "-O3". - thread_cflags => Extra compilation flags used when - compiling with threading enabled. - Explained further below. [2] + compiling C object files. + cxxflags => Flags that are used at all times when + compiling C++ object files. If unset, it + gets the same value as cflags. + defines => As an alternative, macro definitions may be + present here instead of in `cflags'. If + given here, they MUST be as an array of the + string such as "MACRO=value", or just + "MACRO" for definitions without value. shared_cflag => Extra compilation flags used when compiling for shared libraries, typically something like "-fPIC". @@ -53,9 +54,6 @@ In each table entry, the following keys are significant: ex_libs => Extra libraries that are needed when linking. - debug_lflags => Like debug_cflags, but used when linking. - release_lflags => Like release_cflags, but used when linking. - ar => The library archive command, the default is "ar". (NOTE: this is here for future use, it's @@ -80,6 +78,14 @@ In each table entry, the following keys are significant: this is here for future use, it's not implemented yet) + thread_scheme => The type of threads is used on the + configured platform. Currently known + values are "(unknown)", "pthreads", + "uithreads" (a.k.a solaris threads) and + "winthreads". Except for "(unknown)", the + actual value is currently ignored but may + be used in the future. See further notes + below [2]. dso_scheme => The type of dynamic shared objects to build for. This mostly comes into play with engines, but can be used for other purposes @@ -101,8 +107,7 @@ In each table entry, the following keys are significant: some options. In this case, the first string in the list is the name of the build scheme. - Currently recognised build schemes are - "mk1mf" and "unixmake" and "unified". + Currently recognised build scheme is "unified". For the "unified" build scheme, this item *must* be an array with the first being the word "unified" and the second being a word @@ -146,6 +151,8 @@ In each table entry, the following keys are significant: export vars as accessor functions. + apps_extra_src => Extra source to build apps/openssl, as + needed by the target. cpuid_asm_src => assembler implementation of cpuid code as well as OPENSSL_cleanse(). Default to mem_clr.c @@ -197,7 +204,7 @@ In each table entry, the following keys are significant: 'inherit_from' that indicate what other configurations to inherit data from. These are resolved recursively. - Inheritance works as a set of default values that can be overriden + Inheritance works as a set of default values that can be overridden by corresponding key values in the inheriting configuration. Note 1: any configuration table can be used as a template. @@ -246,7 +253,7 @@ In each table entry, the following keys are significant: } [2] OpenSSL is built with threading capabilities unless the user - specifies 'no-threads'. The value of the key 'thread_cflags' may + specifies 'no-threads'. The value of the key 'thread_scheme' may be "(unknown)", in which case the user MUST give some compilation flags to Configure. @@ -358,20 +365,51 @@ sense at all to just have a rename like that (why not just use "libbar" everywhere?), it does make sense when it can be used conditionally. See a little further below for an example. +In some cases, it's desirable to include some source files in the +shared form of a library only: + + SHARED_SOURCE[libfoo]=dllmain.c + For any file to be built, it's also possible to tell what extra include paths the build of their source files should use: INCLUDE[foo]=include -It's possible to have raw build file lines, between BEGINRAW and -ENDRAW lines as follows: +In some cases, one might want to generate some source files from +others, that's done as follows: + + GENERATE[foo.s]=asm/something.pl $(CFLAGS) + GENERATE[bar.s]=asm/bar.S + +The value of each GENERATE line is a command line or part of it. +Configure places no rules on the command line, except the the first +item muct be the generator file. It is, however, entirely up to the +build file template to define exactly how those command lines should +be handled, how the output is captured and so on. + +Sometimes, the generator file itself depends on other files, for +example if it is a perl script that depends on other perl modules. +This can be expressed using DEPEND like this: + + DEPEND[asm/something.pl]=../perlasm/Foo.pm + +There may also be cases where the exact file isn't easily specified, +but an inclusion directory still needs to be specified. INCLUDE can +be used in that case: + + INCLUDE[asm/something.pl]=../perlasm + +NOTE: GENERATE lines are limited to one command only per GENERATE. + +As a last resort, it's possible to have raw build file lines, between +BEGINRAW and ENDRAW lines as follows: BEGINRAW[Makefile(unix)] haha.h: {- $builddir -}/Makefile echo "/* haha */" > haha.h ENDRAW[Makefile(unix)] -The word withing square brackets is the build_file configuration item +The word within square brackets is the build_file configuration item or the build_file configuration item followed by the second word in the build_scheme configuration item for the configured target within parenthesis as shown above. For example, with the following relevant @@ -390,6 +428,18 @@ configuration items: build hoho.h: echo "/* hoho */" > hoho.h ENDRAW[build.ninja(unix)] +Should it be needed because the recipes within a RAW section might +clash with those generated by Configure, it's possible to tell it +not to generate them with the use of OVERRIDES, for example: + + SOURCE[libfoo]=foo.c bar.c + + OVERRIDES=bar.o + BEGINRAW[Makefile(unix)] + bar.o: bar.c + $(CC) $(CFLAGS) -DSPECIAL -c -o $@ $< + ENDRAW[Makefile(unix)] + See the documentation further up for more information on configuration items. @@ -411,7 +461,7 @@ example, the above would have "something" used, since 1 is true. Together with the use of Text::Template, this can be used as conditions based on something in the passed variables, for example: - IF[{- $config{no_shared} -}] + IF[{- $disabled{shared} -}] LIBS=libcrypto SOURCE[libcrypto]=... ELSE @@ -461,23 +511,34 @@ The build-file template is expected to define at least the following perl functions in a perl code fragment enclosed with "{-" and "-}". They are all expected to return a string with the lines they produce. - src2dep - function that produces build file lines to get the - dependencies for an object file into a dependency - file. + generatesrc - function that produces build file lines to generate + a source file from some input. It's called like this: - src2dep(obj => "PATH/TO/objectfile", - srcs => [ "PATH/TO/sourcefile", ... ], - incs => [ "INCL/PATH", ... ]); - - 'obj' has the dependent object file as well as - object file the dependencies are for; it's *without* - extension, src2dep() is expected to add that. - 'srcs' has the list of source files to build the - object file, with the first item being the source - file that directly corresponds to the object file. - 'incs' is a list of include file directories. + generatesrc(src => "PATH/TO/tobegenerated", + generator => [ "generatingfile", ... ] + generator_incs => [ "INCL/PATH", ... ] + generator_deps => [ "dep1", ... ] + generator => [ "generatingfile", ... ] + incs => [ "INCL/PATH", ... ], + deps => [ "dep1", ... ], + intent => one of "libs", "dso", "bin" ); + + 'src' has the name of the file to be generated. + 'generator' is the command or part of command to + generate the file, of which the first item is + expected to be the file to generate from. + generatesrc() is expected to analyse and figure out + exactly how to apply that file and how to capture + the result. 'generator_incs' and 'generator_deps' + are include directories and files that the generator + file itself depends on. 'incs' and 'deps' are + include directories and files that are used if $(CC) + is used as an intermediary step when generating the + end product (the file indicated by 'src'). 'intent' + indicates what the generated file is going to be + used for. src2obj - function that produces build file lines to build an object file from source files and associated data. @@ -487,15 +548,18 @@ They are all expected to return a string with the lines they produce. src2obj(obj => "PATH/TO/objectfile", srcs => [ "PATH/TO/sourcefile", ... ], deps => [ "dep1", ... ], - incs => [ "INCL/PATH", ... ]); + incs => [ "INCL/PATH", ... ] + intent => one of "lib", "dso", "bin" ); 'obj' has the intended object file *without* extension, src2obj() is expected to add that. 'srcs' has the list of source files to build the object file, with the first item being the source file that directly corresponds to the object file. - 'deps' is a list of dependencies. 'incs' is a list - of include file directories. + 'deps' is a list of explicit dependencies. 'incs' + is a list of include file directories. Finally, + 'intent' indicates what this object file is going + to be used for. obj2lib - function that produces build file lines to build a static library file ("libfoo.a" in Unix terms) from @@ -526,7 +590,7 @@ They are all expected to return a string with the lines they produce. 'lib' has the intended library file name *without* extension, libobj2shlib is expected to add that. - 'shlib' has the correcponding shared library name + 'shlib' has the corresponding shared library name *without* extension. 'deps' has the list of other libraries (also *without* extension) this library needs to be linked with. 'objs' has the list of @@ -541,16 +605,15 @@ They are all expected to return a string with the lines they produce. corresponding static library as input to make the shared library, or the list of object files. - obj2dynlib - function that produces build file lines to build a - dynamically loadable library file ("libfoo.so" on - Unix) from object files. + obj2dso - function that produces build file lines to build a + dynamic shared object file from object files. called like this: - obj2dynlib(lib => "PATH/TO/libfile", - objs => [ "PATH/TO/objectfile", ... ], - deps => [ "PATH/TO/otherlibfile", - ... ]); + obj2dso(lib => "PATH/TO/libfile", + objs => [ "PATH/TO/objectfile", ... ], + deps => [ "PATH/TO/otherlibfile", + ... ]); This is almost the same as libobj2shlib, but the intent is to build a shareable library that can be @@ -593,7 +656,7 @@ the build file actions run with the build tree top as current working directory. Make sure to end the section with these functions with a string that -you thing is apropriate for the resulting build file. If nothing +you thing is appropriate for the resulting build file. If nothing else, end it like this: ""; # Make sure no lingering values end up in the Makefile