summaryrefslogtreecommitdiff
path: root/share/man/just-profile.5.md
diff options
context:
space:
mode:
authorKlaus Aehlig <klaus.aehlig@huawei.com>2025-05-07 10:22:39 +0200
committerKlaus Aehlig <klaus.aehlig@huawei.com>2025-05-07 12:25:56 +0200
commit9ff01a766d98359c7dcf199aa6c4fba7fb427140 (patch)
treeeef791d08966568a36b1aa138eb2041c7a91a2f4 /share/man/just-profile.5.md
parent520bb21a4a0887478dffbcc83997a4015f7e67a4 (diff)
downloadjustbuild-9ff01a766d98359c7dcf199aa6c4fba7fb427140.tar.gz
profile: include remote-execution properties
Include in the profile also the effective remote-execution endpoint, properties, and dispatch list. Software projects are often tested in a variety of environments or hardware configurations; as, obviously, the performance might differ significantly (especially depending on the used hardware) a proper analysis therefore requires the possibility to distinguish the various backends. Adding the effective configuration adds this posibility.
Diffstat (limited to 'share/man/just-profile.5.md')
-rw-r--r--share/man/just-profile.5.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/share/man/just-profile.5.md b/share/man/just-profile.5.md
index 991472cb..b8efb16c 100644
--- a/share/man/just-profile.5.md
+++ b/share/man/just-profile.5.md
@@ -45,6 +45,19 @@ The profile file contains the following information.
- For the key *`"configuration"`* the build configuration in which the
target was analysed/built/installed.
+- For the key *`"remote"`* an object describing the remote-execution
+ configuration. The following keys are used.
+
+ - If a remote-execution endpoint is used, for the key *`"address"`*,
+ a string of the form `address:port` is given.
+
+ - For the key *`"properties"`* the remote-execution properties are
+ specified (naturally as an object).
+
+ - For the key *`"dispatch"`* the dispatch list is given as an array
+ of pairs (arrays of length two) of a property map and an enpoint
+ as `address:port` string.
+
- For the key *`"exit code"`* the exit code of the **`just`**(1) process.
- For the key *`"analysis errors"`*, if present, a list of error messages