source: project/wiki/eggref/5/salmonella-html-report @ 39480

Last change on this file since 39480 was 39480, checked in by Mario Domenech Goulart, 6 months ago

eggref/5/salmonella-html-report: release notes for version 1.7.1

File size: 5.2 KB
Line 
1[[tags: egg salmonella-html-report]]
2
3== salmonella-html-report
4
5[[toc:]]
6
7
8=== Introduction
9
10A command line tool to generate HTML-formatted reports out of
11[[/egg/salmonella|salmonella]] log files.
12
13This is the tool that generate the reports under the
14{{salmonella-report}} directories in
15[[https://tests.call-cc.org|https://tests.call-cc.org]].
16
17=== Author
18
19[[/users/mario-domenech-goulart|Mario Domenech Goulart]]
20
21
22=== Repository
23
24salmonella-html-report is hosted on [[http://github.com|github]]:
25[[https://github.com/mario-goulart/salmonella-html-report|https://github.com/mario-goulart/salmonella-html-report]]
26
27
28=== Dependencies
29
30* [[/egg/salmonella|salmonella]]
31* [[/egg/srfi-1|srfi-1]]
32* [[/egg/srfi-13|srfi-13]]
33* [[/egg/sxml-transforms|sxml-transforms]]
34
35{{salmonella-html-report}} also uses the {{dot}} command line tool
36(provided by [[http://www.graphviz.org/|Graphviz]]) to generate the
37[reverse] dependencies graphs.
38
39
40=== Usage
41
42  $ salmonella-html-report --help
43  Usage: salmonella-html-report [ <options> ] <salmonella log file> <out dir>
44 
45  --verbose
46    Verbose output.
47 
48  --disable-graphs
49    Disable generation of dependency graphs.
50 
51  --css-uri=<uri>
52    URI of the CSS file to be used in the generatated pages.
53 
54  --graphics-format=<type>
55    Format of the [reverse] dependency graph images.  The supported ones
56    are those supported by dot (GraphViz).  The default format is SVG.
57 
58  --compress-html
59    Compress HTML files using gzip.
60 
61  --html-compressor
62    External program to use to compress HTML files.
63 
64  --html-compressor-args
65    Arguments to be passed to the external program to compress HTML files.
66 
67  --compress-graphics
68    Compress graphics files using gzip.
69 
70  --graphics-compressor
71    External program to use to compress graphics files.
72 
73  --graphics-compressor-args
74    Arguments to be passed to the external program to compress graphics files.
75 
76  --keep-dot-files
77    By default, salmonella-html-report will remove dot files (GraphViz) after converting
78    them to graphics files.  This command line can be used to avoid removing
79    them.
80
81
82=== License
83
84  Copyright (c) 2010-2019, Mario Domenech Goulart
85  All rights reserved.
86 
87  Redistribution and use in source and binary forms, with or without
88  modification, are permitted provided that the following conditions
89  are met:
90  1. Redistributions of source code must retain the above copyright
91     notice, this list of conditions and the following disclaimer.
92  2. Redistributions in binary form must reproduce the above copyright
93     notice, this list of conditions and the following disclaimer in the
94     documentation and/or other materials provided with the distribution.
95  3. The name of the authors may not be used to endorse or promote products
96     derived from this software without specific prior written permission.
97 
98  THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS
99  OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
100  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
101  ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
102  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
103  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
104  GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
105  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
106  IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
107  OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
108  IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
109
110
111=== Version history
112
113==== Version 1.7.1 (2021-01-01)
114
115* Add {{--version}} command line option
116* Tolerate salmonella log files without egg metadata
117
118
119==== Version 1.7.0
120
121* CHICKEN 5 support
122* Add "Undocumented eggs" section (suggested by Peter Bex)
123* Show error messages in case of fetch error
124* Circular dependencies detection and reporting
125* Disable "Test report" link when there's no test report
126* Show installation status in the installation report page title
127* Add "Total run time" to TOC
128* Use SVG as default graphics format
129* Remove .dot files after generating graphics (the new {{--keep-dot-files}} command line option can be used to preserve dot file)
130* Compression support
131* Split {{salmonella-html-report}} into a loadable extension and a command line tool
132* Check if the arguments for egg-dependencies are really eggs (core libraries and other non-egg things don't have metadata information)
133* Drop dependency on regex (use irregex instead)
134* Don't warn about GPL eggs in test-depends of non-GPL eggs
135* Don't hardcode the protocol in the link to the CSS file
136
137
138==== Version 1.6
139
140* Fixed bug in license verification (it assumed versions were always strings, but they could also be symbols).  Thanks to Peter Bex for reporting this issue
141
142
143==== Version 1.5
144
145*  Fixed listing of eggs whose installation succeeded but tests failed.  Don't show broken dependencies for tests.
146
147
148==== Version 1.4
149
150* Added test status to test pages to ease checking if eggs exit status are actually consistent
151
152
153==== Version 1.3
154
155* Fixed release-info file
156
157
158==== Version 1.2
159
160* Subclassification of the "Installation succeeded" section according to test status (as suggested by [[/users/peter-bex|Peter Bex]])
161
162==== Version 1.1
163
164* Added rank pages
165* Added TOC
166
167
168==== Version 1.0
169
170* Initial release
Note: See TracBrowser for help on using the repository browser.