This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta for e7d0a3fbd9 (tying PVMG COWs)
[perl5.git] / make_patchnum.pl
CommitLineData
29299e47 1#!/usr/bin/perl
f22725be 2# These two should go upon release to make the script Perl 5.005 compatible
29299e47
YO
3use strict;
4use warnings;
5
786aaa25 6=head1 NAME
8ed12dca 7
786aaa25 8make_patchnum.pl - make patchnum
8ed12dca 9
786aaa25 10=head1 SYNOPSIS
8ed12dca 11
6033099b
MM
12 miniperl make_patchnum.pl
13
14 perl make_patchnum.pl
15
3f1788e1 16=head1 DESCRIPTION
505afc73 17
6033099b
MM
18This program creates the files holding the information
19about locally applied patches to the source code. The created
d9217264 20files are F<git_version.h> and F<lib/Config_git.pl>.
505afc73 21
64da3008 22=head2 C<lib/Config_git.pl>
505afc73
YO
23
24Contains status information from git in a form meant to be processed
25by the tied hash logic of Config.pm. It is actually optional,
3f1788e1 26although -V:git.\* will be uninformative without it.
505afc73
YO
27
28C<git_version.h> contains similar information in a C header file
29format, designed to be used by patchlevel.h. This file is obtained
30from stock_git_version.h if miniperl is not available, and then
31later on replaced by the version created by this script.
32
33=head1 AUTHOR
6033099b 34
505afc73 35Yves Orton, Kenichi Ishigaki, Max Maischein
6033099b 36
505afc73 37=head1 COPYRIGHT
6033099b 38
505afc73 39Same terms as Perl itself.
8ed12dca 40
786aaa25
KI
41=cut
42
3f1788e1
JC
43# from a -Dmksymlink target dir, I need to cd to the git-src tree to
44# use git (like script does). Presuming that's not unique, one fix is
45# to follow Configure's symlink-path to run git. Maybe GIT_DIR or
46# path-args can solve it, if so we should advise here, I tried only
47# very briefly ('cd -' works too).
48
49my ($subcd, $srcdir);
50our $opt_v = scalar grep $_ eq '-v', @ARGV;
51
29299e47
YO
52BEGIN {
53 my $root=".";
3f1788e1
JC
54 # test 1st to see if we're a -Dmksymlinks target dir
55 $subcd = '';
56 $srcdir = $root;
57 if (-l "./Configure") {
58 $srcdir = readlink("./Configure");
59 $srcdir =~ s/Configure//;
60 $subcd = "cd $srcdir &&"; # activate backtick fragment
61 }
29299e47
YO
62 while (!-e "$root/perl.c" and length($root)<100) {
63 if ($root eq '.') {
91c3081c 64 $root="..";
505afc73 65 } else {
91c3081c
RGS
66 $root.="/..";
67 }
29299e47
YO
68 }
69 die "Can't find toplevel" if !-e "$root/perl.c";
70 sub path_to { "$root/$_[0]" } # use $_[0] if this'd be placed in toplevel.
71}
72
73sub read_file {
74 my $file = path_to(@_);
75 return "" unless -e $file;
76 open my $fh, '<', $file
91c3081c 77 or die "Failed to open for read '$file':$!";
29299e47
YO
78 return do { local $/; <$fh> };
79}
80
81sub write_file {
82 my ($file, $content) = @_;
83 $file= path_to($file);
84 open my $fh, '>', $file
91c3081c 85 or die "Failed to open for write '$file':$!";
29299e47
YO
86 print $fh $content;
87 close $fh;
88}
89
90sub backtick {
3f1788e1
JC
91 # only for git. If we're in a -Dmksymlinks build-dir, we need to
92 # cd to src so git will work . Probably a better way.
29299e47 93 my $command = shift;
eb5c076f 94 if (wantarray) {
3f1788e1 95 my @result= `$subcd $command`;
691ce773 96 #warn "$subcd $command: \$?=$?\n" if $?;
3f1788e1 97 print "#> $subcd $command ->\n @result\n" if !$? and $opt_v;
eb5c076f
YO
98 chomp @result;
99 return @result;
100 } else {
3f1788e1 101 my $result= `$subcd $command`;
eb5c076f 102 $result="" if ! defined $result;
3f1788e1
JC
103 warn "$subcd $command: \$?=$?\n" if $?;
104 print "#> $subcd $command ->\n $result\n" if !$? and $opt_v;
eb5c076f
YO
105 chomp $result;
106 return $result;
107 }
29299e47 108}
8ed12dca 109
eb5c076f
YO
110sub write_files {
111 my %content= map { /WARNING: '([^']+)'/ || die "Bad mojo!"; $1 => $_ } @_;
112 my @files= sort keys %content;
113 my $files= join " and ", map { "'$_'" } @files;
505afc73 114 foreach my $file (@files) {
eb5c076f
YO
115 if (read_file($file) ne $content{$file}) {
116 print "Updating $files\n";
117 write_file($_,$content{$_}) for @files;
118 return 1;
505afc73 119 }
eb5c076f
YO
120 }
121 print "Reusing $files\n";
122 return 0;
123}
8ed12dca 124
691ce773 125my $unpushed_commits = ' ';
eb5c076f 126my ($read, $branch, $snapshot_created, $commit_id, $describe)= ("") x 5;
691ce773 127my ($changed, $extra_info, $commit_title)= ("") x 3;
3f1788e1 128
eb5c076f
YO
129if (my $patch_file= read_file(".patch")) {
130 ($branch, $snapshot_created, $commit_id, $describe) = split /\s+/, $patch_file;
786aaa25
KI
131 $extra_info = "git_snapshot_date='$snapshot_created'";
132 $commit_title = "Snapshot of:";
133}
3f1788e1 134elsif (-d "$srcdir/.git") {
786aaa25 135 # git branch | awk 'BEGIN{ORS=""} /\*/ { print $2 }'
9077509c 136 ($branch) = map { /\* ([^(]\S*)/ ? $1 : "" } backtick("git branch");
eb5c076f 137 my ($remote,$merge);
786aaa25 138 if (length $branch) {
505afc73 139 $merge= backtick("git config branch.$branch.merge");
326df896 140 $merge = "" unless $? == 0;
eb5c076f
YO
141 $merge =~ s!^refs/heads/!!;
142 $remote= backtick("git config branch.$branch.remote");
326df896 143 $remote = "" unless $? == 0;
786aaa25
KI
144 }
145 $commit_id = backtick("git rev-parse HEAD");
b6194a9d 146 $describe = backtick("git describe");
786aaa25 147 my $commit_created = backtick(qq{git log -1 --pretty="format:%ci"});
786aaa25 148 $extra_info = "git_commit_date='$commit_created'";
691ce773
GA
149 backtick("git diff --no-ext-diff --quiet --exit-code");
150 $changed = $?;
151 unless ($changed) {
152 backtick("git diff-index --cached --quiet HEAD --");
153 $changed = $?;
154 }
155
786aaa25
KI
156 if (length $branch && length $remote) {
157 # git cherry $remote/$branch | awk 'BEGIN{ORS=","} /\+/ {print $2}' | sed -e 's/,$//'
158 my $unpushed_commit_list =
159 join ",", map { (split /\s/, $_)[1] }
eb5c076f 160 grep {/\+/} backtick("git cherry $remote/$merge");
786aaa25 161 # git cherry $remote/$branch | awk 'BEGIN{ORS="\t\\\\\n"} /\+/ {print ",\"" $2 "\""}'
29299e47 162 $unpushed_commits =
eb5c076f
YO
163 join "", map { ',"'.(split /\s/, $_)[1]."\"\t\\\n" }
164 grep {/\+/} backtick("git cherry $remote/$merge");
786aaa25
KI
165 if (length $unpushed_commits) {
166 $commit_title = "Local Commit:";
eb5c076f 167 my $ancestor = backtick("git rev-parse $remote/$merge");
786aaa25
KI
168 $extra_info = "$extra_info
169git_ancestor='$ancestor'
eb5c076f 170git_remote_branch='$remote/$merge'
786aaa25
KI
171git_unpushed='$unpushed_commit_list'";
172 }
173 }
691ce773 174 if ($changed) {
786aaa25 175 $commit_title = "Derived from:";
786aaa25 176 }
eb5c076f 177 $commit_title ||= "Commit id:";
786aaa25
KI
178}
179
eb5c076f 180# we extract the filename out of the warning header, so dont mess with that
16ad9bfa 181write_files(<<"EOF_HEADER", <<"EOF_CONFIG");
eb5c076f
YO
182/**************************************************************************
183* WARNING: 'git_version.h' is automatically generated by make_patchnum.pl
184* DO NOT EDIT DIRECTLY - edit make_patchnum.pl instead
185***************************************************************************/
691ce773 186@{[$describe ? "#define PERL_PATCHNUM \"$describe\"" : ()]}
eb5c076f
YO
187#define PERL_GIT_UNPUSHED_COMMITS\t\t\\
188$unpushed_commits/*leave-this-comment*/
691ce773 189@{[$changed ? "#define PERL_GIT_UNCOMMITTED_CHANGES" : ()]}
eb5c076f
YO
190EOF_HEADER
191######################################################################
192# WARNING: 'lib/Config_git.pl' is generated by make_patchnum.pl
193# DO NOT EDIT DIRECTLY - edit make_patchnum.pl instead
194######################################################################
8ed12dca
YO
195\$Config::Git_Data=<<'ENDOFGIT';
196git_commit_id='$commit_id'
197git_describe='$describe'
198git_branch='$branch'
199git_uncommitted_changes='$changed'
200git_commit_id_title='$commit_title'
201$extra_info
202ENDOFGIT
eb5c076f 203EOF_CONFIG
91c3081c 204# ex: set ts=8 sts=4 sw=4 et ft=perl: