Generated.
[git2cl.git] / README.html
blobf82da5d6e2bccddf2de7aab9419ce5dc68f60101
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4 <head>
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
6 <meta name="generator" content="AsciiDoc 8.2.7" />
7 <style type="text/css">
8 /* Debug borders */
9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
11 border: 1px solid red;
15 body {
16 margin: 1em 5% 1em 5%;
19 a {
20 color: blue;
21 text-decoration: underline;
23 a:visited {
24 color: fuchsia;
27 em {
28 font-style: italic;
29 color: navy;
32 strong {
33 font-weight: bold;
34 color: #083194;
37 tt {
38 color: navy;
41 h1, h2, h3, h4, h5, h6 {
42 color: #527bbd;
43 font-family: sans-serif;
44 margin-top: 1.2em;
45 margin-bottom: 0.5em;
46 line-height: 1.3;
49 h1, h2, h3 {
50 border-bottom: 2px solid silver;
52 h2 {
53 padding-top: 0.5em;
55 h3 {
56 float: left;
58 h3 + * {
59 clear: left;
62 div.sectionbody {
63 font-family: serif;
64 margin-left: 0;
67 hr {
68 border: 1px solid silver;
71 p {
72 margin-top: 0.5em;
73 margin-bottom: 0.5em;
76 ul, ol, li > p {
77 margin-top: 0;
80 pre {
81 padding: 0;
82 margin: 0;
85 span#author {
86 color: #527bbd;
87 font-family: sans-serif;
88 font-weight: bold;
89 font-size: 1.1em;
91 span#email {
93 span#revision {
94 font-family: sans-serif;
97 div#footer {
98 font-family: sans-serif;
99 font-size: small;
100 border-top: 2px solid silver;
101 padding-top: 0.5em;
102 margin-top: 4.0em;
104 div#footer-text {
105 float: left;
106 padding-bottom: 0.5em;
108 div#footer-badges {
109 float: right;
110 padding-bottom: 0.5em;
113 div#preamble,
114 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
115 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
116 div.admonitionblock {
117 margin-right: 10%;
118 margin-top: 1.5em;
119 margin-bottom: 1.5em;
121 div.admonitionblock {
122 margin-top: 2.5em;
123 margin-bottom: 2.5em;
126 div.content { /* Block element content. */
127 padding: 0;
130 /* Block element titles. */
131 div.title, caption.title {
132 color: #527bbd;
133 font-family: sans-serif;
134 font-weight: bold;
135 text-align: left;
136 margin-top: 1.0em;
137 margin-bottom: 0.5em;
139 div.title + * {
140 margin-top: 0;
143 td div.title:first-child {
144 margin-top: 0.0em;
146 div.content div.title:first-child {
147 margin-top: 0.0em;
149 div.content + div.title {
150 margin-top: 0.0em;
153 div.sidebarblock > div.content {
154 background: #ffffee;
155 border: 1px solid silver;
156 padding: 0.5em;
159 div.listingblock {
160 margin-right: 0%;
162 div.listingblock > div.content {
163 border: 1px solid silver;
164 background: #f4f4f4;
165 padding: 0.5em;
168 div.quoteblock {
169 padding-left: 2.0em;
171 div.quoteblock > div.attribution {
172 padding-top: 0.5em;
173 text-align: right;
176 div.verseblock {
177 padding-left: 2.0em;
179 div.verseblock > div.content {
180 white-space: pre;
182 div.verseblock > div.attribution {
183 padding-top: 0.75em;
184 text-align: left;
186 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
187 div.verseblock + div.attribution {
188 text-align: left;
191 div.admonitionblock .icon {
192 vertical-align: top;
193 font-size: 1.1em;
194 font-weight: bold;
195 text-decoration: underline;
196 color: #527bbd;
197 padding-right: 0.5em;
199 div.admonitionblock td.content {
200 padding-left: 0.5em;
201 border-left: 2px solid silver;
204 div.exampleblock > div.content {
205 border-left: 2px solid silver;
206 padding: 0.5em;
209 div.imageblock div.content { padding-left: 0; }
210 div.imageblock img { border: 1px solid silver; }
211 span.image img { border-style: none; }
213 dl {
214 margin-top: 0.8em;
215 margin-bottom: 0.8em;
217 dt {
218 margin-top: 0.5em;
219 margin-bottom: 0;
220 font-style: normal;
222 dd > *:first-child {
223 margin-top: 0.1em;
226 ul, ol {
227 list-style-position: outside;
229 div.olist > ol {
230 list-style-type: decimal;
232 div.olist2 > ol {
233 list-style-type: lower-alpha;
236 div.tableblock > table {
237 border: 3px solid #527bbd;
239 thead {
240 font-family: sans-serif;
241 font-weight: bold;
243 tfoot {
244 font-weight: bold;
247 div.hlist {
248 margin-top: 0.8em;
249 margin-bottom: 0.8em;
251 div.hlist td {
252 padding-bottom: 15px;
254 td.hlist1 {
255 vertical-align: top;
256 font-style: normal;
257 padding-right: 0.8em;
259 td.hlist2 {
260 vertical-align: top;
263 @media print {
264 div#footer-badges { display: none; }
267 div#toctitle {
268 color: #527bbd;
269 font-family: sans-serif;
270 font-size: 1.1em;
271 font-weight: bold;
272 margin-top: 1.0em;
273 margin-bottom: 0.1em;
276 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
277 margin-top: 0;
278 margin-bottom: 0;
280 div.toclevel2 {
281 margin-left: 2em;
282 font-size: 0.9em;
284 div.toclevel3 {
285 margin-left: 4em;
286 font-size: 0.9em;
288 div.toclevel4 {
289 margin-left: 6em;
290 font-size: 0.9em;
292 /* Workarounds for IE6's broken and incomplete CSS2. */
294 div.sidebar-content {
295 background: #ffffee;
296 border: 1px solid silver;
297 padding: 0.5em;
299 div.sidebar-title, div.image-title {
300 color: #527bbd;
301 font-family: sans-serif;
302 font-weight: bold;
303 margin-top: 0.0em;
304 margin-bottom: 0.5em;
307 div.listingblock div.content {
308 border: 1px solid silver;
309 background: #f4f4f4;
310 padding: 0.5em;
313 div.quoteblock-attribution {
314 padding-top: 0.5em;
315 text-align: right;
318 div.verseblock-content {
319 white-space: pre;
321 div.verseblock-attribution {
322 padding-top: 0.75em;
323 text-align: left;
326 div.exampleblock-content {
327 border-left: 2px solid silver;
328 padding-left: 0.5em;
331 /* IE6 sets dynamically generated links as visited. */
332 div#toc a:visited { color: blue; }
334 /* Because IE6 child selector is broken. */
335 div.olist2 ol {
336 list-style-type: lower-alpha;
338 div.olist2 div.olist ol {
339 list-style-type: decimal;
341 </style>
342 <title>git2cl</title>
343 </head>
344 <body>
345 <div id="header">
346 <h1>git2cl</h1>
347 </div>
348 <div id="preamble">
349 <div class="sectionbody">
350 <div class="para"><p>This is a quick'n'dirty tool to convert git logs to GNU ChangeLog
351 format.</p></div>
352 <div class="para"><p>The tool invokes <em>git log</em> internally unless you pipe a log to it.
353 Thus, typically you would use it as follows:</p></div>
354 <div class="literalblock">
355 <div class="content">
356 <pre><tt>jas@mocca:~/src/libtasn1$ git2cl &gt; ChangeLog
357 jas@mocca:~/src/libtasn1$</tt></pre>
358 </div></div>
359 <div class="para"><p>If you don't want git2cl to invoke git log internally, you can use it
360 as a pipe. It needs a git log generated with &#8212;pretty &#8212;numstat and
361 &#8212;summary. You can use it as follows:</p></div>
362 <div class="literalblock">
363 <div class="content">
364 <pre><tt>jas@mocca:~/src/libtasn1$ git log --pretty --numstat --summary | ~/src/git2cl/git2cl &gt; ChangeLog
365 jas@mocca:~/src/libtasn1$</tt></pre>
366 </div></div>
367 <div class="para"><p>The output format is specified by:</p></div>
368 <div class="para"><p><a href="http://www.gnu.org/prep/standards/html_node/Change-Logs.html">http://www.gnu.org/prep/standards/html_node/Change-Logs.html</a></p></div>
369 <div class="para"><p>My inspiration for writing this tool was the
370 <a href="http://www.red-bean.com/cvs2cl/">cvs2cl</a> tool, which I have been
371 using in several projects. Replacing it was necessary to seriously
372 consider switching from CVS to GIT for my projects.</p></div>
373 <div class="para"><p>The canonical home page for git2cl is:
374 <a href="http://josefsson.org/git2cl/">http://josefsson.org/git2cl/</a> and its repository can be found at
375 <a href="http://repo.or.cz/w/git2cl.git">http://repo.or.cz/w/git2cl.git</a>.</p></div>
376 </div>
377 </div>
378 <h2 id="_credits">Credits</h2>
379 <div class="sectionbody">
380 <div class="para"><p>Luis Mondesi contributed several improvements.</p></div>
381 </div>
382 <h2 id="_support">Support</h2>
383 <div class="sectionbody">
384 <div class="para"><p>Try talking to <a href="mailto:simon@josefsson.org">Simon Josefsson</a>.</p></div>
385 </div>
386 <div id="footer">
387 <div id="footer-text">
388 Last updated 2008-08-27 12:42:17 CEST
389 </div>
390 </div>
391 </body>
392 </html>