citrun

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

commit 374d59eb1e675e7eaeaf9fba7c67774c338df091
parent 86c72ec9d09be57ecca5ea99d3cc12bd3df8ad98
Author: Kyle Milz <kyle@getaddrinfo.net>
Date:   Sun, 10 Apr 2016 13:53:03 -0600

man: make instrument more clear

Diffstat:
Msrc/citrun_instrument.1 | 20+++++++++++---------
1 file changed, 11 insertions(+), 9 deletions(-)

diff --git a/src/citrun_instrument.1 b/src/citrun_instrument.1 @@ -6,20 +6,22 @@ .Nd modify command line and instrument source .Sh DESCRIPTION .Nm -is not meant to be invoked directly. Rather it is meant to be called from -compiler named symlinks that are put on the PATH by -.Xr citrun_wrap 1 . -This hook allows +will not function correctly when invoked directly. +.Pp +Instead .Nm -to run before the native compiler command, reading and modifying arguments it -chooses. +is called from compiler named symlinks put on the +PATH by +.Xr citrun_wrap 1 . +This makes adding instrumentation nearly transparent to the native build system +with no special modifications necessary. .Pp Instrumentation will be attempted on any source files found on the command line. When instrumentation is successful original source file paths are switched with -instrumented ones and then compilation takes place. +instrumented ones and then native compilation takes place. .Pp -When application link attempts are detected flags for the runtime are appended -to the command line. +When application link commands are detected flags for the citrun runtime are +automatically added. .Sh ENVIRONMENT .Bl -tag -width Ds .It Ev CITRUN_PATH