X-Git-Url: https://git.openssl.org/?p=openssl.git;a=blobdiff_plain;f=Configurations%2FREADME;h=c1f80fe49e8db90e528b0a3df7561aaca3af0e1a;hp=d553cab6d26f0b136843f7e8a09f4e513015085c;hb=d1dd5d6f4c2f13478aa45557b4546febd51f0cb3;hpb=edc79fc99e1efec04c2a0a7f652269364981e6aa diff --git a/Configurations/README b/Configurations/README index d553cab6d2..c1f80fe49e 100644 --- a/Configurations/README +++ b/Configurations/README @@ -165,11 +165,18 @@ In each table entry, the following keys are significant: that use dlopen() et al but do not have fcntl.h), "DL" (shl_load() et al), "WIN32" and "VMS". - perlasm_scheme => The perlasm method used to created the + perlasm_scheme => The perlasm method used to create the 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. @@ -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 - explicitely. + explicitly. 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. -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 @@ -429,27 +442,10 @@ It's also possible to depend on static libraries explicitly: This should be rarely used, and care should be taken to make sure it's only used when supported. For example, native Windows build doesn't -support build static libraries and DLLs at the same time, so using +support building static libraries and DLLs at the same time, so using static libraries on Windows can only be done when configured 'no-shared'. -One some platforms, shared libraries come with a name that's different -from their static counterpart. That's declared as follows: - - SHARED_NAME[libfoo]=cygfoo-{- $config{shlibver} -} - -The example is from Cygwin, which has a required naming convention. - -Sometimes, it makes sense to rename an output file, for example a -library: - - RENAME[libfoo]=libbar - -That lines has "libfoo" get renamed to "libbar". While it makes no -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: @@ -460,6 +456,10 @@ include paths the build of their source files should use: 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: @@ -554,15 +554,6 @@ conditions based on something in the passed variables, for example: SOURCE[libfoo]=... ENDIF -or: - - # VMS has a cultural standard where all libraries are prefixed. - # For OpenSSL, the choice is 'ossl_' - IF[{- $config{target} =~ /^vms/ -}] - RENAME[libcrypto]=ossl_libcrypto - RENAME[libssl]=ossl_libssl - ENDIF - Build-file programming with the "unified" build system ====================================================== @@ -636,8 +627,9 @@ They are all expected to return a string with the lines they produce. incs => [ "INCL/PATH", ... ] intent => one of "lib", "dso", "bin" ); - 'obj' has the intended object file *without* - extension, src2obj() is expected to add that. + 'obj' has the intended object file with '.o' + extension, src2obj() is expected to change it to + something more suitable for the platform. '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. @@ -657,33 +649,36 @@ They are all expected to return a string with the lines they produce. 'lib' has the intended library file name *without* extension, obj2lib is expected to add that. 'objs' - has the list of object files (also *without* - extension) to build this library. + has the list of object files to build this library. + + libobj2shlib - backward compatibility function that's used the + same way as obj2shlib (described next), and was + expected to build the shared library from the + corresponding static library when that was suitable. + NOTE: building a shared library from a static + library is now DEPRECATED, as they no longer share + object files. Attempting to do this will fail. - libobj2shlib - function that produces build file lines to build a + obj2shlib - function that produces build file lines to build a shareable object library file ("libfoo.so" in Unix - terms) from the corresponding static library file - or object files. + terms) from the corresponding object files. called like this: - libobj2shlib(shlib => "PATH/TO/shlibfile", - lib => "PATH/TO/libfile", - objs => [ "PATH/TO/objectfile", ... ], - deps => [ "PATH/TO/otherlibfile", ... ]); + obj2shlib(shlib => "PATH/TO/shlibfile", + lib => "PATH/TO/libfile", + objs => [ "PATH/TO/objectfile", ... ], + deps => [ "PATH/TO/otherlibfile", ... ]); - 'lib' has the intended library file name *without* - extension, libobj2shlib is expected to add that. + 'lib' has the base (static) library ffile name + *without* extension. This is useful in case + supporting files are needed (such as import + libraries on Windows). '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 - object files (also *without* extension) to build - this library. - - This function has a choice; it can use the - corresponding static library as input to make the - shared library, or the list of object files. + object files to build this library. obj2dso - function that produces build file lines to build a dynamic shared object file from object files. @@ -695,12 +690,9 @@ They are all expected to return a string with the lines they produce. deps => [ "PATH/TO/otherlibfile", ... ]); - This is almost the same as libobj2shlib, but the + This is almost the same as obj2shlib, but the intent is to build a shareable library that can be - loaded in runtime (a "plugin"...). The differences - are subtle, one of the most visible ones is that the - resulting shareable library is produced from object - files only. + loaded in runtime (a "plugin"...). obj2bin - function that produces build file lines to build an executable file from object files. @@ -713,11 +705,10 @@ They are all expected to return a string with the lines they produce. 'bin' has the intended executable file name *without* extension, obj2bin is expected to add - that. 'objs' has the list of object files (also - *without* extension) to build this library. 'deps' - has the list of library files (also *without* - extension) that the programs needs to be linked - with. + that. 'objs' has the list of object files to build + this library. 'deps' has the list of library files + (also *without* extension) that the programs needs + to be linked with. in2script - function that produces build file lines to build a script file from some input.