From: Richard Levitte Date: Mon, 25 Jan 2016 20:19:59 +0000 (+0100) Subject: Generate warning text X-Git-Tag: OpenSSL_1_1_0-pre3~422 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=9ab6fc5936be62f6fee1c433938eae4c89aa23da;p=thirdparty%2Fopenssl.git Generate warning text Now that we're using templates, we should warn people not to edit the resulting file. We do it through util/dofile.pl, which is enhanced with an option to tell what file it was called from. We also change the calls so the template files are on the command line instead of being redirected through standard input. That way, we can display something like this (example taken from include/openssl/opensslconf.h): /* WARNING: do not edit! */ /* Generated by Configure from include/openssl/opensslconf.h.in */ Reviewed-by: Rich Salz --- diff --git a/Configure b/Configure index 2e88a731853..d5637401c47 100755 --- a/Configure +++ b/Configure @@ -1752,7 +1752,7 @@ sub run_dofile() my $out = shift; # should we remove $out ? - system("$config{perl} -I. -Mconfigdata util/dofile.pl <$in >$out.new"); + system("$config{perl} -I. -Mconfigdata util/dofile.pl -o\"Configure\" $in > $out.new"); exit 1 if $? != 0; rename("$out.new", $out) || die "Can't rename $out.new, $!"; } diff --git a/Makefile.in b/Makefile.in index e875f43bdc2..7db430d4bef 100644 --- a/Makefile.in +++ b/Makefile.in @@ -1,6 +1,7 @@ ## ## Makefile for OpenSSL ## +## {- join("\n## ", @autowarntext) -} VERSION={- $config{version} -} MAJOR={- $config{major} -} diff --git a/apps/CA.pl.in b/apps/CA.pl.in index b54df5efa95..52a97d73450 100644 --- a/apps/CA.pl.in +++ b/apps/CA.pl.in @@ -1,8 +1,8 @@ #!{- $config{perl} -} # # Wrapper around the ca to make it easier to use -# Edit CA.pl.in not CA.pl! - +# +# {- join("\n# ", @autowarntext) -} use strict; use warnings; diff --git a/apps/Makefile.in b/apps/Makefile.in index 290dff6ba53..8d2433b5c3d 100644 --- a/apps/Makefile.in +++ b/apps/Makefile.in @@ -140,7 +140,7 @@ progs.h: progs.pl Makefile $(RM) openssl.o CA.pl: CA.pl.in - $(PERL) -I$(TOP) -Mconfigdata $(TOP)/util/dofile.pl < CA.pl.in > CA.pl.new + $(PERL) -I$(TOP) -Mconfigdata $(TOP)/util/dofile.pl -oapps/Makefile CA.pl.in > CA.pl.new mv CA.pl.new CA.pl diff --git a/crypto/include/internal/bf_conf.h.in b/crypto/include/internal/bf_conf.h.in index 5b6e5e71909..552faae98e0 100644 --- a/crypto/include/internal/bf_conf.h.in +++ b/crypto/include/internal/bf_conf.h.in @@ -1,3 +1,4 @@ +{- join("\n",map { "/* $_ */" } @autowarntext) -} /* ==================================================================== * Copyright (c) 2016 The OpenSSL Project. All rights reserved. * diff --git a/crypto/include/internal/bn_conf.h.in b/crypto/include/internal/bn_conf.h.in index a75e9643009..5ebd55d522e 100644 --- a/crypto/include/internal/bn_conf.h.in +++ b/crypto/include/internal/bn_conf.h.in @@ -1,3 +1,4 @@ +{- join("\n",map { "/* $_ */" } @autowarntext) -} /* ==================================================================== * Copyright (c) 2016 The OpenSSL Project. All rights reserved. * diff --git a/crypto/include/internal/des_conf.h.in b/crypto/include/internal/des_conf.h.in index 43ab5eb99c3..2c4369bd78a 100644 --- a/crypto/include/internal/des_conf.h.in +++ b/crypto/include/internal/des_conf.h.in @@ -1,3 +1,4 @@ +{- join("\n",map { "/* $_ */" } @autowarntext) -} /* ==================================================================== * Copyright (c) 2016 The OpenSSL Project. All rights reserved. * diff --git a/crypto/include/internal/rc4_conf.h.in b/crypto/include/internal/rc4_conf.h.in index 5f23357fbf9..b5b2bd3fc0a 100644 --- a/crypto/include/internal/rc4_conf.h.in +++ b/crypto/include/internal/rc4_conf.h.in @@ -1,3 +1,4 @@ +{- join("\n",map { "/* $_ */" } @autowarntext) -} /* ==================================================================== * Copyright (c) 2016 The OpenSSL Project. All rights reserved. * diff --git a/include/openssl/opensslconf.h.in b/include/openssl/opensslconf.h.in index 3d7137e8f61..f54043acddb 100644 --- a/include/openssl/opensslconf.h.in +++ b/include/openssl/opensslconf.h.in @@ -1,5 +1,5 @@ /* opensslconf.h */ -/* WARNING: Generated automatically from opensslconf.h.in by Configure. */ +{- join("\n",map { "/* $_ */" } @autowarntext) -} #ifdef __cplusplus extern "C" { diff --git a/tools/Makefile.in b/tools/Makefile.in index b52b45f7d3b..d0c5ca26620 100644 --- a/tools/Makefile.in +++ b/tools/Makefile.in @@ -59,7 +59,7 @@ clean: errors: c_rehash: c_rehash.in - $(PERL) -I$(TOP) -Mconfigdata $(TOP)/util/dofile.pl < c_rehash.in > c_rehash.new + $(PERL) -I$(TOP) -Mconfigdata $(TOP)/util/dofile.pl -otools/Makefile c_rehash.in > c_rehash.new mv c_rehash.new c_rehash # DO NOT DELETE THIS LINE -- make depend depends on it. diff --git a/tools/c_rehash.in b/tools/c_rehash.in index 912618c2300..dc66a9d9625 100644 --- a/tools/c_rehash.in +++ b/tools/c_rehash.in @@ -1,5 +1,7 @@ #!{- $config{perl} -} +# {- join("\n# ", @autowarntext) -} + # Perl c_rehash script, scan all files in a directory # and add symbolic links to their hash values. diff --git a/util/dofile.pl b/util/dofile.pl index a6b0905a58a..780759b97c4 100644 --- a/util/dofile.pl +++ b/util/dofile.pl @@ -8,6 +8,8 @@ use strict; use warnings; +use Getopt::Std; + # Because we know that Text::Template isn't a core Perl module, we use # a fallback in case it's not installed on the system use File::Basename; @@ -74,6 +76,19 @@ sub broken { undef; } +# Check options ###################################################### + +my %opts = (); + +# -o ORIGINATOR +# declares ORIGINATOR as the originating script. +getopt('o', \%opts); + +my @autowarntext = ("WARNING: do not edit!", + "Generated" + . (defined($opts{o}) ? " by ".$opts{o} : "") + . (scalar(@ARGV) > 0 ? " from ".join(", ",@ARGV) : "")); + # Template reading ################################################### # Read in all the templates into $text, while keeping track of each @@ -100,6 +115,7 @@ $template->fill_in(OUTPUT => \*STDOUT, HASH => { config => \%config, target => \%target, withargs => \%withargs, + autowarntext => \@autowarntext, quotify1 => \"ify1, quotify_l => \"ify_l }, DELIMITERS => [ "{-", "-}" ],