瀏覽代碼

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 <rsalz@openssl.org>
Richard Levitte 8 年之前
父節點
當前提交
9ab6fc5936

+ 1 - 1
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, $!";
 }

+ 1 - 0
Makefile.in

@@ -1,6 +1,7 @@
 ##
 ## Makefile for OpenSSL
 ##
+## {- join("\n## ", @autowarntext) -}
 
 VERSION={- $config{version} -}
 MAJOR={- $config{major} -}

+ 2 - 2
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;

+ 1 - 1
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
 
 

+ 1 - 0
crypto/include/internal/bf_conf.h.in

@@ -1,3 +1,4 @@
+{- join("\n",map { "/* $_ */" } @autowarntext) -}
 /* ====================================================================
  * Copyright (c) 2016 The OpenSSL Project.  All rights reserved.
  *

+ 1 - 0
crypto/include/internal/bn_conf.h.in

@@ -1,3 +1,4 @@
+{- join("\n",map { "/* $_ */" } @autowarntext) -}
 /* ====================================================================
  * Copyright (c) 2016 The OpenSSL Project.  All rights reserved.
  *

+ 1 - 0
crypto/include/internal/des_conf.h.in

@@ -1,3 +1,4 @@
+{- join("\n",map { "/* $_ */" } @autowarntext) -}
 /* ====================================================================
  * Copyright (c) 2016 The OpenSSL Project.  All rights reserved.
  *

+ 1 - 0
crypto/include/internal/rc4_conf.h.in

@@ -1,3 +1,4 @@
+{- join("\n",map { "/* $_ */" } @autowarntext) -}
 /* ====================================================================
  * Copyright (c) 2016 The OpenSSL Project.  All rights reserved.
  *

+ 1 - 1
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" {

+ 1 - 1
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.

+ 2 - 0
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.
 

+ 16 - 0
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 => \&quotify1,
                              quotify_l => \&quotify_l },
                    DELIMITERS => [ "{-", "-}" ],