GNU logs - #38334, boring messages

Message sent to bug-vc-dwim@HIDDEN:

Subject: bug#38334: adding --dry-run option to vc-dwim [patch]
Resent-From: Karl Berry <karl@HIDDEN>
Original-Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
Resent-CC: bug-vc-dwim@HIDDEN
Resent-Date: Fri, 22 Nov 2019 22:52:05 +0000
Resent-Message-ID: <handler.38334.B.157446310425724 <at> debbugs.gnu.org>
Resent-Sender: help-debbugs@HIDDEN
To: 38334 <at> debbugs.gnu.org
Date: Fri, 22 Nov 2019 15:51:17 -0700
Message-Id: <201911222251.xAMMpH9u004483@HIDDEN>
From: Karl Berry <karl@HIDDEN>
Precedence: list
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>

Possible NEWS entry, under "New features":

  vc-dwim accepts a new option: --dry-run (-n)

Several of the changes are just replacing
  <code>
with
  if ($dry_run) {
    print "msg";
 } else {
   <code>
 }
hence they look longer than they actually are.

2019-11-14  Karl Berry  <karl@HIDDEN>

	vc-dwim: New option vc-dwim --dry-run (aka -n).

	* vc-dwim.pl ($dry_run): new variable.
	(GetOptions): set it.
	(run_command): conditionalize system call and INHIBIT_STDOUT.
	(main): conditionalize initialize operations, rename, symlink.
	* doc/vc-dwim.texi (vc-dwim Invocation): document it.

--- doc/vc-dwim.texi	2019-11-13 17:36:14.920575492 -0800
+++ n.texi	2019-11-17 18:23:06.972699737 -0800
@@ -252,4 +252,8 @@
 Perform the commit, too.
 
+@item -n
+@itemx --dry-run
+Print the commands that would be run instead of running them.
+
 @item --diff
 Determine which version control system manages the first
--- vc-dwim.pl	2019-11-17 18:43:44.673256552 -0800
+++ n.pl	2019-11-21 18:14:13.250781876 -0800
@@ -61,4 +61,5 @@
 my $verbose = 0;
 my $debug = 0;
+my $dry_run = 0;
 
 sub usage ($)
@@ -248,5 +249,5 @@
      DIE_UPON_FAILURE => 1,
      INHIBIT_STDERR => 0,
-     INHIBIT_STDOUT => 1,
+     INHIBIT_STDOUT => ! $dry_run, # keep stdout if just printing
     );
 
@@ -292,5 +293,11 @@
 
   my $fail = 1;
-  my $rc = 0xffff & system @cmd;
+  my $rc;
+  if ($dry_run) {
+    print "$ME: would run: @cmd\n";
+    $rc = 0;
+  } else {
+    $rc = 0xffff & system @cmd;
+  }
 
   # Restore stdout.
@@ -734,4 +741,6 @@
      'print-vc-list' =>
        sub { print join (' ', VC::supported_vc_names()), "\n"; exit },
+     n => \$dry_run,
+     'dry-run' => \$dry_run,
      debug => \$debug,
      verbose => \$verbose,
@@ -757,13 +766,21 @@
       do_at ($adm, sub
       {
-        ! (mkdir ('c') || $! == EEXIST)
-          and die "$ME: failed to create $adm/c: $!\n";
-        chdir 'c' or die "$ME: failed to chdir to $adm/c: $!\n";
+        if ($dry_run) {
+          print "$ME: would mkdir 'c' in $adm\n";
+        } else {
+          ! (mkdir ('c') || $! == EEXIST)
+            and die "$ME: failed to create $adm/c: $!\n";
+          chdir 'c' or die "$ME: failed to chdir to $adm/c: $!\n";
+        }
 
         # touch ChangeLog || die
-        open FH, '>>', $cl
-          or die "$ME: failed to open '$cl' for writing: $!\n";
-        close FH
-          or die "$ME: failed to write '$cl': $!\n";
+        if ($dry_run) {
+          print "$ME: would touch $cl in $adm\n";
+        } else {
+          open FH, '>>', $cl
+            or die "$ME: failed to open '$cl' for writing: $!\n";
+          close FH
+            or die "$ME: failed to write '$cl': $!\n";
+        }
 
         # Initialize the git repo, add ChangeLog and commit it.
@@ -775,11 +792,21 @@
 
       # If a ChangeLog file exists in the current directory, rename it
-      # to ChangeLog~, deliberately ignoring any rename failure.
-      rename $cl, "$cl~";
+      # deliberately ignoring any rename failure. (But only report the
+      # rename for dry runs if it does exist.)
+      my $cl_top = "../../$cl";
+      if ($dry_run && -e $cl_top) {
+        print "$ME: would rename($cl_top, $cl_top~)\n";
+      } else {
+        rename $cl_top, "$cl_top~";
+      }
 
       # Create the top-level ChangeLog symlink into $adm/c:
       my $cl_sub = "$adm/c/$cl";
-      symlink $cl_sub, $cl
-        or die "$ME: failed to create symlink, $cl, to $cl_sub: $!\n";
+      if ($dry_run) {
+        print "$ME: would symlink($cl_sub, $cl_top)\n";
+      } else {
+        symlink $cl_sub, $cl_top
+          or die "$ME: failed to create symlink, $cl, to $cl_sub: $!\n";
+      }
 
       exit 0;
@@ -799,5 +826,10 @@
         and verbose_cmd \@cmd;
 
-      exec @cmd;
+      if ($dry_run) {
+        print "$ME: would run: @cmd\n";
+        exit 0;
+      } else {
+        exec @cmd;
+      }
       exit 1;
     }

Message sent:

Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
X-Mailer: MIME-tools 5.505 (Entity 5.505)
Content-Type: text/plain; charset=utf-8
X-Loop: help-debbugs@HIDDEN
From: help-debbugs@HIDDEN (GNU bug Tracking System)
To: Karl Berry <karl@HIDDEN>
Subject: bug#38334: Acknowledgement (adding --dry-run option to vc-dwim
 [patch])
Message-ID: <handler.38334.B.157446310425724.ack <at> debbugs.gnu.org>
References: <201911222251.xAMMpH9u004483@HIDDEN>
X-Gnu-PR-Message: ack 38334
X-Gnu-PR-Package: vc-dwim
X-Gnu-PR-Keywords: patch
Reply-To: 38334 <at> debbugs.gnu.org
Date: Fri, 22 Nov 2019 22:52:05 +0000

Thank you for filing a new bug report with debbugs.gnu.org.

This is an automatically generated reply to let you know your message
has been received.

Your message is being forwarded to the package maintainers and other
interested parties for their attention; they will reply in due course.

Your message has been sent to the package maintainer(s):
 bug-vc-dwim@HIDDEN

If you wish to submit further information on this problem, please
send it to 38334 <at> debbugs.gnu.org.

Please do not send mail to help-debbugs@HIDDEN unless you wish
to report a problem with the Bug-tracking system.

--=20
38334: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=3D38334
GNU Bug Tracking System
Contact help-debbugs@HIDDEN with problems

Last modified: Mon, 25 Nov 2019 12:00:02 UTC

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997 nCipher Corporation Ltd, 1994-97 Ian Jackson.