gnulib: check-module annotate

annotate check-module @ 40196:e63f5d3edab5

relocatable-prog: Update documentation. * doc/relocatable-maint.texi (Supporting Relocation): Update to match the recent changes.

author	Bruno Haible <bruno@clisp.org>
date	Sun, 24 Feb 2019 01:49:15 +0100
parents	b06060465f09
children

rev	line source
5769 63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	1 #!/usr/bin/perl -w
7134 0ec466622052 * check-module: Add copyright notice. Paul Eggert <eggert@cs.ucla.edu> parents: 6168 diff changeset	2 # Check a gnulib module.
0ec466622052 * check-module: Add copyright notice. Paul Eggert <eggert@cs.ucla.edu> parents: 6168 diff changeset	3
40057 b06060465f09 maint: Run 'make update-copyright' Paul Eggert <eggert@cs.ucla.edu> parents: 19484 diff changeset	4 # Copyright (C) 2005-2007, 2009-2019 Free Software Foundation, Inc.
7134 0ec466622052 * check-module: Add copyright notice. Paul Eggert <eggert@cs.ucla.edu> parents: 6168 diff changeset	5
9309 bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+. Bruno Haible <bruno@clisp.org> parents: 9111 diff changeset	6 # This file is free software: you can redistribute it and/or modify it
7134 0ec466622052 * check-module: Add copyright notice. Paul Eggert <eggert@cs.ucla.edu> parents: 6168 diff changeset	7 # under the terms of the GNU General Public License as published by
9309 bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+. Bruno Haible <bruno@clisp.org> parents: 9111 diff changeset	8 # the Free Software Foundation; either version 3 of the License, or
7134 0ec466622052 * check-module: Add copyright notice. Paul Eggert <eggert@cs.ucla.edu> parents: 6168 diff changeset	9 # (at your option) any later version.
0ec466622052 * check-module: Add copyright notice. Paul Eggert <eggert@cs.ucla.edu> parents: 6168 diff changeset	10 #
9309 bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+. Bruno Haible <bruno@clisp.org> parents: 9111 diff changeset	11 # This program is distributed in the hope that it will be useful,
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+. Bruno Haible <bruno@clisp.org> parents: 9111 diff changeset	12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+. Bruno Haible <bruno@clisp.org> parents: 9111 diff changeset	13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+. Bruno Haible <bruno@clisp.org> parents: 9111 diff changeset	14 # GNU General Public License for more details.
7134 0ec466622052 * check-module: Add copyright notice. Paul Eggert <eggert@cs.ucla.edu> parents: 6168 diff changeset	15 #
0ec466622052 * check-module: Add copyright notice. Paul Eggert <eggert@cs.ucla.edu> parents: 6168 diff changeset	16 # You should have received a copy of the GNU General Public License
19190 9759915b2aca all: prefer https: URLs Paul Eggert <eggert@cs.ucla.edu> parents: 18626 diff changeset	17 # along with this program. If not, see <https://www.gnu.org/licenses/>.
7134 0ec466622052 * check-module: Add copyright notice. Paul Eggert <eggert@cs.ucla.edu> parents: 6168 diff changeset	18
0ec466622052 * check-module: Add copyright notice. Paul Eggert <eggert@cs.ucla.edu> parents: 6168 diff changeset	19
5769 63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	20 # Read a module description file and derive the set of files
16235 18a38c9615f0 In commentary, do not use ` to quote. Paul Eggert <eggert@cs.ucla.edu> parents: 16234 diff changeset	21 # included directly by any .c or .h file listed in the 'Files:' section.
5769 63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	22 # Take the union of all such sets for any dependent modules.
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	23 # Then, compare that set with the set derived from the names
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	24 # listed in the various Files: sections.
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	25
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	26 # This script makes no attempt to diagnose invalid or empty
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	27 # module-description files.
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	28
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	29 # Written by Jim Meyering
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	30
6168 c7048f559336 Add a FIXME comment. Jim Meyering <jim@meyering.net> parents: 6157 diff changeset	31 # FIXME:
c7048f559336 Add a FIXME comment. Jim Meyering <jim@meyering.net> parents: 6157 diff changeset	32 # for each .m4 file listed in the Files: section(s)
c7048f559336 Add a FIXME comment. Jim Meyering <jim@meyering.net> parents: 6157 diff changeset	33 # parse it for AC_LIBSOURCES directives, and accumulate the set
16235 18a38c9615f0 In commentary, do not use ` to quote. Paul Eggert <eggert@cs.ucla.edu> parents: 16234 diff changeset	34 # of files "required" via all AC_LIBSOURCES.
6168 c7048f559336 Add a FIXME comment. Jim Meyering <jim@meyering.net> parents: 6157 diff changeset	35 # If this set is not empty, ensure that it contains
c7048f559336 Add a FIXME comment. Jim Meyering <jim@meyering.net> parents: 6157 diff changeset	36 # the same (.c and .h only?) files as are listed in the Files: sections.
c7048f559336 Add a FIXME comment. Jim Meyering <jim@meyering.net> parents: 6157 diff changeset	37
5769 63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	38 use strict;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	39 use Getopt::Long;
11865 84ae262254ad check-module: revive Jim Meyering <meyering@redhat.com> parents: 9309 diff changeset	40 use File::Basename;
5769 63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	41 #use Coda;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	42
7134 0ec466622052 * check-module: Add copyright notice. Paul Eggert <eggert@cs.ucla.edu> parents: 6168 diff changeset	43 my $COPYRIGHT_NOTICE = "Copyright (C) 2006 Free Software Foundation, Inc.\n".
0ec466622052 * check-module: Add copyright notice. Paul Eggert <eggert@cs.ucla.edu> parents: 6168 diff changeset	44 "This is free software. You may redistribute copies of it under the terms of\n".
19190 9759915b2aca all: prefer https: URLs Paul Eggert <eggert@cs.ucla.edu> parents: 18626 diff changeset	45 "the GNU General Public License <https://www.gnu.org/licenses/gpl.html>.\n".
7134 0ec466622052 * check-module: Add copyright notice. Paul Eggert <eggert@cs.ucla.edu> parents: 6168 diff changeset	46 "There is NO WARRANTY, to the extent permitted by law.\n";
0ec466622052 * check-module: Add copyright notice. Paul Eggert <eggert@cs.ucla.edu> parents: 6168 diff changeset	47
9111 5e12596c4187 * check-module: Diagnose a self-dependency. Jim Meyering <jim@meyering.net> parents: 7668 diff changeset	48 (my $VERSION = '$Revision: 1.8 $ ') =~ tr/[0-9].//cd;
5769 63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	49 (my $ME = $0) =~ s\|.*/\|\|;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	50
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	51 use constant ST_INIT => 1;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	52 use constant ST_FILES => 2;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	53 use constant ST_DEPENDENTS => 3;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	54
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	55 # Parse a module file (returning list of Files: names and
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	56 # list of dependent-modules.
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	57 # my ($file, $dep) = parse_module_file $module_file;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	58 sub parse_module_file ($)
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	59 {
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	60 my ($module_file) = @_;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	61
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	62 open FH, '<', $module_file
16234 f9b906545e2f Use ', not `, for quoting output. Paul Eggert <eggert@cs.ucla.edu> parents: 16201 diff changeset	63 or die "$ME: can't open '$module_file' for reading: $!\n";
5769 63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	64
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	65 my %file_set;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	66 my %dep_set;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	67
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	68 my $state = ST_INIT;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	69 while (defined (my $line = <FH>))
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	70 {
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	71 if ($state eq ST_INIT)
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	72 {
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	73 if ($line =~ /^Files:$/)
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	74 {
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	75 $state = ST_FILES;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	76 }
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	77 elsif ($line =~ /^Depends-on:$/)
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	78 {
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	79 $state = ST_DEPENDENTS;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	80 }
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	81 }
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	82 else
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	83 {
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	84 chomp $line;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	85 $line =~ s/^\s+//;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	86 $line =~ s/\s+$//;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	87 if ( ! $line)
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	88 {
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	89 $state = ST_INIT;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	90 next;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	91 }
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	92
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	93 if ($state eq ST_FILES)
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	94 {
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	95 $file_set{$line} = 1;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	96 }
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	97 elsif ($state eq ST_DEPENDENTS)
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	98 {
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	99 $dep_set{$line} = 1;
9111 5e12596c4187 * check-module: Diagnose a self-dependency. Jim Meyering <jim@meyering.net> parents: 7668 diff changeset	100 (my $base = $module_file) =~ s,.*/,,;
5e12596c4187 * check-module: Diagnose a self-dependency. Jim Meyering <jim@meyering.net> parents: 7668 diff changeset	101 $line eq $base
5e12596c4187 * check-module: Diagnose a self-dependency. Jim Meyering <jim@meyering.net> parents: 7668 diff changeset	102 and die "$ME: module $module_file depends on itself\n";
5769 63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	103 }
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	104 }
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	105 }
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	106 close FH;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	107
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	108 # my @t = sort keys %file_set;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	109 # print "files: @t\n";
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	110 # my @u = sort keys %dep_set;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	111 # print "dependents: @u\n";
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	112
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	113 return (\%file_set, \%dep_set);
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	114 }
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	115
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	116 # Extract the set of files required for this module, including
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	117 # those required via dependent modules.
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	118
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	119 # Files:
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	120 # lib/stat.c
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	121 # m4/stat.m4
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	122 # lib/foo.h
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	123 #
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	124 # Depends-on:
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	125 # some-other-module
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	126
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	127 sub usage ($)
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	128 {
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	129 my ($exit_code) = @_;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	130 my $STREAM = ($exit_code == 0 ? STDOUT : STDERR);
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	131 if ($exit_code != 0)
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	132 {
16234 f9b906545e2f Use ', not `, for quoting output. Paul Eggert <eggert@cs.ucla.edu> parents: 16201 diff changeset	133 print $STREAM "Try '$ME --help' for more information.\n";
5769 63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	134 }
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	135 else
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	136 {
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	137 print $STREAM <<EOF;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	138 Usage: $ME [OPTIONS] FILE...
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	139
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	140 Read a module description file and derive the set of files
16234 f9b906545e2f Use ', not `, for quoting output. Paul Eggert <eggert@cs.ucla.edu> parents: 16201 diff changeset	141 included directly by any .c or .h file listed in the 'Files:' section.
5769 63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	142 Take the union of all such sets for any dependent modules.
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	143 Then, compare that set with the set derived from the names
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	144 listed in the various Files: sections.
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	145
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	146 OPTIONS:
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	147
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	148 --help display this help and exit
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	149 --version output version information and exit
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	150
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	151 EOF
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	152 }
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	153 exit $exit_code;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	154 }
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	155
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	156 sub find_included_lib_files ($)
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	157 {
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	158 my ($file) = @_;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	159
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	160 # Special cases...
7165 117d96f809c4 * check-module (find_included_lib_files): Add at-func.c to the Jim Meyering <jim@meyering.net> parents: 7134 diff changeset	161 my %special_non_dup = ( 'fnmatch_loop.c' => 1,
11865 84ae262254ad check-module: revive Jim Meyering <meyering@redhat.com> parents: 9309 diff changeset	162 'regex.c' => 1, 'at-func.c' => 1,
84ae262254ad check-module: revive Jim Meyering <meyering@redhat.com> parents: 9309 diff changeset	163 'vasnprintf.c' => 1
84ae262254ad check-module: revive Jim Meyering <meyering@redhat.com> parents: 9309 diff changeset	164 );
84ae262254ad check-module: revive Jim Meyering <meyering@redhat.com> parents: 9309 diff changeset	165 my %dup_include_ok;
84ae262254ad check-module: revive Jim Meyering <meyering@redhat.com> parents: 9309 diff changeset	166 $dup_include_ok{'vasnprintf.c'}{'isnand-nolibm.h'} = 1;
84ae262254ad check-module: revive Jim Meyering <meyering@redhat.com> parents: 9309 diff changeset	167 $dup_include_ok{'vasnprintf.c'}{'isnanl-nolibm.h'} = 1;
84ae262254ad check-module: revive Jim Meyering <meyering@redhat.com> parents: 9309 diff changeset	168 $dup_include_ok{'vasnprintf.c'}{'fpucw.h'} = 1;
84ae262254ad check-module: revive Jim Meyering <meyering@redhat.com> parents: 9309 diff changeset	169 $dup_include_ok{'gen-uni-tables.c'}{'3level.h'} = 1;
84ae262254ad check-module: revive Jim Meyering <meyering@redhat.com> parents: 9309 diff changeset	170 $dup_include_ok{'csharpexec.c'}{'classpath.c'} = 1;
84ae262254ad check-module: revive Jim Meyering <meyering@redhat.com> parents: 9309 diff changeset	171 $dup_include_ok{'csharpexec.c'}{'classpath.h'} = 1;
5769 63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	172
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	173 my %inc;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	174 open FH, '<', $file
16234 f9b906545e2f Use ', not `, for quoting output. Paul Eggert <eggert@cs.ucla.edu> parents: 16201 diff changeset	175 or die "$ME: can't open '$file' for reading: $!\n";
5769 63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	176
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	177 while (defined (my $line = <FH>))
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	178 {
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	179 # Ignore test-driver code at end of file.
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	180 $line =~ m!^\#if(def)? TEST_!
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	181 and last;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	182
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	183 $line =~ m!^\s\#\sinclude\s+"!
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	184 or next;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	185 $line =~ s///;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	186 chomp $line;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	187 $line =~ s/".*//;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	188 exists $inc{$line} && ! exists $special_non_dup{$line}
11865 84ae262254ad check-module: revive Jim Meyering <meyering@redhat.com> parents: 9309 diff changeset	189 && ! exists $dup_include_ok{basename $file}{$line}
5769 63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	190 and warn "$ME: $file: duplicate inclusion of $line\n";
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	191
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	192 $inc{$line} = 1;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	193 }
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	194 close FH;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	195
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	196 return \%inc;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	197 }
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	198
6157 915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	199 my %exempt_header =
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	200 (
16235 18a38c9615f0 In commentary, do not use ` to quote. Paul Eggert <eggert@cs.ucla.edu> parents: 16234 diff changeset	201 # Exempt headers like unlocked-io.h that are '#include'd
6157 915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	202 # but not necessarily used.
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	203 'unlocked-io.h' => 1,
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	204
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	205 # Give gettext.h a free pass only when included from lib/error.c,
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	206 # since we've made that exception solely to make the error
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	207 # module easier to use -- at RMS's request.
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	208 'lib/error.c:gettext.h' => 1,
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	209
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	210 # The full-read module shares code with the full-write module.
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	211 'lib/full-write.c:full-read.h' => 1,
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	212
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	213 # The safe-write module shares code with the safe-read module.
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	214 'lib/safe-read.c:safe-write.h' => 1,
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	215
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	216 # The use of obstack.h in the hash module is conditional, off by default.
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	217 'lib/hash.c:obstack.h' => 1,
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	218
7668 502a0e8a8bfe * check-module (%exempt_header): Add exception for some Jim Meyering <jim@meyering.net> parents: 7165 diff changeset	219 # C files in the gc module have conditional includes.
502a0e8a8bfe * check-module (%exempt_header): Add exception for some Jim Meyering <jim@meyering.net> parents: 7165 diff changeset	220 'lib/gc-gnulib.c:des.h' => 1,
502a0e8a8bfe * check-module (%exempt_header): Add exception for some Jim Meyering <jim@meyering.net> parents: 7165 diff changeset	221 'lib/gc-gnulib.c:arcfour.h' => 1,
502a0e8a8bfe * check-module (%exempt_header): Add exception for some Jim Meyering <jim@meyering.net> parents: 7165 diff changeset	222 'lib/gc-gnulib.c:arctwo.h' => 1,
502a0e8a8bfe * check-module (%exempt_header): Add exception for some Jim Meyering <jim@meyering.net> parents: 7165 diff changeset	223 'lib/gc-gnulib.c:md2.h' => 1,
502a0e8a8bfe * check-module (%exempt_header): Add exception for some Jim Meyering <jim@meyering.net> parents: 7165 diff changeset	224 'lib/gc-gnulib.c:md4.h' => 1,
502a0e8a8bfe * check-module (%exempt_header): Add exception for some Jim Meyering <jim@meyering.net> parents: 7165 diff changeset	225 'lib/gc-gnulib.c:md5.h' => 1,
502a0e8a8bfe * check-module (%exempt_header): Add exception for some Jim Meyering <jim@meyering.net> parents: 7165 diff changeset	226 'lib/gc-gnulib.c:rijndael.h' => 1,
502a0e8a8bfe * check-module (%exempt_header): Add exception for some Jim Meyering <jim@meyering.net> parents: 7165 diff changeset	227 'lib/gc-gnulib.c:sha1.h' => 1,
502a0e8a8bfe * check-module (%exempt_header): Add exception for some Jim Meyering <jim@meyering.net> parents: 7165 diff changeset	228 'lib/gc-gnulib.c:rijndael-api-fst.h' => 1,
502a0e8a8bfe * check-module (%exempt_header): Add exception for some Jim Meyering <jim@meyering.net> parents: 7165 diff changeset	229 'lib/gc-gnulib.c:hmac.h' => 1,
502a0e8a8bfe * check-module (%exempt_header): Add exception for some Jim Meyering <jim@meyering.net> parents: 7165 diff changeset	230 'lib/gc-libgcrypt.c:md2.h' => 1,
6157 915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	231 );
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	232
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	233 sub check_module ($)
5769 63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	234 {
6157 915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	235 my @m = @_;
5769 63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	236
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	237 my %file;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	238 my %module_all_files;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	239 my %dep;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	240 my %seen_module;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	241
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	242 while (@m)
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	243 {
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	244 my $m = pop @m;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	245 # warn "M: $m\n";
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	246 exists $seen_module{$m}
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	247 and next;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	248 $seen_module{$m} = 1;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	249 my ($file, $dep) = parse_module_file $m;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	250 push @m, keys %$dep;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	251 foreach my $f (keys %$file)
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	252 {
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	253 $module_all_files{$f} = 1;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	254 }
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	255 }
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	256
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	257 my @t = sort keys %module_all_files;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	258 # warn "ALL files: @t\n";
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	259
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	260 # Derive from %module_all_files (by parsing the .c and .h files therein),
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	261 # the list of all #include'd files that reside in lib/.
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	262 foreach my $f (keys %module_all_files)
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	263 {
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	264 $f =~ /\.[ch]$/
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	265 or next;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	266 # FIXME: this is too naive
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	267 my $inc = find_included_lib_files "../$f";
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	268 foreach my $i (sort keys %$inc)
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	269 {
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	270 my $lib_file = "lib/$i";
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	271 exists $exempt_header{"$f:$i"}
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	272 \|\| exists $exempt_header{$i}
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	273 and next;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	274 !exists $module_all_files{$lib_file} && -f "../lib/$i"
16234 f9b906545e2f Use ', not `, for quoting output. Paul Eggert <eggert@cs.ucla.edu> parents: 16201 diff changeset	275 and warn "$f: $i is '#include'd, but not "
5769 63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	276 . "listed in module's Files: section\n";
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	277 }
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	278 #my @t = sort keys %$inc;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	279 #print "** $f: @t\n";
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	280 }
6157 915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	281 }
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	282
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	283 {
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	284 GetOptions
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	285 (
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	286 help => sub { usage 0 },
7134 0ec466622052 * check-module: Add copyright notice. Paul Eggert <eggert@cs.ucla.edu> parents: 6168 diff changeset	287 version => sub { print "$ME version $VERSION\n$COPYRIGHT_NOTICE"; exit },
6157 915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	288 ) or usage 1;
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	289
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	290 @ARGV < 1
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	291 and (warn "$ME: missing FILE argument\n"), usage 1;
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	292
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	293 foreach my $module (@ARGV)
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	294 {
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	295 check_module $module;
915739deda90 If more parameters are given, check each of them Jim Meyering <jim@meyering.net> parents: 5944 diff changeset	296 }
5769 63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	297
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	298 exit 0;
63c824dd2830 rename from modules/check-include-files Jim Meyering <jim@meyering.net> parents: diff changeset	299 }

Mercurial > gnulib

annotate check-module @ 40196:e63f5d3edab5