diff options
author | Oliver Reiche <oliver.reiche@huawei.com> | 2023-06-02 10:12:31 +0200 |
---|---|---|
committer | Oliver Reiche <oliver.reiche@huawei.com> | 2023-06-12 16:29:05 +0200 |
commit | ec1e9292a887dbb96668f75c1bc86f795ce1c780 (patch) | |
tree | 8ed17e43e16425c588057a321c1fd4b5f1c47d29 /doc/concepts | |
parent | b66a7359fbbff35af630c88c56598bbc06b393e1 (diff) | |
download | justbuild-ec1e9292a887dbb96668f75c1bc86f795ce1c780.tar.gz |
doc: Minor format and consistency improvements
Diffstat (limited to 'doc/concepts')
-rw-r--r-- | doc/concepts/anonymous-targets.md | 4 | ||||
-rw-r--r-- | doc/concepts/doc-strings.md | 30 | ||||
-rw-r--r-- | doc/concepts/expressions.md | 2 | ||||
-rw-r--r-- | doc/concepts/multi-repo.md | 2 |
4 files changed, 19 insertions, 19 deletions
diff --git a/doc/concepts/anonymous-targets.md b/doc/concepts/anonymous-targets.md index 6692d0ae..0c27f234 100644 --- a/doc/concepts/anonymous-targets.md +++ b/doc/concepts/anonymous-targets.md @@ -113,7 +113,7 @@ in the same way. Intensionally equal artifacts create equal action graphs; here we can confidently say "equal" and not only isomorphic: due to our preliminary clean up, even the node names are equal. Making sure that equal actions produce bit-by-bit equal outputs is the realm of -[reproducibe builds](https://reproducible-builds.org/). The tool can +[reproducible builds](https://reproducible-builds.org/). The tool can support this by appropriate sandboxing, etc, but the rules still have to define actions that don't pick up non-input information like the current time, user id, readdir order, etc. Files that are bit-by-bit @@ -293,7 +293,7 @@ map may now also have meaningful entries for the keys of the `"anonymous"` map. Each value in the map has to be itself a map, with entries `"target"`, `"provider"`, and `"rule_map"`. -For `"target"`, a single string has to be specifed, and the +For `"target"`, a single string has to be specified, and the value has to be a member of the `"target_fields"` list. For provider, a single string has to be specified as well. The idea is that the nodes are collected from that provider of the diff --git a/doc/concepts/doc-strings.md b/doc/concepts/doc-strings.md index a1a156ac..05de6c94 100644 --- a/doc/concepts/doc-strings.md +++ b/doc/concepts/doc-strings.md @@ -34,16 +34,16 @@ Rules Each rule is described as a JSON object with a fixed set of keys. So having fixed keys for documentation does not cause conflicts. More -precisely, the keys `doc`, `field doc`, `config_doc`, `artifacts_doc`, -`runfiles_doc`, and `provides_doc` are reserved for documentation. Here, -`doc` has to be a list of strings describing the rule in general. -`field doc` has to be a map from (some of) the field names to an array +precisely, the keys `"doc"`, `"field_doc"`, `"config_doc"`, `"artifacts_doc"`, +`"runfiles_doc"`, and `"provides_doc"` are reserved for documentation. Here, +`"doc"` has to be a list of strings describing the rule in general. +`"field_doc"` has to be a map from (some of) the field names to an array of strings, containing additional information on that particular field. -`config_doc` has to be a map from (some of) the config variables to an -array of strings describing the respective variable. `artifacts_doc` is +`"config_doc"` has to be a map from (some of) the config variables to an +array of strings describing the respective variable. `"artifacts_doc"` is an array of strings describing the artifacts produced by the rule. -`runfiles_doc` is an array of strings describing the runfiles produced -by this rule. Finally, `provides_doc` is a map describing (some of) the +`"runfiles_doc"` is an array of strings describing the runfiles produced +by this rule. Finally, `"provides_doc"` is a map describing (some of) the providers by that rule; as opposed to fields or config variables there is no authoritative list of providers given elsewhere in the rule, so it is up to the rule author to give an accurate documentation on the @@ -115,9 +115,9 @@ Expressions ----------- Expressions are also described by a JSON object with a fixed set of -keys. Here we use the keys `doc` and `vars_doc` for documentation, where -`doc` is an array of strings describing the expression as a whole and -`vars_doc` is a map from (some of) the `vars` to an array of strings +keys. Here we use the keys `"doc"` and `"vars_doc"` for documentation, where +`"doc"` is an array of strings describing the expression as a whole and +`"vars_doc"` is a map from (some of) the `"vars"` to an array of strings describing this variable. Export targets @@ -126,9 +126,9 @@ Export targets As export targets play the role of interfaces between repositories, it is important that they be documented as well. Again, export targets are described as a JSON object with fixed set of keys amd we use the keys -`doc` and `config_doc` for documentation. Here `doc` is an array of -strings describing the targeted in general and `config_doc` is a map -from (some of) the variables of the `flexible_config` to an array of +`"doc"` and `"config_doc"` for documentation. Here `"doc"` is an array of +strings describing the targeted in general and `"config_doc"` is a map +from (some of) the variables of the `"flexible_config"` to an array of strings describing this parameter. Presentation of the documentation @@ -145,7 +145,7 @@ human-readable form - the documentation for the rule - all the fields available for that rule together with - - their type (`string_field`, `target_field`, etc), and + - their type (`"string_fields"`, `"target_fields"`, etc), and - their documentation, - all the configuration variables of the rule with their documentation (if given), and diff --git a/doc/concepts/expressions.md b/doc/concepts/expressions.md index 9e8a8f36..b6aa0945 100644 --- a/doc/concepts/expressions.md +++ b/doc/concepts/expressions.md @@ -44,7 +44,7 @@ mechanism; the precise evaluation is as follows. themselves. - For lists, each entry is evaluated in the order they occur in the list; the result of the evaluation is the list of the results. - - For JSON objects (wich can be understood as maps, or dicts), the key + - For JSON objects (which can be understood as maps, or dicts), the key `"type"` has to be present and has to be a literal string. That string determines the syntactical construct (sloppily also referred to as "function") the object represents, and the remaining diff --git a/doc/concepts/multi-repo.md b/doc/concepts/multi-repo.md index c465360e..e4dd1bd6 100644 --- a/doc/concepts/multi-repo.md +++ b/doc/concepts/multi-repo.md @@ -21,7 +21,7 @@ optional and the default is that the repository worked on has no external dependencies. Typically (but not necessarily), this repository-configuration file is located outside the referenced repositories and versioned separately or generated from such a file via -`bin/just-mr.py`. It serves as meta-data for a group of repositories +`just-mr`. It serves as meta-data for a group of repositories belonging together. This file contains one JSON object. For the key `"repositories"` the |