citrun

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

ANNOUNCEMENT (3147B)

      1 -------------------------------------------------------------------------------
      2 - C It Run 0.0 RELEASED -------------------------------------------------------
      3 
      4 September 15, 2016.
      5 
      6 We are pleased to announce the official release of C It Run 0.0.
      7 This is the very first release available.
      8 
      9 This release includes tools and documentation that realize the goal of software
     10 execution visualization:
     11 
     12   - Instrumentation tools, including:
     13      o New citrun_wrap(1) script for adding instrumentation to a native build
     14        command
     15      o New citrun_inst(1) utility for C/C++ source to source transformation
     16      o New citrun_term(1) utility that uses Curses for terminal execution
     17        visualization
     18      o New citrun_report(1) script for summarizing instrumentation activity
     19      o New work in progress citrun_gl(1) utility
     20 
     21   - Documentation, including:
     22      o New manuals for citrun_inst, citrun_term, citrun_wrap and citrun_report
     23 
     24   - Testing and code reports, including:
     25      o Multiple layers (including Real World C/C++ code)
     26      o Coverage generation (drives new test creation)
     27      o Static analysis
     28 
     29   - Binary packages, including:
     30      o Debian 9.0 and OpenBSD 6.0 on sparc64
     31      o Darwin 15 and OpenBSD 6.0 on amd64
     32 
     33   - Compatibility:
     34      o Minor release API interoperability guarantee.
     35 
     36 -------------------------------------------------------------------------------
     37 - TESTING ---------------------------------------------------------------------
     38 
     39 Several methods are used to ensure high quality released source code:
     40 
     41    o Multiple testing layers, end-to-end reports are at 'e2e_*.txt'
     42    o Test coverage, .gcov files available in 'coverage/'
     43    o Static analysis summary available in 'static_analysis'
     44 
     45 -------------------------------------------------------------------------------
     46 - BINARY PACKAGES -------------------------------------------------------------
     47 
     48 Because C It Run has not been integrated into any system package managers, there
     49 are binary packages for the following platforms available:
     50 
     51    o Darwin 15 amd64
     52    o Debian 9.0 sparc64
     53    o OpenBSD 6.0 amd64
     54    o OpenBSD 6.0 sparc64
     55 
     56 -------------------------------------------------------------------------------
     57 - SOURCE CODE -----------------------------------------------------------------
     58 
     59 The source code is available in this directory as citrun.tar.gz.
     60 
     61 -------------------------------------------------------------------------------
     62 - COMPATIBILITY ---------------------------------------------------------------
     63 
     64 The runtime interface is interoperable between different minor versions of
     65 instrumented binaries and installed viewers.
     66 
     67 Said in different words, programs instrumented with one C It Run version will
     68 work (no re-instrumentation needed) with viewing tools from another C It Run
     69 version as long as both versions share the same major (If version is X.Y major
     70 is X).
     71 
     72 -------------------------------------------------------------------------------
     73 - BUGS ------------------------------------------------------------------------
     74 
     75 Instrumented code cannot be inserted or removed at runtime (via dlopen() etc).
     76 This may be fixed in a future release.