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 7eb6515..3f857b5 100644 (file)
-#!/bin/sh
-
-# this script is used to regenerate a number of special build files
-# based on either information contained in a file called .patch or
-# directly from git.
-# The files involved are:
-#   .patchnum         # information about the current checkout
-#   lib/Config_git.pl # holds some special configure settings related to git
-#   unpushed.h        # header file used by patchlevel.h to store unpushed commits
-
-existing_patchnum=$(cat .patchnum 2>/dev/null)
-existing_config=$(cat lib/Config_git.pl 2>/dev/null)
-existing_unpushed=$(cat unpushed.h 2>/dev/null)
-
-unpushed_commits='/*no-op*/'
-if [ -s ".patch" ] ; then
-       # this is the minimal expectation for the 
-       read branch snapshot_created commit_id describe < .patch
-       changed=""
-       extra_info="git_snapshot_date='$snapshot_created'"
-       commit_title='Snapshot of:'
-elif [ -d ".git" ]; then
-       branch=$(git branch | awk 'BEGIN{ORS=""} /\*/ { print $2 }')
-       test -n "$branch" && remote=$(git config branch.$branch.remote)
-       commit_id=$(git rev-parse HEAD)
-       changed=$(git diff-index --name-only HEAD)
-       describe=$(git describe --tags)
-       commit_created=$(git log -1 --pretty='format:%ci')
-       extra_info="git_commit_date='$commit_created'"
-       if [ -n "$branch" ] && [ -n "$remote" ]; then
-               unpushed_commit_list=$(git cherry $remote/$branch | awk 'BEGIN{ORS=","} /+/ {print $2}' | sed -e 's/,$//')
-               unpushed_commits=$(git cherry $remote/$branch | awk 'BEGIN{ORS="\t\\\n"} /+/ {print ",\"" $2 "\""}')
-
-               if [ -n "$unpushed_commits" ]; then
-                       commit_title="Local Commit:"
-                       ancestor=`git rev-parse $remote/$branch`
-                       extra_info="$extra_info
+#!/usr/bin/perl
+# These two should go upon release to make the script Perl 5.005 compatible
+use strict;
+use warnings;
+
+=head1 NAME
+
+make_patchnum.pl - make patchnum
+
+=head1 SYNOPSIS
+
+  miniperl make_patchnum.pl
+
+  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  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
+
+Yves Orton, Kenichi Ishigaki, Max Maischein
+
+=head1 COPYRIGHT
+
+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.="/..";
+        }
+    }
+    die "Can't find toplevel" if !-e "$root/perl.c";
+    sub path_to { "$root/$_[0]" } # use $_[0] if this'd be placed in toplevel.
+}
+
+sub read_file {
+    my $file = path_to(@_);
+    return "" unless -e $file;
+    open my $fh, '<', $file
+        or die "Failed to open for read '$file':$!";
+    return do { local $/; <$fh> };
+}
+
+sub write_file {
+    my ($file, $content) = @_;
+    $file= path_to($file);
+    open my $fh, '>', $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;
+    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;
+    }
+}
+
+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 = '    ';
+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 "$srcdir/.git") {
+    # git branch | awk 'BEGIN{ORS=""} /\*/ { print $2 }'
+    ($branch) = map { /\* ([^(]\S*)/ ? $1 : () } backtick("git branch");
+    $branch //= "";
+    my ($remote,$merge);
+    if (length $branch) {
+        $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"});
+    $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 {/\+/} 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 {/\+/} backtick("git cherry $remote/$merge");
+        if (length $unpushed_commits) {
+            $commit_title = "Local Commit:";
+            my $ancestor = backtick("git rev-parse $remote/$merge");
+            $extra_info = "$extra_info
 git_ancestor='$ancestor'
-git_unpushed='$unpushed_commit_list'"
-               fi
-                       
-       fi
-else
-       cat <<SNDOGS
-Something is wrong with your source tree. You should 
-either have a .git directory and a functional git toolset
-OR should have a .patch file in the source tree. Please
-report the particulars of this situation to 
-perl5-porters@perl.org.
-SNDOGS
-       exit 2
-fi
-
-# Set up defaults for various values
-new_patchnum="describe: $describe"
-if [ -n "$changed" ]; then
-       changed="true"
-       commit_title="Derived from:"
-       new_patchnum="$new_patchnum
-status: uncommitted-changes"
-fi
-test -z "$commit_title" && commit_title='Commit id:'
-
-new_unpushed=$(cat <<EOFTEXT
-/*********************************************************************
-* WARNING: unpushed.h is automatically generated by make_patchnum.sh *
-*          DO NOT EDIT DIRECTLY - edit make_patchnum.sh instead      *
-*********************************************************************/
-#define PERL_GIT_UNPUSHED_COMMITS       $unpushed_commits
-/*leave-this-comment*/
-EOFTEXT
-)
-new_config=$(cat <<EOFDATA
-#################################################################
-# WARNING: lib/Config_git.pl is generated by make_patchnum.sh   #
-#          DO NOT EDIT DIRECTLY - edit make_patchnum.sh instead #
-#################################################################
+git_remote_branch='$remote/$merge'
+git_unpushed='$unpushed_commit_list'";
+        }
+    }
+    if ($changed) {
+        $commit_title =  "Derived from:";
+    }
+    $commit_title ||= "Commit id:";
+}
+
+# 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'
@@ -83,15 +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" != "$new_patchnum" ] || [ "$new_config" != "$existing_config" ] || [ "$existing_unpushed" != "$new_unpushed" ]; then
-       echo "Updating .patchnum and lib/Config_git.pl"
-       echo "$new_patchnum" > .patchnum
-       echo "$new_config" > lib/Config_git.pl
-       echo "$new_unpushed" > unpushed.h
-else
-       echo "Reusing .patchnum and lib/Config_git.pl"
-fi
-
+EOF_CONFIG
+# ex: set ts=8 sts=4 sw=4 et ft=perl: