diff options
author | Paul Cristian Sarbu <paul.cristian.sarbu@huawei.com> | 2025-06-27 12:51:50 +0200 |
---|---|---|
committer | Klaus Aehlig <klaus.aehlig@huawei.com> | 2025-06-27 12:54:05 +0200 |
commit | d34e0afbcc3c9a533bc9555e9772cf2cad7dcb83 (patch) | |
tree | a43859422a5cdc81db2467ddf2108107cb60fdc9 /doc/concepts | |
parent | de7bdb452e7f600e5cb17d87710fb952f151ba29 (diff) | |
download | justbuild-d34e0afbcc3c9a533bc9555e9772cf2cad7dcb83.tar.gz |
doc: Fix various typos and inconsistencies
Diffstat (limited to 'doc/concepts')
-rw-r--r-- | doc/concepts/blob-splitting.md | 4 | ||||
-rw-r--r-- | doc/concepts/built-in-rules.md | 2 | ||||
-rw-r--r-- | doc/concepts/computed-roots.md | 4 | ||||
-rw-r--r-- | doc/concepts/expressions.md | 2 | ||||
-rw-r--r-- | doc/concepts/garbage.md | 4 | ||||
-rw-r--r-- | doc/concepts/profiling.md | 4 | ||||
-rw-r--r-- | doc/concepts/rules.md | 2 | ||||
-rw-r--r-- | doc/concepts/target-cache.md | 2 |
8 files changed, 12 insertions, 12 deletions
diff --git a/doc/concepts/blob-splitting.md b/doc/concepts/blob-splitting.md index 2c1529b1..d9b6e67f 100644 --- a/doc/concepts/blob-splitting.md +++ b/doc/concepts/blob-splitting.md @@ -75,7 +75,7 @@ to request the chunk digests of a blob from the server, to fetch only those chunks that are missing in its local CAS, and to store the fetched chunks as well as the reconstructed original blob in its local CAS. If the client requests to split a blob, but the server does not support -blob splitting or if an error occured during the request, the client +blob splitting or if an error occurred during the request, the client falls back to fetch the entire blob. Blob split procedure @@ -117,7 +117,7 @@ contains an error, the split operation failed and the client needs to fall back to fetch the entire blob. Otherwise, blob splitting was successful and the remote server returns an ordered list of `chunk_digests` and guarantees that the chunks are available in its CAS -and that the concatention of all chunks in the given order will result +and that the concatenation of all chunks in the given order will result in the requested blob. The client checks which chunks are available locally, fetches only the locally missing chunks from the remote side via the `BatchReadBlobs` rpc or the `ByteStream` API, and assembles the diff --git a/doc/concepts/built-in-rules.md b/doc/concepts/built-in-rules.md index 5c502668..18964299 100644 --- a/doc/concepts/built-in-rules.md +++ b/doc/concepts/built-in-rules.md @@ -95,7 +95,7 @@ by those resolution rules has to be free of semantic conflicts. The fields `"cmds"`, `"cwd"`, `"sh -c"`, `"out_dirs"`, `"outs"`, and `"env"` are evaluated fields where `"cmds"`, `"out_dirs"`, and `"outs"` -have to evaluate to a list of strings, `"sh -c"` has to evalute to +have to evaluate to a list of strings, `"sh -c"` has to evaluate to a list of strings or `null`, `"env"` has to evaluate to a map of strings, and `"cwd"` has to evaluate to a single string naming a non-upwards relative path. During their evaluation, the functions `"outs"` and diff --git a/doc/concepts/computed-roots.md b/doc/concepts/computed-roots.md index 7007eab4..2bc2094d 100644 --- a/doc/concepts/computed-roots.md +++ b/doc/concepts/computed-roots.md @@ -120,7 +120,7 @@ are equal if the defining roots are equal. When determining the value of a computed root, as for every export target, the provided serve endpoint (if any) is consulted first. Only if it is not aware of the root, a local evaluation is carried -out. This strategy is also applied for tree-stucture roots. +out. This strategy is also applied for tree-structure roots. ### `just-mr` support for computed roots @@ -149,7 +149,7 @@ however we do not want to fetch the artifacts of those intermediate roots. After all, whole point of the serve service was to use dependencies without having them locally. -#### Sytnax for absent computed roots +#### Syntax for absent computed roots As for other roots, we let the user specify which roots are to be absent. Tools like `just-import-git` will extend their marking of absent diff --git a/doc/concepts/expressions.md b/doc/concepts/expressions.md index 5d12d8d2..1367c10b 100644 --- a/doc/concepts/expressions.md +++ b/doc/concepts/expressions.md @@ -393,7 +393,7 @@ those) argument(s) to obtain the final result. key. Those paths relative to the subdir are taken in canonical form; it is an error if non-trivial conflicts arise that way, i.e., if two keys that are kept normalize to the same relative - path while the repsective values are different. + path while the respective values are different. ##### Binary functions diff --git a/doc/concepts/garbage.md b/doc/concepts/garbage.md index 278147bb..dc84e54d 100644 --- a/doc/concepts/garbage.md +++ b/doc/concepts/garbage.md @@ -133,7 +133,7 @@ CAS is inspected. If found there, then, in this order, - if the entry is not already in the youngest generation, the chunks are promoted to the youngest generation, -- the object itself is spliced on disk in a temproary file, +- the object itself is spliced on disk in a temporary file, - if the object is a tree, the parts are promoted to the youngest generation (only necessary if the large-object entry was not found in the youngest generation anyway), @@ -204,7 +204,7 @@ The compactification step is skipped if the `--all` option is given to `--no-rotate` and `--all` are incompatible options. -Gargabe Collection for Repository Roots +Garbage Collection for Repository Roots --------------------------------------- The multi-repository tool `just-mr` often has to create roots: the diff --git a/doc/concepts/profiling.md b/doc/concepts/profiling.md index 08bc04ef..ce33302a 100644 --- a/doc/concepts/profiling.md +++ b/doc/concepts/profiling.md @@ -75,7 +75,7 @@ output files are in a machine-readable format. Collection of build data, if desired, should be done routinely. For the build-sharing use case it is not known ahead of time, -which invocation will be the intersting one. Also, statistics over +which invocation will be the interesting one. Also, statistics over invocations are much more informative, if the data is complete (or at least sampled in an unbiased way). Therefore, the build-data collection should be configured in a configuration file. The @@ -109,7 +109,7 @@ more keys possibly added in the future). is a value derived not only from the command line but also from the context of a file (given via `-c`) possibly local on the machine `just` was run. - - The key `"remote"` describes the remote-exeuction endpoint, + - The key `"remote"` describes the remote-execution endpoint, including the used properties and dispatch list. This allow distinguishing builds in different environments (possibly using different hardware); this can be relevant both for performance diff --git a/doc/concepts/rules.md b/doc/concepts/rules.md index 2e09cb81..785e7009 100644 --- a/doc/concepts/rules.md +++ b/doc/concepts/rules.md @@ -193,7 +193,7 @@ following arguments. - `"cwd"` The directory inside the action root to change to before executing the command. The directory has to be given as a string - decribing a non-upwards relative path. This field is optional + describing a non-upwards relative path. This field is optional and defaults to `""`. - `"env"` The environment in which the command should be executed, diff --git a/doc/concepts/target-cache.md b/doc/concepts/target-cache.md index 4ebad03e..3d1547c6 100644 --- a/doc/concepts/target-cache.md +++ b/doc/concepts/target-cache.md @@ -235,7 +235,7 @@ choice would violate that projection property we rely upon. Consider the following target file (on a content-fixed root) as example. -``` +``` jsonc { "generated": {"type": "generic", "outs": ["out.txt"], "cmds": ["echo Hello > out.txt"]} , "export": {"type": "export", "target": "generated"} |