[Bug-vc-dwim] [PATCH] doc: you can use vc-dwim when ChangeLog is not version-controlled

[Jim Meyering]

FYI, just pushed:

>From 5ce36406c66b69126e5043dfc36d982c95cbd017 Mon Sep 17 00:00:00 2001
From: Jim Meyering <address@hidden>
Date: Tue, 1 Sep 2009 09:22:09 +0200
Subject: [PATCH] doc: you can use vc-dwim when ChangeLog is not 
version-controlled

* vc-dwim.pl (--help): Give an example describing how to use vc-dwim
in a project that does not maintain a version-controlled ChangeLog file.
---
 ChangeLog  |    6 ++++++
 vc-dwim.pl |   21 +++++++++++++++++++++
 2 files changed, 27 insertions(+), 0 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 9cdb910..f03e656 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2009-09-01  Jim Meyering  <address@hidden>
+
+       doc: you can use vc-dwim when ChangeLog is not version-controlled
+       * vc-dwim.pl (--help): Give an example describing how to use vc-dwim
+       in a project that does not maintain a version-controlled ChangeLog file.
+
 2009-08-11  Jim Meyering  <address@hidden>

        vc-dwim: fix SCALAR(0x...) log pollution
diff --git a/vc-dwim.pl b/vc-dwim.pl
index 9803659..08078a3 100755
--- a/vc-dwim.pl
+++ b/vc-dwim.pl
@@ -1163,6 +1163,27 @@ Generate debug output.

 =back

+=head1  EXAMPLE
+
+Here's how to use B<@@ME@@> in a project that does not version-control
+a ChangeLog file.  Create a repository just for your personal
+ChangeLog file and make a symlink to it from the top-level directory
+of the project.  For projects that use git, I put this tiny
+auxiliary repository in a directory named .git/c.  You can
+use this bash/zsh alias to set it up and to create the symlink:
+
+    git-changelog-symlink-init()
+    {
+        local d=.git/c
+        test -d .git || return 1
+        mkdir $d
+        touch $d/ChangeLog
+        (cd $d && git init && git add ChangeLog && git ci -m. -a)
+        ln --backup -s $d/ChangeLog .
+    }
+
+
+
 =head1  RESTRICTIONS

 This tool can be useful to you only if you use a version control system.
--
1.6.4.2.384.g5fc62