This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
typo fixes for root level scripts
[perl5.git] / make_patchnum.pl
index e93015f..3f857b5 100644 (file)
@@ -13,29 +13,58 @@ make_patchnum.pl - make patchnum
 
   perl make_patchnum.pl
 
+=head1 DESCRIPTION
+
 This program creates the files holding the information
 about locally applied patches to the source code. The created
-files are C<.patchnum>, C<unpushed.h> and C<lib/Config_git.pl>.
+files are  F<git_version.h> and F<lib/Config_git.pl>.
+
+=head2 F<lib/Config_git.pl>
+
+Contains status information from git in a form meant to be processed
+by the tied hash logic of Config.pm. It is actually optional,
+although -V:git.\* will be uninformative without it.
+
+C<git_version.h> contains similar information in a C header file
+format, designed to be used by patchlevel.h. This file is obtained
+from stock_git_version.h if miniperl is not available, and then
+later on replaced by the version created by this script.
+
+=head1 AUTHOR
 
-C<.patchnum> contains ???
+Yves Orton, Kenichi Ishigaki, Max Maischein
 
-C<lib/Config_git.pl> contains the configuration of git for
-this branch.
+=head1 COPYRIGHT
 
-C<unpushed.h> contains the local changes that haven't been
-synchronized with the remote repository as configured with
-C<< git configure branch.<current branch>.remote >>
+Same terms as Perl itself.
 
 =cut
 
+# from a -Dmksymlink target dir, I need to cd to the git-src tree to
+# use git (like script does).  Presuming that's not unique, one fix is
+# to follow Configure's symlink-path to run git.  Maybe GIT_DIR or
+# path-args can solve it, if so we should advise here, I tried only
+# very briefly ('cd -' works too).
+
+my ($subcd, $srcdir);
+our $opt_v = scalar grep $_ eq '-v', @ARGV;
+
 BEGIN {
     my $root=".";
+    # test 1st to see if we're a -Dmksymlinks target dir
+    $subcd = '';
+    $srcdir = $root;
+    if (-l "./Configure") {
+       $srcdir = readlink("./Configure");
+       $srcdir =~ s/Configure//;
+       $subcd = "cd $srcdir &&"; # activate backtick fragment
+    }
     while (!-e "$root/perl.c" and length($root)<100) {
         if ($root eq '.') {
-               $root="..";
-       } else {
-               $root.="/..";
-           }
+            $root="..";
+        } else {
+            $root.="/..";
+        }
     }
     die "Can't find toplevel" if !-e "$root/perl.c";
     sub path_to { "$root/$_[0]" } # use $_[0] if this'd be placed in toplevel.
@@ -45,7 +74,7 @@ sub read_file {
     my $file = path_to(@_);
     return "" unless -e $file;
     open my $fh, '<', $file
-       or die "Failed to open for read '$file':$!";
+        or die "Failed to open for read '$file':$!";
     return do { local $/; <$fh> };
 }
 
@@ -53,85 +82,117 @@ sub write_file {
     my ($file, $content) = @_;
     $file= path_to($file);
     open my $fh, '>', $file
-       or die "Failed to open for write '$file':$!";
+        or die "Failed to open for write '$file':$!";
     print $fh $content;
     close $fh;
 }
 
 sub backtick {
+    # only for git.  If we're in a -Dmksymlinks build-dir, we need to
+    # cd to src so git will work .  Probably a better way.
     my $command = shift;
-    my $result = `$command`;
-    chomp $result;
-    return $result;
+    if (wantarray) {
+        my @result= `$subcd $command`;
+        #warn "$subcd $command: \$?=$?\n" if $?;
+        print "#> $subcd $command ->\n @result\n" if !$? and $opt_v;
+        chomp @result;
+        return @result;
+    } else {
+        my $result= `$subcd $command`;
+        $result="" if ! defined $result;
+        warn "$subcd $command: \$?=$?\n" if $?;
+        print "#> $subcd $command ->\n $result\n" if !$? and $opt_v;
+        chomp $result;
+        return $result;
+    }
 }
 
-my $existing_patchnum = read_file('.patchnum');
-my $existing_config   = read_file('lib/Config_git.pl');
-my $existing_unpushed = read_file('unpushed.h');
+sub write_files {
+    my %content= map { /WARNING: '([^']+)'/ || die "Bad mojo!"; $1 => $_ } @_;
+    my @files= sort keys %content;
+    my $files= join " and ", map { "'$_'" } @files;
+    foreach my $file (@files) {
+        if (read_file($file) ne $content{$file}) {
+            print "Updating $files\n";
+            write_file($_,$content{$_}) for @files;
+            return 1;
+        }
+    }
+    print "Reusing $files\n";
+    return 0;
+}
 
