citrun

watch C/C++ source code execute
Log | Files | Refs | LICENSE

citrun_report.1 (2409B)

      1 .\"
      2 .\" Copyright (c) 2016, 2017 Kyle Milz <kyle@0x30.net>
      3 .\"
      4 .\" Permission to use, copy, modify, and distribute this software for any
      5 .\" purpose with or without fee is hereby granted, provided that the above
      6 .\" copyright notice and this permission notice appear in all copies.
      7 .\"
      8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
      9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
     10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
     11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
     12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
     13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
     14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
     15 .\"
     16 .Dd $Mdocdate: September 18 2017 $
     17 .Dt CITRUN_REPORT 1
     18 .Os
     19 .Sh NAME
     20 .Nm citrun_report
     21 .Nd create instrumentation reports
     22 .Sh SYNOPSIS
     23 .Nm
     24 .Op Ar citrun.log
     25 .Op Ar ...
     26 .Sh DESCRIPTION
     27 The
     28 .Nm
     29 script outputs an instrumentation report. The script takes input from all files
     30 listed as arguments, usually
     31 .Pa citrun.log
     32 files created by a
     33 .Xr citrun_wrap 1
     34 invocation, and typically outputs two sections titled
     35 .Qq Summary
     36 and
     37 .Qq Totals .
     38 .Pp
     39 When no arguments are given
     40 .Nm
     41 uses standard input.
     42 .Sh SUMMARY
     43 The
     44 .Qq Summary
     45 section contains high, project level instrumentation information, its
     46 output can consist of the following events:
     47 .Pp
     48 .Bl -tag -width Ds
     49 .It Rewrite tool runs
     50 Number of times
     51 .Xr citrun_inst 1
     52 was invoked.
     53 .It Source files used as input
     54 Number of C/C++ source files that had rewriting attempted.
     55 .It Application link commands
     56 Number of application link commands detected and modified.
     57 .It Successful modified source compiles
     58 Number of source files both rewritten and compiled successfully.
     59 .It Failed modified source compiles
     60 Number of source files rewritten successfully but not compiled.
     61 .Pp
     62 This can happen because either:
     63 .Bl -bullet -compact
     64 .It
     65 The original source file would have failed compilation too
     66 .It
     67 The source rewriting was bad and caused compilation to fail
     68 .El
     69 .El
     70 .Sh TOTALS
     71 The
     72 .Qq Totals
     73 section shows how many code transformations have been attempted.
     74 .Sh EXAMPLES
     75 .Dl $ citrun_report citrun.log
     76 .Dl $ citrun_report citrun.log */citrun.log */*/citrun.log
     77 .Dl $ find\ . -name citrun.log | xargs citrun_report
     78 .Sh EXIT STATUS
     79 .Ex -std
     80 .Sh SEE ALSO
     81 .Xr citrun_wrap 1