diff options
Diffstat (limited to 'share')
-rw-r--r-- | share/man/just-profile.5.md | 63 | ||||
-rw-r--r-- | share/man/just.1.md | 3 |
2 files changed, 65 insertions, 1 deletions
diff --git a/share/man/just-profile.5.md b/share/man/just-profile.5.md new file mode 100644 index 00000000..fcce3748 --- /dev/null +++ b/share/man/just-profile.5.md @@ -0,0 +1,63 @@ +% JUST-PROFILE(5) | File Formats Manual + +NAME +==== + +just-profile - The format of profile files written by **`just-mr`**(1) and **`just`**(1) + +DESCRIPTION +=========== + +If profiling is enabled through the *`"invocation log`* key in in +the **`just-mrrc`**(5) file, **`just-mr`**(1) can be told to write +a metadata file, and the lauchned **`just`**(1) process to write a +profile file. Both files contain a single JSON object. + +Metadata file +-------------- + +The metadata file contains the following information. + +- For the key *`"cmdline"`* the argument vector for the process it + will **`execv`**(3) to. As with all launches by **`just-mr`**(1), + the programm is the zeroth entry of the argument vector. + +- For the key *`"configuration"`* the blob identifier of the + **`just-repository-config`**(5) that is passed to the launched process, + if such a config is passed. + +- For the key *`"time"`* the time of the invocation in seconds since + the epoch. + +Profile file +------------ + +The profile file contains the following information. + +- For the key *`"target"`* the target that was analysed/built/installed, as + full qualified name. + +- For the key *`"configuration"`* the build configuration in which the + target was analysed/built/installed. + +- For the key *`"exit code"`* the exit code of the **`just`**(1) process. + +- For the key *`"actions"`* an object. For each action that was looked at + in the build phase there is an entry, with the key being the action + identifier; the identifier is the same as in the **`just-graph-file`**(5) + that is written as a result of the `--dump-graph` option. The value is + an object with the following entries. + + - For the key *`"cached"`* a boolean indicatinng if the action was taken + from cache. + + - For the key *`"time"`* for non-cached actions the build time in seconds. + + +See also +======== + +**`just-mr-rc`**(5), +**`just-graph-file`**(5), +**`just-mr`**(1), +**`just`**(1) diff --git a/share/man/just.1.md b/share/man/just.1.md index 1ace1bd3..0d5d4fb0 100644 --- a/share/man/just.1.md +++ b/share/man/just.1.md @@ -435,7 +435,8 @@ CAS. Therefore, this option cannot be used with **`analyse`**. Supported by: build|install|rebuild|traverse. **`--profile`** *`PATH`* -Write a profile to the specified path. +Write a profile to the specified path. See **`just-profile`**(5) for +details on the format. Supported by: analyse|build|install|rebuild|traverse. **`--dump-graph`** *`PATH`* |