diff options
| author | Richard Levitte <levitte@openssl.org> | 2017-03-06 11:19:49 +0100 |
|---|---|---|
| committer | Richard Levitte <levitte@openssl.org> | 2017-03-06 16:43:22 +0100 |
| commit | 08beac4f3d37247e2ed3bf49dd7d760f4c3e0389 (patch) | |
| tree | d4b462b5063d5437845b3b86a8462616c2a88ef7 /Configurations | |
| parent | a40b5be27e28eaf5a8be7193c8b6460bc6f851b4 (diff) | |
Add documentation on platform specific checks
Reviewed-by: Andy Polyakov <appro@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/2851)
(cherry picked from commit 44eb65ce20d673d0332802275d54f6811f448076)
Diffstat (limited to 'Configurations')
| -rw-r--r-- | Configurations/README | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/Configurations/README b/Configurations/README index da64e8c79b..428ac31eea 100644 --- a/Configurations/README +++ b/Configurations/README @@ -1,3 +1,20 @@ +Intro +===== + +This directory contains a few sets of files that are used for +configuration in diverse ways: + + *.conf Target platform configurations, please read + 'Configurations of OpenSSL target platforms' for more + information. + *.tmpl Build file templates, please read 'Build-file + programming with the "unified" build system' as well + as 'Build info files' for more information. + *.pm Helper scripts / modules for the main `Configure` + script. See 'Configure helper scripts for more + information. + + Configurations of OpenSSL target platforms ========================================== @@ -653,3 +670,23 @@ else, end it like this: ""; # Make sure no lingering values end up in the Makefile -} + + +Configure helper scripts +======================== + +Configure uses helper scripts in this directory: + +Checker scripts +--------------- + +These scripts are per platform family, to check the integrity of the +tools used for configuration and building. The checker script used is +either {build_platform}-{build_file}-checker.pm or +{build_platform}-checker.pm, where {build_platform} is the second +'build_scheme' list element from the configuration target data, and +{build_file} is 'build_file' from the same target data. + +If the check succeeds, the script is expected to end with a non-zero +expression. If the check fails, the script can end with a zero, or +with a `die`. |