summaryrefslogtreecommitdiff
path: root/doc/tutorial
diff options
context:
space:
mode:
authorPaul Cristian Sarbu <paul.cristian.sarbu@huawei.com>2024-04-12 17:54:11 +0200
committerPaul Cristian Sarbu <paul.cristian.sarbu@huawei.com>2024-04-15 18:05:12 +0200
commit4e2430a102542720337834458d8f20a0f81167db (patch)
tree738d26910bdaff2f474a8b4b74fcf2fe523f8d90 /doc/tutorial
parent0a2a440f0421134f1f741a74c88087a9951462bc (diff)
downloadjustbuild-4e2430a102542720337834458d8f20a0f81167db.tar.gz
tutorial: Consistent formatting and small fixes
Diffstat (limited to 'doc/tutorial')
-rw-r--r--doc/tutorial/cross-compiling.md4
-rw-r--r--doc/tutorial/getting-started.md2
-rw-r--r--doc/tutorial/tests.md8
-rw-r--r--doc/tutorial/third-party-software.md18
4 files changed, 16 insertions, 16 deletions
diff --git a/doc/tutorial/cross-compiling.md b/doc/tutorial/cross-compiling.md
index 60bdd3c5..35946a9b 100644
--- a/doc/tutorial/cross-compiling.md
+++ b/doc/tutorial/cross-compiling.md
@@ -193,7 +193,7 @@ binary, we need to do two things.
- We need to setup remote execution on the correct architecture,
either by buying the appropriate hardware, or by running an emulator.
-- We need to tell `justbuild` on how to reach that endpoint.
+- We need to tell *justbuild* on how to reach that endpoint.
To continue the example, let's say we set up an `arm64` machine,
e.g., a Raspberry Pi, in the local network. On that machine, we can
@@ -201,7 +201,7 @@ simply run a single-node execution service using `just execute`;
note that the `just` binary used there has to be an `arm64` binary,
e.g., obtained by cross compiling.
-The next step is to tell `justbuild` how to reach that machine;
+The next step is to tell *justbuild* how to reach that machine;
as we only want to use it for certain actions we can't simply
set it as (default) remote-execution endpoint (specified by the
`-r` option). Instead we crate a file `dispatch.json`.
diff --git a/doc/tutorial/getting-started.md b/doc/tutorial/getting-started.md
index e2dbbd4d..0ec1c28a 100644
--- a/doc/tutorial/getting-started.md
+++ b/doc/tutorial/getting-started.md
@@ -1,7 +1,7 @@
Getting Started
===============
-In order to use *Justbuild*, first make sure that `just`, `just-mr`, and
+In order to use *justbuild*, first make sure that `just`, `just-mr`, and
`just-import-git` are available in your `PATH`.
Creating a new project
diff --git a/doc/tutorial/tests.md b/doc/tutorial/tests.md
index 51f38964..648d35c7 100644
--- a/doc/tutorial/tests.md
+++ b/doc/tutorial/tests.md
@@ -1,7 +1,7 @@
Creating Tests
==============
-To run tests with justbuild, we do *not* have a dedicated `test`
+To run tests with *justbuild*, we do **not** have a dedicated `test`
subcommand. Instead, we consider tests being a specific action that
generates a test report. Consequently, we use the `build` subcommand to
build the test report, and thereby run the test action. Test actions,
@@ -141,13 +141,13 @@ Note that the target is correctly reported as tainted with `"test"`. It
will produce 3 additional actions for compiling, linking and running the
test binary.
-The result of the test target are 5 artifacts: `result` (containing
+The result of the test target is formed of 5 artifacts: `result` (containing
`UNKNOWN`, `PASS`, or `FAIL`), `stderr`, `stdout`, `time-start`, and
`time-stop`, and a single runfile (omitted in the output above), which
is a tree artifact with the name `test_greet` that contains all of the
above artifacts. The test was run successfully as otherwise all reported
artifacts would have been reported as `FAILED` in the output, and
-justbuild would have returned the exit code `2`.
+*justbuild* would have returned the exit code `2`.
To immediately print the standard output produced by the test binary on
the command line, the `-P` option can be used. Argument to this option
@@ -163,7 +163,7 @@ greet output: Hello Universe!
$
```
-Note that `--log-limit 1` was just added to omit justbuild's `INFO:`
+Note that `--log-limit 1` was just added to omit *justbuild*'s `INFO:`
prints.
Our test binary does not have any useful options for directly
diff --git a/doc/tutorial/third-party-software.md b/doc/tutorial/third-party-software.md
index 6c87d08b..38909ca4 100644
--- a/doc/tutorial/third-party-software.md
+++ b/doc/tutorial/third-party-software.md
@@ -2,15 +2,15 @@ Building Third-party Software
=============================
Third-party projects usually ship with their own build description,
-which often happens to be not compatible with justbuild. Nevertheless,
-it often is desireable to include external projects via their source
+which often happens to not be compatible with *justbuild*. Nevertheless,
+it is often desireable to include external projects via their source
code base, instead of relying on the integration of out-of-band binary
-distributions. justbuild offers a flexible approach to provide the
+distributions. *justbuild* offers a flexible approach to provide the
required build description via an overlay layer without the need to
touch the original code base. This mechanism is independent of the
-actual justbuild description eventually used and the latter might
+actual *justbuild* description eventually used, and the latter might
well be a
-[rule calling the foreign buildsystem](https://github.com/just-buildsystem/rules-cc#rule-ccforeigncmake-library).
+[rule calling a foreign buildsystem](https://github.com/just-buildsystem/rules-cc#rule-ccforeigncmake-library).
In this section, however, we describe the cleaner approach of providing
a native build description.
@@ -18,7 +18,7 @@ For the remainder of this section, we expect to have the project files
available resulting from successfully completing the tutorial section on
*Building C++ Hello World*. We will demonstrate how to use the
open-source project [fmtlib](https://github.com/fmtlib/fmt) as an
-example for integrating third-party software to a justbuild project.
+example for integrating third-party software to a *justbuild* project.
Creating the target overlay layer for fmtlib
--------------------------------------------
@@ -171,7 +171,7 @@ additional binding `"format"` for it:
}
```
-This `"format"` binding can you be used to add a new private dependency
+This `"format"` binding can be used to add a new private dependency
in `greet/TARGETS`:
``` {.jsonc srcname="greet/TARGETS"}
@@ -214,8 +214,8 @@ INFO: Artifacts built, logical paths are:
$
```
-Note to build the `fmt` target alone, its containing repository `fmtlib`
-must be specified via the `--main` option:
+Note that in order to build the `fmt` target alone, its containing
+repository `fmtlib` must be specified via the `--main` option:
``` sh
$ just-mr --main fmtlib build fmt