diff options
author | Paul Cristian Sarbu <paul.cristian.sarbu@huawei.com> | 2023-02-27 12:39:51 +0100 |
---|---|---|
committer | Klaus Aehlig <klaus.aehlig@huawei.com> | 2023-02-28 14:59:38 +0100 |
commit | b9dec99ab48f95adbc27a6d12184fe2203c2c673 (patch) | |
tree | 41f53a990188f44d7e19beb0c8c3f468705ccadf /doc | |
parent | 6d28e7e77bafe30b6a30289d2755ca0bf49636bc (diff) | |
download | justbuild-b9dec99ab48f95adbc27a6d12184fe2203c2c673.tar.gz |
Various typo fixes
Co-authored-by: Sascha Roloff <sascha.roloff@huawei.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/concepts/doc-strings.org | 2 | ||||
-rw-r--r-- | doc/concepts/expressions.org | 4 | ||||
-rw-r--r-- | doc/future-designs/computed-roots.org | 6 | ||||
-rw-r--r-- | doc/future-designs/service-target-cache.org | 4 | ||||
-rw-r--r-- | doc/tutorial/rebuild.org | 2 | ||||
-rw-r--r-- | doc/tutorial/target-file-glob-tree.org | 2 |
6 files changed, 10 insertions, 10 deletions
diff --git a/doc/concepts/doc-strings.org b/doc/concepts/doc-strings.org index e82cef2b..d9a94dc5 100644 --- a/doc/concepts/doc-strings.org +++ b/doc/concepts/doc-strings.org @@ -100,7 +100,7 @@ documentation on the provided data. ] , "link-args": [ "List of strings that have to be added to the command line for linking actions" - , "in targets depending on on this library" + , "in targets depending on this library" ] } , "expression": { ... } diff --git a/doc/concepts/expressions.org b/doc/concepts/expressions.org index 2d10d9ff..ac66e878 100644 --- a/doc/concepts/expressions.org +++ b/doc/concepts/expressions.org @@ -37,9 +37,9 @@ mechanism; the precise evaluation is as follows. - Atomic values (~null~, booleans, strings, numbers) evaluate to themselves. - For lists, each entry is evaluated in the order they occur in the - list; the result of the valuation is the list of the results. + 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 ~"type"~ has be be present and has to be a literal string. + 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 evaluation depends on the syntactical construct. The syntactical diff --git a/doc/future-designs/computed-roots.org b/doc/future-designs/computed-roots.org index d3c355ce..a83eee67 100644 --- a/doc/future-designs/computed-roots.org +++ b/doc/future-designs/computed-roots.org @@ -60,7 +60,7 @@ file, so that it can be used during analysis. Still, the information is already present in the prebuilt binary, causing unnecessary maintenance overhead; instead, the target file could be a function of that library which can form its own content-fixed root (e.g., a -~git tree~ root), so that the computed value is easily cachable. +~git tree~ root), so that the computed value is easily cacheable. *** Simplified rule definition and alternative syntax @@ -78,14 +78,14 @@ but people argue that it is hard to write by hand. However, it is unlikely to get agreement on which syntax is best to use. Now, if rule and expression files could be generated, this argument would not be necessary. Moreover, rules are typically versioned and -unfrequently changed, so the step of generating the official syntax +infrequently changed, so the step of generating the official syntax from the convenient one would typically be in cache. ** Proposal: Support computed roots We propose computed roots as a clean principle to add the needed (and a lot more) flexibility for the described use cases, while ensuring -that all computations of roots are properly cachable at high level. +that all computations of roots are properly cacheable at high level. In this way, we do not compromise efficient builds, as the price of the additional flexibility, in the typical case, is just a single cache lookup. Of course, it is up to the user to ensure that this diff --git a/doc/future-designs/service-target-cache.org b/doc/future-designs/service-target-cache.org index 9f07351d..10138db5 100644 --- a/doc/future-designs/service-target-cache.org +++ b/doc/future-designs/service-target-cache.org @@ -158,7 +158,7 @@ serve~ endpoint has to be specified in the invocation of ~just~. **** ~just-mr~ pragma ~"absent"~ -For ~just-mr~ to know how to contruct the repository description, +For ~just-mr~ to know how to construct the repository description, the description used by ~just-mr~ is extended. More precisely, a new key ~"absent"~ is allowed in the ~"pragma"~ dictionary of a repository description. If the specified value is true, ~just-mr~ @@ -196,7 +196,7 @@ Such a repository is given by - a command that, when executed in an empty directory (anywhere in the file system) will create in that directory a directory structure containing the specified ~git~ tree (either top-level - or in some sudirectory). Moreover, that command does not modify + or in some subdirectory). Moreover, that command does not modify anything outside the directory it is called in; it is an error if the specified tree is not created in this way. In this way, content-fixed repositories can be generated in a diff --git a/doc/tutorial/rebuild.org b/doc/tutorial/rebuild.org index 115aff10..80aafb6f 100644 --- a/doc/tutorial/rebuild.org +++ b/doc/tutorial/rebuild.org @@ -206,7 +206,7 @@ non-reproducibility, however, more modifications of the environment are necessary. A simple, but effective, way for modifying the build environment -is the option ~-L~ to the set the local launcher, a list of +is the option ~-L~ to set the local launcher, a list of strings the argument vector is prefixed with before the action is executed. The default ~["env", "--"]~ simply resolves the program to be executed in the current value of ~PATH~, but a different diff --git a/doc/tutorial/target-file-glob-tree.org b/doc/tutorial/target-file-glob-tree.org index d1d29a72..84e6465b 100644 --- a/doc/tutorial/target-file-glob-tree.org +++ b/doc/tutorial/target-file-glob-tree.org @@ -252,7 +252,7 @@ to understand this in detail and the rational behind it. contains the unpatched source file ~definitions.units~. In this way, we avoid any surprises in the expansion of a glob when a new source file is added with a name equal to an already existing target. -- Only files are are considered for matching the glob. Directories +- Only files are considered for matching the glob. Directories are ignored. - Matches are only considered at the top-level directory. In this way, only one directory has to be read during analysis; allowing |