((section 2 "Outdated egg!" (p "This is an egg for CHICKEN 4, the unsupported old release.  You're almost certainly looking for " (int-link "/eggref/5/salmonella-html-report" "the CHICKEN 5 version of this egg") ", if it exists.") (p "If it does not exist, there may be equivalent functionality provided by another egg; have a look at the " (link "https://wiki.call-cc.org/chicken-projects/egg-index-5.html" "egg index") ". Otherwise, please consider porting this egg to the current version of CHICKEN.") (tags "egg" "salmonella-html-report")) (section 2 "salmonella-html-report " (toc) (section 3 "Introduction" (p "A command line tool to generate HTML-formatted reports out of " (int-link "/egg/salmonella" "salmonella") " log files.") (p "This is the tool that generate the reports under the " (tt "salmonella-report") " directories in " (link "https://tests.call-cc.org" "https://tests.call-cc.org") ".")) (section 3 "Author" (p (int-link "/users/mario-domenech-goulart" "Mario Domenech Goulart"))) (section 3 "Repository" (p "salmonella-html-report is hosted on " (link "http://github.com" "github") ": " (link "https://github.com/mario-goulart/salmonella-html-report" "https://github.com/mario-goulart/salmonella-html-report"))) (section 3 "Dependencies" (ul (li (int-link "/egg/salmonella" "salmonella")) (li (int-link "/egg/sxml-transforms" "sxml-transforms"))) (p (tt "salmonella-html-report") " also uses the " (tt "dot") " command line tool (provided by " (link "http://www.graphviz.org/" "Graphviz") ") to generate the [reverse] dependencies graphs.")) (section 3 "Usage" (pre " $ salmonella-html-report --help\n Usage: salmonella-html-report [ <options> ] <salmonella log file> <out dir>\n \n --verbose\n   Verbose output.\n \n --disable-graphs\n   Disable generation of dependency graphs.\n \n --css-uri=<uri>\n   URI of the CSS file to be used in the generatated pages.\n \n --graphics-format=<type>\n   Format of the [reverse] dependency graph images.  The supported ones\n   are those supported by dot (GraphViz).  The default format is SVG.\n \n --compress-html\n   Compress HTML files using gzip.\n \n --html-compressor\n   External program to use to compress HTML files.\n \n --html-compressor-args\n   Arguments to be passed to the external program to compress HTML files.\n \n --compress-graphics\n   Compress graphics files using gzip.\n \n --graphics-compressor\n   External program to use to compress graphics files.\n \n --graphics-compressor-args\n   Arguments to be passed to the external program to compress graphics files.\n \n --keep-dot-files\n   By default, salmonella-html-report will remove dot files (GraphViz) after converting\n   them to graphics files.  This command line can be used to avoid removing\n   them.")) (section 3 "License" (pre " Copyright (c) 2010-2019, Mario Domenech Goulart\n All rights reserved.\n \n Redistribution and use in source and binary forms, with or without\n modification, are permitted provided that the following conditions\n are met:\n 1. Redistributions of source code must retain the above copyright\n    notice, this list of conditions and the following disclaimer.\n 2. Redistributions in binary form must reproduce the above copyright\n    notice, this list of conditions and the following disclaimer in the\n    documentation and/or other materials provided with the distribution.\n 3. The name of the authors may not be used to endorse or promote products\n    derived from this software without specific prior written permission.\n \n THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS\n OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED\n WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE\n ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY\n DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\n DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE\n GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS\n INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER\n IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR\n OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN\n IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.")) (section 3 "Version history" (section 4 "Version 1.7.2 (2024-12-17)" (ul (li "Support for CHICKEN 6") (li "Use " (tt "<!DOCTYPE html>") " as doctype"))) (section 4 "Version 1.7.1 (2021-01-01)" (ul (li "Add " (tt "--version") " command line option") (li "Tolerate salmonella log files without egg metadata"))) (section 4 "Version 1.7.0" (ul (li "CHICKEN 5 support") (li "Add \"Undocumented eggs\" section (suggested by Peter Bex)") (li "Show error messages in case of fetch error") (li "Circular dependencies detection and reporting") (li "Disable \"Test report\" link when there's no test report") (li "Show installation status in the installation report page title") (li "Add \"Total run time\" to TOC") (li "Use SVG as default graphics format") (li "Remove .dot files after generating graphics (the new " (tt "--keep-dot-files") " command line option can be used to preserve dot file)") (li "Compression support") (li "Split " (tt "salmonella-html-report") " into a loadable extension and a command line tool") (li "Check if the arguments for egg-dependencies are really eggs (core libraries and other non-egg things don't have metadata information)") (li "Drop dependency on regex (use irregex instead)") (li "Don't warn about GPL eggs in test-depends of non-GPL eggs") (li "Don't hardcode the protocol in the link to the CSS file"))) (section 4 "Version 1.6" (ul (li "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"))) (section 4 "Version 1.5" (ul (li "Fixed listing of eggs whose installation succeeded but tests failed.  Don't show broken dependencies for tests."))) (section 4 "Version 1.4" (ul (li "Added test status to test pages to ease checking if eggs exit status are actually consistent"))) (section 4 "Version 1.3" (ul (li "Fixed release-info file"))) (section 4 "Version 1.2" (ul (li "Subclassification of the \"Installation succeeded\" section according to test status (as suggested by " (int-link "/users/peter-bex" "Peter Bex") ")"))) (section 4 "Version 1.1" (ul (li "Added rank pages") (li "Added TOC"))) (section 4 "Version 1.0" (ul (li "Initial release"))))))