This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Re: [PATCH] Make adding notes to patchlevel.h easier
[perl5.git] / patchlevel.h
1 /*    patchlevel.h
2  *
3  *    Copyright (c) 1997-2003, Larry Wall
4  *
5  *    You may distribute under the terms of either the GNU General Public
6  *    License or the Artistic License, as specified in the README file.
7  *
8  */
9
10 #ifndef __PATCHLEVEL_H_INCLUDED__
11
12 /* do not adjust the whitespace! Configure expects the numbers to be
13  * exactly on the third column */
14
15 #define PERL_REVISION   5               /* age */
16 #define PERL_VERSION    9               /* epoch */
17 #define PERL_SUBVERSION 0               /* generation */
18
19 /* The following numbers describe the earliest compatible version of
20    Perl ("compatibility" here being defined as sufficient binary/API
21    compatibility to run XS code built with the older version).
22    Normally this should not change across maintenance releases.
23
24    Note that this only refers to an out-of-the-box build.  Many non-default
25    options such as usemultiplicity tend to break binary compatibility
26    more often.
27
28    This is used by Configure et al to figure out 
29    PERL_INC_VERSION_LIST, which lists version libraries
30    to include in @INC.  See INSTALL for how this works.
31 */
32 #define PERL_API_REVISION       5       /* Adjust manually as needed.  */
33 #define PERL_API_VERSION        8       /* Adjust manually as needed.  */
34 #define PERL_API_SUBVERSION     0       /* Adjust manually as needed.  */
35 /*
36    XXX Note:  The selection of non-default Configure options, such
37    as -Duselonglong may invalidate these settings.  Currently, Configure
38    does not adequately test for this.   A.D.  Jan 13, 2000
39 */
40
41 #define __PATCHLEVEL_H_INCLUDED__
42 #endif
43
44 /*
45         local_patches -- list of locally applied less-than-subversion patches.
46         If you're distributing such a patch, please give it a name and a
47         one-line description, placed just before the last NULL in the array
48         below.  If your patch fixes a bug in the perlbug database, please
49         mention the bugid.  If your patch *IS* dependent on a prior patch,
50         please place your applied patch line after its dependencies. This
51         will help tracking of patch dependencies.
52
53         Please either use 'diff -u --context=0' if your diff supports
54         that or edit the hunk of the diff output which adds your patch
55         to this list, to remove context lines which would give patch
56         problems. For instance, if the original context diff is
57
58            *** patchlevel.h.orig        <date here>
59            --- patchlevel.h     <date here>
60            *** 38,43 ***
61            --- 38,44 ---
62                 ,"FOO1235 - some patch"
63                 ,"BAR3141 - another patch"
64                 ,"BAZ2718 - and another patch"
65            +    ,"MINE001 - my new patch"
66                 ,NULL
67              };
68         
69         please change it to 
70            *** patchlevel.h.orig        <date here>
71            --- patchlevel.h     <date here>
72            *** 41,43 ***
73            --- 41,44 ---
74            +    ,"MINE001 - my new patch"
75              };
76         
77         (Note changes to line numbers as well as removal of context lines.)
78         This will prevent patch from choking if someone has previously
79         applied different patches than you.
80
81         History has shown that nobody distributes patches that also
82         modify patchlevel.h. Do it yourself. The following perl
83         program can be used to add a comment to patchlevel.h:
84
85 #!perl
86 die "Usage: perl -x patchlevel.h comment ..." unless @ARGV;
87 open PLIN, "patchlevel.h" or die "Couldn't open patchlevel.h : $!";
88 open PLOUT, ">patchlevel.new" or die "Couldn't write on patchlevel.new : $!";
89 my $seen=0;
90 while (<PLIN>) {
91     if (/\t,NULL/ and $seen) {
92        while (my $c = shift @ARGV){
93             print PLOUT qq{\t,"$c"\n};
94        }
95     }
96     $seen++ if /local_patches\[\]/;
97     print PLOUT;
98 }
99 close PLOUT or die "Couldn't close filehandle writing to patchlevel.new : $!";
100 close PLIN or die "Couldn't close filehandle reading from patchlevel.h : $!";
101 unlink "patchlevel.bak" or warn "Couldn't unlink patchlevel.bak : $!"
102   if -e "patchlevel.bak";
103 rename "patchlevel.h", "patchlevel.bak" or
104   die "Couldn't rename patchlevel.h to patchlevel.bak : $!";
105 rename "patchlevel.new", "patchlevel.h" or
106   die "Couldn't rename patchlevel.new to patchlevel.h : $!";
107 __END__
108
109 Please keep empty lines below so that context diffs of this file do
110 not ever collect the lines belonging to local_patches() into the same
111 hunk.
112
113  */
114
115
116
117
118 #if !defined(PERL_PATCHLEVEL_H_IMPLICIT) && !defined(LOCAL_PATCH_COUNT)
119 static  char    *local_patches[] = {
120         NULL
121         ,"DEVEL18374"
122         ,NULL
123 };
124
125
126
127 /* Initial space prevents this variable from being inserted in config.sh  */
128 #  define       LOCAL_PATCH_COUNT       \
129         (sizeof(local_patches)/sizeof(local_patches[0])-2)
130
131 /* the old terms of reference, add them only when explicitly included */
132 #define PATCHLEVEL              PERL_VERSION
133 #undef  SUBVERSION              /* OS/390 has a SUBVERSION in a system header */
134 #define SUBVERSION              PERL_SUBVERSION
135 #endif