Annotation of /trunk/pkgtools/svn2cl-0.14/README
Parent Directory | Revision Log
Revision 3106 -
(hide annotations)
(download)
Fri Mar 15 10:20:17 2019 UTC (5 years, 3 months ago) by niro
File size: 4237 byte(s)
Fri Mar 15 10:20:17 2019 UTC (5 years, 3 months ago) by niro
File size: 4237 byte(s)
-added working svn2cl version
1 | niro | 3106 | svn2cl - create a ChangeLog from a subversion log |
2 | |||
3 | Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2013 Arthur de Jong | ||
4 | |||
5 | Redistribution and use in source and binary forms, with or without | ||
6 | modification, are permitted provided that the following conditions | ||
7 | are met: | ||
8 | 1. Redistributions of source code must retain the above copyright | ||
9 | notice, this list of conditions and the following disclaimer. | ||
10 | 2. Redistributions in binary form must reproduce the above copyright | ||
11 | notice, this list of conditions and the following disclaimer in | ||
12 | the documentation and/or other materials provided with the | ||
13 | distribution. | ||
14 | 3. The name of the author may not be used to endorse or promote | ||
15 | products derived from this software without specific prior | ||
16 | written permission. | ||
17 | |||
18 | THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR | ||
19 | IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED | ||
20 | WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | ||
21 | ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY | ||
22 | DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | ||
23 | DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE | ||
24 | GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS | ||
25 | INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER | ||
26 | IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR | ||
27 | OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN | ||
28 | IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
29 | |||
30 | |||
31 | INTRODUCTION | ||
32 | ============ | ||
33 | |||
34 | svn2cl is a simple xsl transformation and shell script wrapper for generating | ||
35 | a classic GNU-style ChangeLog from a subversion repository log. It is made | ||
36 | from several changelog-like scripts using common xslt constructs found in | ||
37 | different places. | ||
38 | |||
39 | I made it because it was the only thing that I missed from cvs after I | ||
40 | converted a repository to subversion. I used cvs2cl before. | ||
41 | |||
42 | INSTALLING SVN2CL | ||
43 | ================= | ||
44 | |||
45 | Just unpack the tarball in some directory (e.g. /opt/svn2cl-0.14) | ||
46 | and symlink the svn2cl.sh script in your path somewhere (e.g. | ||
47 | ln -s /opt/svn2cl-0.14/svn2cl.sh /usr/local/bin/svn2cl). | ||
48 | |||
49 | Note: Be sure to keep the svn2cl.xsl file in the same directory as the | ||
50 | svn2cl.sh script as the script looks for it there (symlinking is ok). | ||
51 | |||
52 | USING SVN2CL IN AN ANT TARGET | ||
53 | ============================= | ||
54 | |||
55 | It is possible to use svn2cl in an ant target with a snippet like: | ||
56 | |||
57 | <tempfile property="info.xml.file" | ||
58 | prefix="info-" suffix=".xml" | ||
59 | destdir="${java.io.tmpdir}" /> | ||
60 | <java classname="org.tmatesoft.svn.cli.SVN" dir="${basedir}" | ||
61 | fork="true" output="${info.xml.file}" | ||
62 | classpathref="javasvn-classpath"> | ||
63 | <arg line="log --xml --verbose" /> | ||
64 | </java> | ||
65 | <xslt in="${info.xml.file}" out="ChangeLog" style="svn2cl.xsl"> | ||
66 | <param name="strip-prefix" expression="trunk/myProject/" /> | ||
67 | <param name="groupbyday" expression="yes" /> | ||
68 | <param name="separate-daylogs" expression="yes" /> | ||
69 | <param name="include-rev" expression="yes" /> | ||
70 | <param name="breakbeforemsg" expression="yes" /> | ||
71 | <param name="reparagraph" expression="yes" /> | ||
72 | </xslt> | ||
73 | <delete file="${info.xml.file}" /> | ||
74 | |||
75 | Although it seems that currently the xslt processor that is used by ant | ||
76 | inserts newlines in places it shouldn't. This can be worked around by | ||
77 | replacing &newl; throughout the xsl files by 
. | ||
78 | |||
79 | WINDOWS PORT | ||
80 | ============ | ||
81 | |||
82 | A VBScript port of the wrapper shell script has been made by Iwasa Kazmi, | ||
83 | which allows running svn2cl on Microsoft Windows without a POSIX compatibility | ||
84 | layer and xsltproc. More information is available here: | ||
85 | http://www.cosmo-system.jp/iwasa/svn2clwin.html | ||
86 | |||
87 | NOTES | ||
88 | ===== | ||
89 | |||
90 | The log is performed on the current directory '.' unless you specify URL | ||
91 | and/or PATH parameters. Before generating the ChangeLog you may want to make | ||
92 | your working copy up to date with 'svn update' (non-recursive update will do) | ||
93 | or pass --revision HEAD:1 as a parameter to svn2cl.sh. | ||
94 | |||
95 | There will not be very frequent new releases but if there are they can be | ||
96 | found at: http://arthurdejong.org/svn2cl/ | ||
97 | |||
98 | FEEDBACK AND BUG REPORTS | ||
99 | ======================== | ||
100 | |||
101 | If you have any questions about svn2cl or would like to report a bug please | ||
102 | send an email to svn2cl-users@lists.arthurdejong.org. |