summaryrefslogtreecommitdiff
path: root/doc/tutorial
diff options
context:
space:
mode:
authorKlaus Aehlig <klaus.aehlig@huawei.com>2025-04-14 12:55:12 +0200
committerKlaus Aehlig <klaus.aehlig@huawei.com>2025-04-14 13:02:45 +0200
commit629df017d74734e93e2b63a1bb4b7819a34a1c9f (patch)
tree3c16b58c162a08b3ffda718aa183e2e42442aa6d /doc/tutorial
parentc7216ce1da69f3fdbd2e577113c0a15a7dd41130 (diff)
downloadjustbuild-629df017d74734e93e2b63a1bb4b7819a34a1c9f.tar.gz
clean up markdown in tutorial and concepts
... and ensure that pandoc processes them correctly. In particular, add an empty line around itemize environments.
Diffstat (limited to 'doc/tutorial')
-rw-r--r--doc/tutorial/computed.md1
-rw-r--r--doc/tutorial/lint.md2
2 files changed, 3 insertions, 0 deletions
diff --git a/doc/tutorial/computed.md b/doc/tutorial/computed.md
index 0ca6065d..ee9e94d8 100644
--- a/doc/tutorial/computed.md
+++ b/doc/tutorial/computed.md
@@ -177,6 +177,7 @@ INFO: Backing up artifacts of 1 export targets
```
From that, we can, step by step, define the actual build description.
+
- The tasks to generate the target files is a computed root of the
`"src target tasks"` using the top-level target `["", ""]`. We
call it `"src target tasks"`.
diff --git a/doc/tutorial/lint.md b/doc/tutorial/lint.md
index 7b488405..f7d99787 100644
--- a/doc/tutorial/lint.md
+++ b/doc/tutorial/lint.md
@@ -149,8 +149,10 @@ know the correct defines to be used.
Of course, those abstract nodes are just an implementation detail
and there is a rule to define linting for the collected sources.
It takes two programs (targets consisting of a single artifact),
+
- the `linter` for running the lint task on a single file, and
- the `summarizer` for summarizing the lint results;
+
additionally, arbitrary `config` data can be given to have config
files available, but also to use a linter built from source.