-my $unpushed_commits = '/*no-op*/';
-my ($read, $branch, $snapshot_created, $commit_id, $describe);
-my ($changed, $extra_info, $commit_title, $new_patchnum);
-if (my $patch_file= read_file('.patch')) {
-    ($branch, $snapshot_created, $commit_id, $describe) = split /\s+/, $patchfile;
+my $unpushed_commits = '    ';
+my ($read, $branch, $snapshot_created, $commit_id, $describe)= ("") x 5;
+my ($changed, $extra_info, $commit_title)= ("") x 3;
+
+if (my $patch_file= read_file(".patch")) {
+    ($branch, $snapshot_created, $commit_id, $describe) = split /\s+/, $patch_file;
     $extra_info = "git_snapshot_date='$snapshot_created'";
     $commit_title = "Snapshot of:";
 }
-elsif (-d path_to('.git')) {
+elsif (-d "$srcdir/.git") {
     # git branch | awk 'BEGIN{ORS=""} /\*/ { print $2 }'
-    $branch = join "", map { (split /\s/, $_)[1] }
-              grep {/\*/} split /\n/, backtick('git branch');
-    my $remote;
+    ($branch) = map { /\* ([^(]\S*)/ ? $1 : () } backtick("git branch");
+    $branch //= "";
+    my ($remote,$merge);
     if (length $branch) {
-        $remote = backtick("git config branch.$branch.remote");
+        $merge= backtick("git config branch.$branch.merge");
+        $merge = "" unless $? == 0;
+        $merge =~ s!^refs/heads/!!;
+        $remote= backtick("git config branch.$branch.remote");
+        $remote = "" unless $? == 0;
     }
     $commit_id = backtick("git rev-parse HEAD");
     $describe = backtick("git describe");
     my $commit_created = backtick(qq{git log -1 --pretty="format:%ci"});
-    $new_patchnum = "describe: $describe";
     $extra_info = "git_commit_date='$commit_created'";
+    backtick("git diff --no-ext-diff --quiet --exit-code");
+    $changed = $?;
+    unless ($changed) {
+        backtick("git diff-index --cached --quiet HEAD --");
+        $changed = $?;
+    }
+
     if (length $branch && length $remote) {
         # git cherry $remote/$branch | awk 'BEGIN{ORS=","} /\+/ {print $2}' | sed -e 's/,$//'
         my $unpushed_commit_list =
             join ",", map { (split /\s/, $_)[1] }
-            grep {/\+/} split /\n/, backtick("git cherry $remote/$branch");
+            grep {/\+/} backtick("git cherry $remote/$merge");
         # git cherry $remote/$branch | awk 'BEGIN{ORS="\t\\\\\n"} /\+/ {print ",\"" $2 "\""}'
         $unpushed_commits =
-            join "", map { ',"'.(split /\s/, $_)[1].'"'."\t\\\n" }
-            grep {/\+/} split /\n/, backtick("git cherry $remote/$branch");
+            join "", map { ',"'.(split /\s/, $_)[1]."\"\t\\\n" }
+            grep {/\+/} backtick("git cherry $remote/$merge");
         if (length $unpushed_commits) {
             $commit_title = "Local Commit:";
-            my $ancestor = backtick("git rev-parse $remote/$branch");
+            my $ancestor = backtick("git rev-parse $remote/$merge");
             $extra_info = "$extra_info
 git_ancestor='$ancestor'
+git_remote_branch='$remote/$merge'
 git_unpushed='$unpushed_commit_list'";
         }
     }
-    if (length $changed) {
-        $changed = 'true';
+    if ($changed) {
         $commit_title =  "Derived from:";
-        $new_patchnum = "$new_patchnum
-status: uncommitted-changes";
-    }
-    if (not length $commit_title) {
-        $commit_title = "Commit id:";
     }
+    $commit_title ||= "Commit id:";
 }
 
-my $new_unpushed =<<"EOFTEXT";
-/*********************************************************************
-* WARNING: unpushed.h is automatically generated by make_patchnum.pl *
-*          DO NOT EDIT DIRECTLY - edit make_patchnum.pl instead      *
-*********************************************************************/
-#define PERL_GIT_UNPUSHED_COMMITS       $unpushed_commits
-/*leave-this-comment*/
-EOFTEXT
-
-my $new_config =<<"EOFDATA";
-#################################################################
-# WARNING: lib/Config_git.pl is generated by make_patchnum.pl   #
-#          DO NOT EDIT DIRECTLY - edit make_patchnum.pl instead #
-#################################################################
+# we extract the filename out of the warning header, so don't mess with that
+write_files(<<"EOF_HEADER", <<"EOF_CONFIG");
+/**************************************************************************
+* WARNING: 'git_version.h' is automatically generated by make_patchnum.pl
+*          DO NOT EDIT DIRECTLY - edit make_patchnum.pl instead
+***************************************************************************/
+@{[$describe ? "#define PERL_PATCHNUM \"$describe\"" : ()]}
+#define PERL_GIT_UNPUSHED_COMMITS\t\t\\
+$unpushed_commits/*leave-this-comment*/
+@{[$changed ? "#define PERL_GIT_UNCOMMITTED_CHANGES" : ()]}
+EOF_HEADER
+######################################################################
+# WARNING: 'lib/Config_git.pl' is generated by make_patchnum.pl
+#          DO NOT EDIT DIRECTLY - edit make_patchnum.pl instead
+######################################################################
 \$Config::Git_Data=<<'ENDOFGIT';
 git_commit_id='$commit_id'
 git_describe='$describe'
@@ -140,17 +201,5 @@ git_uncommitted_changes='$changed'
 git_commit_id_title='$commit_title'
 $extra_info
 ENDOFGIT
-EOFDATA
-
-# only update the files if necessary, other build product depends on these files
-if (( $existing_patchnum ne $new_patchnum ) || ( $existing_config ne $new_config ) || ( $existing_unpushed ne $new_unpushed )) {
-    print "Updating .patchnum and lib/Config_git.pl\n";
-    write_file('.patchnum', $new_patchnum);
-    write_file('lib/Config_git.pl', $new_config);
-    write_file('unpushed.h', $new_unpushed);
-}
-else {
-    print "Reusing .patchnum and lib/Config_git.pl\n"
-}
-
-# ex: set ts=4 sts=4 et ft=perl:
+EOF_CONFIG
+# ex: set ts=8 sts=4 sw=4 et ft=perl: