Changeset 39142 in project


Ignore:
Timestamp:
11/07/20 14:08:22 (4 weeks ago)
Author:
Mario Domenech Goulart
Message:

eggref/5/salmonella-diff: initial documentation for C5

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wiki/eggref/5/salmonella-diff

    r39086 r39142  
    1 test results, where are they?
     1[[tags: egg salmonella-diff]]
    22
    3 Here: [[//tests.call-cc.org|tests.call-cc.org]]
     3== salmonella-diff
     4
     5[[toc:]]
     6
     7=== Introduction
     8
     9{{salmonella-diff}} is a command line tool to highlight differences
     10between two [[/egg/salmonella|salmonella]] log files.  It generates
     11HTML output.
     12
     13=== Author
     14
     15[[/users/mario-domenech-goulart|Mario Domenech Goulart]]
     16
     17=== Repository
     18
     19The salmonella-diff egg is maintained in a
     20[[https://github.com/mario-goulart/salmonella-diff|Github repository]].
     21
     22
     23=== Usage
     24
     25  $ salmonella-diff --help
     26  salmonella-diff.scm [ -h | --help ]
     27  salmonella-diff.scm [ --out-dir=<dir> ] [ --label1=<label1> ] [ --label2=<label2> ] log1 log2
     28
     29{{log1}} and {{log2}} are salmonella log files.
     30
     31{{--out-dir}} can be used to specify the directory where to generate
     32the HTML output.  If omitted, a {{salmonella-diff-html}} directory on
     33the current directory is created.
     34
     35{{--label1}} and {{--label2}} can be used to specify labels to
     36identify log files.  If omitted, the log filenames are used.
     37
     38
     39=== License
     40
     41  Copyright (c) 2011-2020, Mario Domenech Goulart
     42  All rights reserved.
     43 
     44  Redistribution and use in source and binary forms, with or without
     45  modification, are permitted provided that the following conditions
     46  are met:
     47  1. Redistributions of source code must retain the above copyright
     48     notice, this list of conditions and the following disclaimer.
     49  2. Redistributions in binary form must reproduce the above copyright
     50     notice, this list of conditions and the following disclaimer in the
     51     documentation and/or other materials provided with the distribution.
     52  3. The name of the authors may not be used to endorse or promote products
     53     derived from this software without specific prior written permission.
     54 
     55  THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS
     56  OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
     57  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     58  ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
     59  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     60  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
     61  GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     62  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
     63  IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
     64  OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
     65  IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     66
     67
     68
     69=== Version history
     70
     71==== Version 1.1.0 (2020-11-07)
     72
     73* CHICKEN 5 support
     74
     75
     76==== Version 1
     77
     78* Added {{--label1}} and {{--label2}} to help message
     79
     80
     81==== Version 0
     82
     83* Initial release
     84
Note: See TracChangeset for help on using the changeset viewer.