summaryrefslogtreecommitdiff
path: root/doc/tutorial
diff options
context:
space:
mode:
authorPaul Cristian Sarbu <paul.cristian.sarbu@huawei.com>2025-06-27 12:51:50 +0200
committerKlaus Aehlig <klaus.aehlig@huawei.com>2025-06-27 12:54:05 +0200
commitd34e0afbcc3c9a533bc9555e9772cf2cad7dcb83 (patch)
treea43859422a5cdc81db2467ddf2108107cb60fdc9 /doc/tutorial
parentde7bdb452e7f600e5cb17d87710fb952f151ba29 (diff)
downloadjustbuild-d34e0afbcc3c9a533bc9555e9772cf2cad7dcb83.tar.gz
doc: Fix various typos and inconsistencies
Diffstat (limited to 'doc/tutorial')
-rw-r--r--doc/tutorial/build-delegation.md4
-rw-r--r--doc/tutorial/computed.md12
-rw-r--r--doc/tutorial/hello-world.md2
-rw-r--r--doc/tutorial/lint.md2
-rw-r--r--doc/tutorial/tests.md10
5 files changed, 15 insertions, 15 deletions
diff --git a/doc/tutorial/build-delegation.md b/doc/tutorial/build-delegation.md
index 5d597d9e..a8c01ff9 100644
--- a/doc/tutorial/build-delegation.md
+++ b/doc/tutorial/build-delegation.md
@@ -32,7 +32,7 @@ distributes the tree hash to the entities analysing the data.
As a user of the serve endpoint, by just knowing the tree hash,
can construct an absent root from it.
-```
+``` jsonc
{ "repository":
{ "type": "git tree"
, "id": "..."
@@ -72,7 +72,7 @@ only access export targets; but while measurement data might have
some random component, analysing that data typically is a pure
function. So a simple target file could look as follows.
-```
+``` jsonc
{ "": {"type": "export", "target": "stats"}
, "stats":
{ "type": "generic"
diff --git a/doc/tutorial/computed.md b/doc/tutorial/computed.md
index df455e93..ca1a6845 100644
--- a/doc/tutorial/computed.md
+++ b/doc/tutorial/computed.md
@@ -4,10 +4,10 @@ The general approach of writing a build description side-by-side with
the source code works in most cases. There are, however, cases where
the build description depends on the contents of source-like files.
-Here we consider a somewhat contrieved example that, however, shows
+Here we consider a somewhat contrived example that, however, shows
all the various types of derived roots. Let's say we have a very
regular structure of our code base: one top-level directory for
-each library and if there are depenedencies, then there is a plain
+each library and if there are dependencies, then there is a plain
file `deps` listing, one entry per line, the libraries depended
upon. From that structure we want a derived build description that
is not maintained manually.
@@ -30,7 +30,7 @@ The first step is to write a generator for a single `TARGETS` file. To clearly
separate the infrastructure files from the sources, we add the generator as
`utils/generate.py`.
-```{.py srcname="utils/generate.py"}
+```{.python srcname="utils/generate.py"}
#!/usr/bin/env python3
import json
@@ -64,7 +64,7 @@ files (and not just other directories). Additionally, there needs to be
a top-level target staging all those files that is exported. This can
be implemented by another script, say `utils/call-generator-targets.py`.
-```{.py srcname="utils/call-generator-targets.py"}
+```{.python srcname="utils/call-generator-targets.py"}
#!/usr/bin/env python3
import json
@@ -117,7 +117,7 @@ the target files. We first write a target file `utils/targets.generate`.
```
As we intend to make `utils` a separate logical repository, we also
-add a trival top-level targets file.
+add a trivial top-level targets file.
```shell
$ echo {} > utils/TARGETS
@@ -339,7 +339,7 @@ INFO: Target tainted ["test"].
```
Obviously, the tree structure has changed, so `"src target tasks
-decription"` target gets rebuild. Also, the `"src target build"`
+description"` target gets rebuild. Also, the `"src target build"`
target gets rebuild, but if we inspect the log, we see that 2 out
of 3 actions are taken from cache.
diff --git a/doc/tutorial/hello-world.md b/doc/tutorial/hello-world.md
index 25645c73..fc7ff35b 100644
--- a/doc/tutorial/hello-world.md
+++ b/doc/tutorial/hello-world.md
@@ -430,7 +430,7 @@ INFO: Artifacts built, logical paths are:
$
```
-The ommitted (i.e., not shown but still built) runfile is the header file. As
+The omitted (i.e., not shown but still built) runfile is the header file. As
mentioned in the introduction to `just analyse` this is a typical use of that
second artifact arrangement. We can also have a look at the other information
that library provides.
diff --git a/doc/tutorial/lint.md b/doc/tutorial/lint.md
index 6005c5d1..f187405e 100644
--- a/doc/tutorial/lint.md
+++ b/doc/tutorial/lint.md
@@ -245,7 +245,7 @@ passed and for the failed tests we format stdout and stderr in some
easy-to-read way; additionally, we also provide a machine-readable
summary of the failures.
-``` {.py srcname="summary.py"}
+``` {.python srcname="summary.py"}
#!/usr/bin/env python3
import json
diff --git a/doc/tutorial/tests.md b/doc/tutorial/tests.md
index d4614801..5e6f82a7 100644
--- a/doc/tutorial/tests.md
+++ b/doc/tutorial/tests.md
@@ -119,18 +119,18 @@ INFO: Setup finished, exec ["just","describe","-C","...","tests","greet"]
- "name"
| The name of the test
...
- - implict dependency
+ - implicit dependency
| The C/C++ toolchain to use
- ["@","rules-cc","CC","defaults"]
- - implict dependency
+ - implicit dependency
| The test runner which starts the actual test binary after providing
| the respective environment. The runner also takes care of capturing
| stdout/stderr and timing information.
- ["@","rules-cc","CC/test","runner"]
- - implict dependency
+ - implicit dependency
| The shell toolchain to use PATH from for calling the summary action
- ["@","rules-cc","shell","defaults"]
- - implict dependency
+ - implicit dependency
| Tool to aggregate the results of individual test runs (for flakyness
| detection) to an overall test result. If more fields than the result
| itself is needed, those can be specified using the "summarizer" rule.
@@ -493,4 +493,4 @@ $
As the output structure is again one tree per test, test suits can
be put into other test suites; to avoid conflicts, the `"stage"`
field of the test suite can be used to put all outputs into a
-suite-specific sudirectory.
+suite-specific subdirectory.