1svn2cl(1) User Commands svn2cl(1)
2
6 svn2cl - Create a ChangeLog from a subversion log.
7
9 svn2cl [OPTION]... [PATH]...
10
13 svn2cl generates a classic GNU-style ChangeLog from the log messages in
14 a subversion repository. It acts as a wrapper around the 'svn log'
15 command, parsing the XML output with an XSLT stylesheet. Alternatively
16 it can generate HTML output intended for use with the svn2html.css
17 style sheet that comes with svn2cl.
18 In addition to its own options, it accepts and passes along most svn
20 log options; see 'svn help log' for a list of those and their
21 documentation. If PATH is not given, svn2cl will run svn log on the
22 current directory, so it should do the right thing when run from the
23 top of a subversion checkout of the project.
24 --strip-prefix=NAME
27 Strip NAME from the first part of all file names (e.g.
28 project/trunk). By defaults the current path inside the
29 repository is stripped.
30 --linelen=NUM
33 Wrap lines at NUM characters. By default, lines are wrapped at
34 75 characters. This option is ignored when the --html option is
35 specified.
36 --group-by-day
39 This option causes all commit messages to be grouped by day, as
40 long as all the changes are by the same author. By default each
41 message is listed separately with its own timestamp.
42 --separate-daylogs
45 Include a blank line between log entries when they are grouped
46 by day. Only useful with the --group-by-day option. This
47 option is ignored when the --html option is specified, edit
48 svn2html.css to tune the layout.
49 -i, --include-rev
52 Include the subversion revision number in the ChangeLog. If the
53 --html option is specified this is implied, edit svn2html.css to
54 turn it off.
55 -a, --include-actions
58 Add action labels [ADD], [DEL] and [CPY] tags to files to show
59 the operation that is performned on the files.
60 --break-before-msg[=NUM]
63 Add a line break (or multiple line breadks) between the paths
64 and the log message. If the --html option is specified this
65 option is ignored, edit svn2html.css to set spacing.
66 --reparagraph
69 Newlines inside paragraphs are ignored and paragraphs are re-
70 wrapped. Paragraphs are separated by empty lines.
71 --title=NAME
74 If outputting an HTML file the NAME is used as the title. This
75 option is ignored for normal text output.
76 --revision-link=NAME
79 This option is used to generate links from the revision numbers
80 in the generated HTML file. If NAME contains two hashes '##'
81 that part will be replaced by the revision number, otherwise the
82 revision number will be appended to NAME. Only the first
83 occurrence of '##' will be replaced.
84 This option is ignored for normal text output.
85 --ignore-message-starting=STRING
88 Any log messages that start with the specified STRING are
89 ignored and will not show up in the output. The STRING
90 comparison is case sensitive.
91 -o, -f, --output=FILE, --file=FILE
94 Output ChangeLog to FILE instead of the default ChangeLog (or
95 ChangeLog.html for HTML output).
96 --stdout
99 Output ChangeLog to stdout instead of to a file.
100 --authors=FILE
103 The FILE is used to map author names as exported by svn to full
104 names. See the section on AUTHORS FILES below for more
105 information.
106 Note that the --authors option can have poor performance in some
107 cases.
108 --html Generate an HTML file containing a ChangeLog instead of the
111 default text ChangeLog file. This feature is still
112 experimental. The svn2html.css file that is included in the
113 distribution can be used to format the HTML.
114 -h, --help
117 Show short summary of options.
118 -V, --version
121 Show version of program.
122 Optional PATH arguments and the following options are passed directly
125 to the 'svn --xml log' command: -r, --revision, --targets,
126 --stop-on-copy, --username, --password, --no-auth-cache,
127 --non-interactive, --config-dir and --limit.
128 See 'svn help log' for more information on these options.
129
132 An authors file is basically an XML file that should look something
133 like:
134 <?xml version="1.0" encoding="utf-8"?>
135 <authors>
136 <author uid="arthur">
137 Arthur de Jong <arthur@ch.tudelft.nl>
138 </author>
139 </authors>
140 svn2cl searches for <author> tags with the specified uid attribute.
141 The content from the author tag is substituted for the author name.
142 The <author> tag may also contain XML child tags which can be useful
144 for embedding HTML into the result. For this to work namespace
145 information should be included for HTML output:
146 <?xml version="1.0" encoding="utf-8"?>
147 <authors xmlns:html="http://www.w3.org/1999/xhtml">
148 <author uid="arthur">
149 Arthur de Jong <<html:b>arthur@ch.tudelft.nl</html:b>>
150 </author>
151 </authors>
152 The svn2cl distribution contains a sample authors.xml file.
153 As a bonus a plain text authors file that looks like the following is
155 automatically converted to the XML representation:
156 arthur:Arthur de Jong <arthur@ch.tudelft.nl>
157
160 Note that the default revison range for svn log is BASE:1. This means
161 that svn2cl will not always include the most recent revisons of the
162 repository. Either run 'svn update' before running svn2cl or pass '-r
163 HEAD:1'.
164
167 Run svn log recursively on the current directory and generate a text
168 ChangeLog file in the current directory for the entire log history:
169 svn2cl
170 Output the changes from the last week, while including revision numbers
172 in the ChangeLog:
173 svn2cl -i -r "HEAD:{`date -d '7 days ago' '+%F %T'`}"
174 (actually subversion will include the first revision before the
175 specified period)
176 Generate an HTML changelog for svn://svn.example.com/project/trunk,
178 removing "project/trunk" from the file names in the changelog. Group
179 all commits per day into one ChangeLog entry and only include changes
180 from 2005:
181 svn2cl --html --strip-prefix=project/trunk --group-by-day \
182 -r '{2006-01-01}:{2005-01-01}' \
183 svn://svn.example.com/project/trunk
184
187 'svn help log'
188
191 Copyright © 2005, 2006, 2007, 2008 Arthur de Jong
192 <arthur@ch.tudelft.nl>.
193 This is free software; see the license for copying conditions. There
194 is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A
195 PARTICULAR PURPOSE.
196Version 0.11 Apr 2008 svn2cl(1)