source: project/wiki/eggref/5/awful-salmonella-tar @ 39157

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

eggref/5/awful-salmonella-tar: add initial documentation for C5

File size: 3.2 KB
Line 
1[[tags: egg awful-salmonella-tar]]
2
3== awful-salmonella-tar
4
5[[toc:]]
6
7=== Introduction
8
9This is an [[/egg/awful|awful]] application to extract
10[[/egg/salmonella|salmonella]] report files from {{tar}} archives.
11
12It requires {{tar}} (tested it with GNU tar, specifically).  For
13compressed report tar files, {{gzip}} or {{bzip2}} are required (by
14default, {{gzip}} is used)
15
16To see it working, install {{awful-salmonella-tar}} with:
17
18  $ chicken-install awful-salmonella-tar
19
20Then add some test data:
21
22  $ mkdir -p reports/master/gcc/linux/x86-64/2018/09/02/
23  $ cd reports/master/gcc/linux/x86-64/2018/09/02/
24  $ wget https://salmonella-linux-x86-64.call-cc.org/master/gcc/linux/x86-64/2018/09/02/salmonella.log.bz2
25  $ bzip2 -d salmonella.log.bz2
26
27You'll need [[/egg/salmonella-html-report|salmonella-html-report]] to
28generate report data out of the salmonella log file.  If you don't
29have it installed, chicken-install
30[[/egg/salmonella-html-report|salmonella-html-report]]
31
32  $ salmonella-html-report salmonella.log salmonella-report
33  $ tar czf salmonella-report.tar.gz salmonella-report
34  $ rm -rf salmonella-report
35  $ cd -
36  $ cat <<EOF > awful-salmonella-tar-app.scm
37  (cond-expand
38  (chicken-4
39   (use awful-salmonella-tar))
40  (chicken-5
41   (import awful-salmonella-tar))
42  (else
43   (error "Unsupported CHICKEN version.")))
44 
45  (awful-salmonella-tar "/")
46  EOF
47  $ awful awful-salmonella-tar-app.scm
48
49Then request, for example
50http://localhost:8080/reports/master/gcc/linux/x86-64/2018/09/02/salmonella-report/
51
52
53=== Author
54
55[[/users/mario-domenech-goulart|Mario Domenech Goulart]]
56
57
58=== Repository
59
60{{awful-salmonella-tar}} is maintained in a
61[[https://github.com/mario-goulart/awful-salmonella-tar|Github repository]].
62
63
64=== License
65
66  Copyright (c) 2011-2020, Mario Domenech Goulart
67  All rights reserved.
68 
69  Redistribution and use in source and binary forms, with or without
70  modification, are permitted provided that the following conditions
71  are met:
72  1. Redistributions of source code must retain the above copyright
73     notice, this list of conditions and the following disclaimer.
74  2. Redistributions in binary form must reproduce the above copyright
75     notice, this list of conditions and the following disclaimer in the
76     documentation and/or other materials provided with the distribution.
77  3. The name of the authors may not be used to endorse or promote products
78     derived from this software without specific prior written permission.
79 
80  THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS
81  OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
82  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
83  ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
84  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
85  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
86  GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
87  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
88  IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
89  OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
90  IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
91
92
93=== Version history
94
95==== Version 0.0.3
96
97* Initial release as a CHICKEN egg (2020-11-07)
Note: See TracBrowser for help on using the repository browser.