commit cedc12d3a1e666b2a8ee5ea7b8cd70335caa0c95
parent 0934a017038ba9f34ed34112daa78a7067ddbf53
Author: Kyle Milz <milz@imac.0x30.net>
Date: Thu, 4 Mar 2021 01:13:05 -0800
www: add 0.0 release
Diffstat:
| A | www/0.0/ANNOUNCEMENT | | | 76 | ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| A | www/0.0/index.html | | | 110 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
2 files changed, 186 insertions(+), 0 deletions(-)
diff --git a/www/0.0/ANNOUNCEMENT b/www/0.0/ANNOUNCEMENT
@@ -0,0 +1,76 @@
+-------------------------------------------------------------------------------
+- C It Run 0.0 RELEASED -------------------------------------------------------
+
+September 15, 2016.
+
+We are pleased to announce the official release of C It Run 0.0.
+This is the very first release available.
+
+This release includes tools and documentation that realize the goal of software
+execution visualization:
+
+ - Instrumentation tools, including:
+ o New citrun_wrap(1) script for adding instrumentation to a native build
+ command
+ o New citrun_inst(1) utility for C/C++ source to source transformation
+ o New citrun_term(1) utility that uses Curses for terminal execution
+ visualization
+ o New citrun_report(1) script for summarizing instrumentation activity
+ o New work in progress citrun_gl(1) utility
+
+ - Documentation, including:
+ o New manuals for citrun_inst, citrun_term, citrun_wrap and citrun_report
+
+ - Testing and code reports, including:
+ o Multiple layers (including Real World C/C++ code)
+ o Coverage generation (drives new test creation)
+ o Static analysis
+
+ - Binary packages, including:
+ o Debian 9.0 and OpenBSD 6.0 on sparc64
+ o Darwin 15 and OpenBSD 6.0 on amd64
+
+ - Compatibility:
+ o Minor release API interoperability guarantee.
+
+-------------------------------------------------------------------------------
+- TESTING ---------------------------------------------------------------------
+
+Several methods are used to ensure high quality released source code:
+
+ o Multiple testing layers, end-to-end reports are at 'e2e_*.txt'
+ o Test coverage, .gcov files available in 'coverage/'
+ o Static analysis summary available in 'static_analysis'
+
+-------------------------------------------------------------------------------
+- BINARY PACKAGES -------------------------------------------------------------
+
+Because C It Run has not been integrated into any system package managers, there
+are binary packages for the following platforms available:
+
+ o Darwin 15 amd64
+ o Debian 9.0 sparc64
+ o OpenBSD 6.0 amd64
+ o OpenBSD 6.0 sparc64
+
+-------------------------------------------------------------------------------
+- SOURCE CODE -----------------------------------------------------------------
+
+The source code is available in this directory as citrun.tar.gz.
+
+-------------------------------------------------------------------------------
+- COMPATIBILITY ---------------------------------------------------------------
+
+The runtime interface is interoperable between different minor versions of
+instrumented binaries and installed viewers.
+
+Said in different words, programs instrumented with one C It Run version will
+work (no re-instrumentation needed) with viewing tools from another C It Run
+version as long as both versions share the same major (If version is X.Y major
+is X).
+
+-------------------------------------------------------------------------------
+- BUGS ------------------------------------------------------------------------
+
+Instrumented code cannot be inserted or removed at runtime (via dlopen() etc).
+This may be fixed in a future release.
diff --git a/www/0.0/index.html b/www/0.0/index.html
@@ -0,0 +1,110 @@
+<!DOCTYPE html>
+<html>
+<head>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width" />
+ <meta name="description" content="C It Run 0.0 Release." />
+
+ <title>C It Run 0.0 Announcement</title>
+ <link rel="stylesheet" type="text/css" href="../citrun.css" />
+</head>
+<body>
+ <h1>C It Run 0.0 RELEASED</h1>
+
+ <p>September 15, 2016.</p>
+
+ <p>I am pleased to announce the official release of C It Run 0.0.
+ This is the very first release available.
+ </p>
+
+ <p>This release includes tools and documentation that realize the goal of software
+ execution visualization:
+ </p>
+
+ <ul>
+ <li> Instrumentation tools, including:
+ <ul>
+ <li>New citrun_wrap(1) script that enables rewriting on an
+ existing build command
+ <li>New citrun_report(1) script that summarizes rewriting
+ activity
+ <li>New citrun_gl(1) utility that displays executing programs
+ <li>New citrun_inst(1) utility for C/C++ source code rewriting
+ </ul>
+ </li>
+ <li> Documentation, including:
+ <ul>
+ <li>New manuals for citrun_wrap, citrun_report, citrun_gl and
+ citrun_inst
+ </ul>
+ </li>
+ <li> Code reports, including:
+ <ul>
+ <li>Test coverage
+ <li>Static analysis
+ </ul>
+ </li>
+ <li> Pre-built binary packages for select operating systems, including:
+ <ul>
+ <li>Darwin 15
+ <li>Debian 9.0
+ <li>OpenBSD 6.0
+ </ul>
+ </li>
+ <li> Forward compatibility:
+ <ul>
+ <li> Minor release interoperability guarantee.
+ </ul>
+ </li>
+ </ul>
+
+ <h2>Code Reports</h2>
+
+ <p>High quality releases are ensured by:
+ </p>
+ <ul>
+ <li>Automated testing with <a href="e2e.txt">end-to-end reports</a>
+ <li>Test coverage of source:
+ <ul>
+ <li> <a href="cov/runtime.c.gcov">src/runtime.c</a>
+ <li> <a href="cov/inst_main.cc.gcov">src/inst_main.cc</a>
+ </ul>
+ </li>
+ <li> <a href="sa/index.html">Static analysis</a>
+ </ul>
+
+ <h2>Binary Packages</h2>
+ <p>Because C It Run has not been integrated into any system package
+ managers, there are binary packages for the following platforms
+ available:
+ </p>
+ <ul>
+ <li>Darwin 15/x86_64
+ <li>Debian 9.0/sparc64
+ <li>OpenBSD 6.0/amd64
+ <li>OpenBSD 6.0/sparc64
+ </ul>
+
+ <h2>Source</h2>
+
+ <p>The source code is available in this directory as
+ <a href="citrun_0.0.tar.gz">citrun_0.0.tar.gz.</a>
+ </p>
+
+ <h2>Forward Compatibility</h2>
+
+ <p>The runtime interface is guaranteed not to change in minor
+ version bumps when the major version stays the same.
+ </p>
+
+ <p>This means that existing instrumented code will work with newer
+ tools.
+ </p>
+
+ <h2>Bugs</h2>
+
+ <p>Instrumented code cannot be inserted or removed at runtime (via
+ dlopen() etc). This may be fixed in a future release.
+ </p>
+</body>
+</html>
