X-Git-Url: http://nitlanguage.org diff --git a/share/man/nitc.md b/share/man/nitc.md index 77c8aa8..eff6232 100644 --- a/share/man/nitc.md +++ b/share/man/nitc.md @@ -7,6 +7,8 @@ nitc - compiles Nit programs. nitc [*options*] FILE... +nitc [*options*] --run FILE [ARG]... + # DESCRIPTION @@ -36,7 +38,7 @@ To combine files into a single program, use the `-m` option. $ nitc prog1.nit -m other_module.nit nitc can produces executables for various platforms when specific modules are used. -Currently, android, pnacl and emscripten are supported. +Currently, android and emscripten are supported. See the documentation of these specific modules for details. @@ -163,6 +165,21 @@ Has precedence over the environment variable `NIT_DIR`. ## COMPILATION +### `--run` +Execute the binary after the compilation. + +The binary is generated as expected then it is executed directly. +After the execution, the binary is not removed. + +When `--run` is used, the first argument is the program to compile, the rest of the arguments are the arguments of the program. +Note that you MUST use `--` before the program arguments if one of them is an option starting with a `-`. + +~~~bash +$ nitc --run foo.nit arg # compile foo.nit, then executes `./foo arg` +$ nitc --run foo.nit arg -W # compile foo.nit with warnings, then executes `./foo arg` +$ nitc --run foo.nit -- arg -W # compile foo.nit, then executes `./foo arg -W` +~~~ + ### `--compile-dir` Directory used to generate temporary files. @@ -229,6 +246,29 @@ Also preserves the source-files directory for C-debuggers. For more debugging-related options, see also `--hardening` and `NIT_GC_OPTION` +### `--trace` +Compile with lttng's instrumentation. + +Currently add a lttng trace provider and add tracepoint into object instances and destructions. + +The lttng nit/misc/Nit_Compiler.lttng file is a template that you can use instead of configure channels by yourself. You have to configure the path of the destination tracefile. "your path" + +To create a channel with template : + lttng-sessiond --daemonize + lttng load -i=~/nit/misc/Nit_Compiler.lttng Nit_Compiler +To create a channel without template : + lttng create session_name + lttng enable-event --userspace Nit_Compiler:Object_Instance + lttng enable-event --userspace Nit_Compiler:Object_Destroy +To record some traces : + lttng start + --> run your program + lttng stop +To read some traces : + babeltrace ~/session_name +To destroy your current tracing session : + lttng destroy + ## COMPILATION MODES ### `nitc` includes distinct compilation modes.