citrun

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

commit 0eb6a900e87f234bb7bd32821217be3e9e0afb34
parent 1514881e1f327499c7e66f030b92b0325f6e535f
Author: Kyle Milz <kyle@getaddrinfo.net>
Date:   Tue,  7 Jun 2016 19:31:43 -0600

rename citrun_wrap to citrun-wrap

Diffstat:
Mbin/Jamfile | 4++--
Rbin/citrun_wrap -> bin/citrun-wrap | 0
Abin/citrun-wrap.1 | 66++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Dbin/citrun_wrap.1 | 64----------------------------------------------------------------
4 files changed, 68 insertions(+), 66 deletions(-)

diff --git a/bin/Jamfile b/bin/Jamfile @@ -1,4 +1,4 @@ SubDir TOP bin ; -InstallBin $(PREFIX)/bin : citrun_wrap ; -InstallMan $(PREFIX)/man : citrun_wrap.1 ; +InstallBin $(PREFIX)/bin : citrun-wrap ; +InstallMan $(PREFIX)/man : citrun-wrap.1 ; diff --git a/bin/citrun_wrap b/bin/citrun-wrap diff --git a/bin/citrun-wrap.1 b/bin/citrun-wrap.1 @@ -0,0 +1,66 @@ +.Dd April 10, 2016 +.Dt CITRUN-WRAP 1 +.Os +.Sh NAME +.Nm citrun-wrap +.Nd add instrumentation to a native build command +.Sh SYNOPSIS +.Nm +.Ar make | jam | gcc | cmake | ... +.Sh DESCRIPTION +Modifies source code in place, adding instrumentation to native source code. +Warning, read that last sentence again. +Add instrumentation to an existing native build command by configuring the +environment and then calling the command. +.Pp +If the native build system calls any of the following compilers, any output +object files should be instrumented: +.Pp +.Bl -tag -width Ds -offset indent -compact +.It c++ +.It cc +.It clang +.It clang++ +.It eg++ +.It egcc +.It g++ +.It gcc +.El +.Pp +.Nm +exports the +.Ev CITRUN_PATH +and +.Ev PATH +environment variables before calling the native build command. +.Pp +.Bl -tag -width Ds +.It Ev CITRUN_PATH +Points to a directory containing compiler named symlinks that all point to +.Xr citrun_instrument 1 . +.It Ev PATH +Is prepended with +.Ev CITRUN_PATH +so that binaries in that directory have the highest precedence. +.El +.Sh EXAMPLES +The following Makefile builds a simple target application named +.Qq program . +.Bd -literal -offset indent +PROG = program +SRCS = main.c + +\&.include <bsd.prog.mk> +.Ed +.Pp +To see +.Qq program +run, prepend +.Nm +to the native build command. In this case that build command is +.Qq make : +.Pp +.Dl $ citrun-wrap make +.Sh SEE ALSO +.Xr citrun_gl 1 , +.Xr citrun_instrument 1 diff --git a/bin/citrun_wrap.1 b/bin/citrun_wrap.1 @@ -1,64 +0,0 @@ -.Dd April 10, 2016 -.Dt CITRUN_WRAP 1 -.Os -.Sh NAME -.Nm citrun_wrap -.Nd add instrumentation to a native build command -.Sh SYNOPSIS -.Nm -.Ar make | jam | gcc | cmake | ... -.Sh DESCRIPTION -Add instrumentation to an existing native build command by configuring the -environment and then calling the command. -.Pp -If the native build system calls any of the following compilers, any output -object files should be instrumented: -.Pp -.Bl -tag -width Ds -offset indent -compact -.It c++ -.It cc -.It clang -.It clang++ -.It eg++ -.It egcc -.It g++ -.It gcc -.El -.Pp -.Nm -exports the -.Ev CITRUN_PATH -and -.Ev PATH -environment variables before calling the native build command. -.Pp -.Bl -tag -width Ds -.It Ev CITRUN_PATH -Points to a directory containing compiler named symlinks that all point to -.Xr citrun_instrument 1 . -.It Ev PATH -Is prepended with -.Ev CITRUN_PATH -so that binaries in that directory have the highest precedence. -.El -.Sh EXAMPLES -The following Makefile builds a simple target application named -.Qq program . -.Bd -literal -offset indent -PROG = program -SRCS = main.c - -\&.include <bsd.prog.mk> -.Ed -.Pp -To see -.Qq program -run, prepend -.Nm -to the native build command. In this case that build command is -.Qq make : -.Pp -.Dl $ citrun_wrap make -.Sh SEE ALSO -.Xr citrun_gl 1 , -.Xr citrun_instrument 1