doc/todo/Add_instructive_commit_messages_for_add__47__edit_pages.mdwn

   1 When I added or edited a page, no commit message was written out (Mercurial backend, though I guess it shouldn't matter). This was done for e.g. the `rename` plugin. I made a naive but seemingly working change to `editpage.pm` to add a message.
   2
   3 I modeled the message on `rename.pm`, which used a lowercase initial letter and imperative form of the verb. This is not the case for e.g. the `comment` plugin, which says "Added a comment: ", so I guess there is no strict rule on style in this case.
   4
   5 Diff follows. --[[Daniel Andersson]]
   6
   7 > This is somewhat intentional. It's pretty usual for changes to be made
   8 > to a wiki without bothering to say what changed; the change speaks for
   9 > itself and it would just be clutter to mention what file was changed,
  10 > since any reasonable interface will show the filename, or a link,
  11 > or some summary of what files were affected when showing a change.
  12 >
  13 > Also your patch stomps over any commit message that the user *does*
  14 > provide, so certianly cannot be applied as-is. --[[Joey]]
  15
  16 [[!tag patch]]
  17
  18 ---
  19
  20         diff -r ee177ca9bf36 Plugin/editpage.pm
  21         --- a/Plugin/editpage.pm        Fri Jul 15 17:58:04 2011 +0200
  22         +++ b/Plugin/editpage.pm        Sat Jul 16 03:01:13 2011 +0200
  23         @@ -405,6 +405,10 @@
  24                         if ($config{rcs}) {
  25                                 if (! $exists) {
  26                                         rcs_add($file);
  27         +                               $message = "add $file";
  28         +                       }
  29         +                       else {
  30         +                               $message = "edit $file";
  31                                 }
  32
  33                                 # Prevent deadlock with post-commit hook by