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 --break-before-msg[=NUM]
58 Add a line break (or multiple line breadks) between the paths
59 and the log message. If the --html option is specified this
60 option is ignored, edit svn2html.css to set spacing.
61 --reparagraph
64 Newlines inside paragraphs are ignored and paragraphs are re-
65 wrapped. Paragraphs are separated by empty lines.
66 --title=NAME
69 If outputting an HTML file the NAME is used as the title. This
70 option is ignored for normal text output.
71 --revision-link=NAME
74 This option is used to generate links from the revision numbers
75 in the generated HTML file. If NAME contains two hashes `##'
76 that part will be replaced by the revision number, otherwise the
77 revision number will be appended to NAME. Only the first
78 occurrence of `##' will be replaced.
79 This option is ignored for normal text output.
80 --ignore-message-starting=STRING
83 Any log messages that start with the specified STRING are
84 ignored and will not show up in the output. The STRING
85 comparison is case sensitive.
86 -o, -f, --output=FILE, --file=FILE
89 Output ChangeLog to FILE instead of the default ChangeLog (or
90 ChangeLog.html for HTML output).
91 --stdout
94 Output ChangeLog to stdout instead of to a file.
95 --authors=FILE
98 The FILE is used to map author names as exported by svn to full
99 names. See the section on AUTHORS FILES below for more
100 information.
101 Note that the --authors option can have poor performance in some
102 cases.
103 --html Generate an HTML file containing a ChangeLog instead of the
106 default text ChangeLog file. This feature is still
107 experimental. The svn2html.css file that is included in the
108 distribution can be used to format the HTML.
109 -h, --help
112 Show short summary of options.
113 -V, --version
116 Show version of program.
117 Optional PATH arguments and the following options are passed directly
120 to the `svn --xml log' command: -r, --revision, --targets,
121 --stop-on-copy, --username, --password, --no-auth-cache,
122 --non-interactive, --config-dir and --limit.
123 See `svn help log' for more information on these options.
124
127 An authors file is basically an XML file that should look something
128 like:
129 <?xml version="1.0" encoding="utf-8"?>
130 <authors>
131 <author uid="arthur">
132 Arthur de Jong <arthur@ch.tudelft.nl>
133 </author>
134 </authors>
135 svn2cl searches for <author> tags with the specified uid attribute.
136 The content from the author tag is substituted for the author name.
137 The <author> tag may also contain XML child tags which can be useful
139 for embedding HTML into the result. For this to work namespace
140 information should be included for HTML output:
141 <?xml version="1.0" encoding="utf-8"?>
142 <authors xmlns:html="http://www.w3.org/1999/xhtml">
143 <author uid="arthur">
144 Arthur de Jong <<html:b>arthur@ch.tudelft.nl</html:b>>
145 </author>
146 </authors>
147 The svn2cl distribution contains a sample authors.xml file.
148 As a bonus a plain text authors file that looks like the following is
150 automatically converted to the XML representation:
151 arthur:Arthur de Jong <arthur@ch.tudelft.nl>
152
155 Run svn log recursively on the current directory and generate a text
156 ChangeLog file in the current directory for the entire log history:
157 svn2cl
158 Output the changes from the last week, while including revision numbers
160 in the ChangeLog:
161 svn2cl -i -r "HEAD:{`date -d '7 days ago' '+%F %T'`}"
162 (actually subversion will include the first revision before the
163 specified period)
164 Generate an HTML changelog for svn://svn.example.com/project/trunk,
166 removing "project/trunk" from the file names in the changelog. Group
167 all commits per day into one ChangeLog entry and only include changes
168 from 2005:
169 svn2cl --html --strip-prefix=project/trunk --group-by-day \
170 -r '{2006-01-01}:{2005-01-01}'
171 svn://svn.example.com/project/trunk
172
175 `svn help log'
176
179 Copyright © 2005, 2006, 2007 Arthur de Jong <arthur@ch.tudelft.nl>.
180 This is free software; see the license for copying conditions. There
181 is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A
182 PARTICULAR PURPOSE.
183Version 0.9 Apr 2007 svn2cl(1)