From ec1e9292a887dbb96668f75c1bc86f795ce1c780 Mon Sep 17 00:00:00 2001
From: Oliver Reiche <oliver.reiche@huawei.com>
Date: Fri, 2 Jun 2023 10:12:31 +0200
Subject: doc: Minor format and consistency improvements

---
 doc/tutorial/getting-started.md      |  4 ++--
 doc/tutorial/hello-world.md          |  2 +-
 doc/tutorial/just-execute.org        | 41 +++++++++++++++++++-----------------
 doc/tutorial/tests.md                |  2 +-
 doc/tutorial/third-party-software.md |  2 ++
 5 files changed, 28 insertions(+), 23 deletions(-)

(limited to 'doc/tutorial')

diff --git a/doc/tutorial/getting-started.md b/doc/tutorial/getting-started.md
index 36a57d26..e2dbbd4d 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
@@ -101,7 +101,7 @@ this can be used for both, interactively reading a text file, as well as
 for piping the artifact to another program.
 
 ``` sh
-$ just build greeter -Pout.txt
+$ just build greeter -P out.txt
 INFO: Requested target is [["@","","","greeter"],{}]
 INFO: Analysed target [["@","","","greeter"],{}]
 INFO: Export targets found: 0 cached, 0 uncached, 0 not eligible for caching
diff --git a/doc/tutorial/hello-world.md b/doc/tutorial/hello-world.md
index 9af68f07..54ed7d72 100644
--- a/doc/tutorial/hello-world.md
+++ b/doc/tutorial/hello-world.md
@@ -115,7 +115,7 @@ command line:
 ``` sh
 $ just-mr build helloworld
 INFO: Requested target is [["@","tutorial","","helloworld"],{}]
-INFO: Analysed target [["@","tutorial","",helloworld"],{}]
+INFO: Analysed target [["@","tutorial","","helloworld"],{}]
 INFO: Export targets found: 0 cached, 0 uncached, 0 not eligible for caching
 INFO: Discovered 2 actions, 1 trees, 0 blobs
 INFO: Building [["@","helloworld","","helloworld"],{}].
diff --git a/doc/tutorial/just-execute.org b/doc/tutorial/just-execute.org
index 5605dcd8..f43cb202 100644
--- a/doc/tutorial/just-execute.org
+++ b/doc/tutorial/just-execute.org
@@ -16,17 +16,18 @@ certainly not limited to)
 
 For the sake of completeness, these are the files used to compile the
 examples
-#+BEGIN_SRC bash
-$ tree latex-hello-world/
+#+BEGIN_SRC
 latex-hello-world/
-├── hello.tex
-├── repos.json
-└── TARGETS
++--hello.tex
++--repos.json
++--TARGETS
 #+END_SRC
 
 They read as follows
-#+BEGIN_SRC bash
-$ cat repos.json
+
+File ~repos.json~:
+#+SRCNAME: repos.json
+#+BEGIN_SRC js
 { "main": "tutorial"
 , "repositories":
   { "latex-rules":
@@ -45,8 +46,9 @@ $ cat repos.json
 }
 #+END_SRC
 
-#+BEGIN_SRC bash
-$ cat TARGETS
+File ~TARGETS~:
+#+SRCNAME: TARGETS
+#+BEGIN_SRC js
 { "tutorial":
   { "type": ["@", "latex-rules", "latex", "latexmk"]
   , "main": ["hello"]
@@ -55,8 +57,9 @@ $ cat TARGETS
 }
 #+END_SRC
 
-#+BEGIN_SRC bash
-$ cat hello.tex
+File ~hello.tex~:
+#+SRCNAME: hello.tex
+#+BEGIN_SRC tex
 \documentclass[a4paper]{article}
 
 \author{JustBuild developers}
@@ -76,7 +79,7 @@ In this first example, we simply call ~just execute~ and the
 environment of the caller is made available. We therefore recommend to
 have a dedicated non-priviledged ~build~ user to run the execution
 service. In the following, we will use ~%~ to indicate the prompt of
-the ~build~ user, ~$~ for a _normal_user_.
+the ~build~ user, ~$~ for a /normal/ user.
 
 To enable such a single-node execution service, it is sufficient to
 type on one shell (as ~build~ user)
@@ -85,7 +88,7 @@ type on one shell (as ~build~ user)
 #+END_SRC
 Where ~<N>~ is a port number which is supposed to be available.
 
-To use it, as a _normal_ user, on a different shell type
+To use it, as a /normal/ user, on a different shell type
 #+BEGIN_SRC bash
 $ just [...] -r localhost:<N> 
 #+END_SRC
@@ -148,7 +151,7 @@ $ cat /tmp/foo.json
 {"interface":"127.0.0.1","pid":7680,"port":44115}
 #+END_SRC
 
-Please note that the info file will _not be automatically deleted_
+Please note that the info file will /not be automatically deleted/
 when the user terminates the service. The user is responsible for
 eventually removing it from the file system.
 
@@ -171,7 +174,7 @@ $ just [...] --tls-ca-cert <path_to_CA_cert> --tls-client-cert <path_to_client_c
 
 ***** How to generate self-signed certificates
 
-This section does not pretend to be an exaustive guide to the
+This section does not pretend to be an exhaustive guide to the
 generation and management of certificates, which is well beyond the
 aim of this tutorial. We just want to provide a minimal reference for
 let users start using mTLS and having the benefits of mutual
@@ -188,7 +191,7 @@ As a first step, we need a Certification Authority certificate (~ca.crt~)
 
 If the clients will connect using the loopback device, i.e., the users
 are logged in the same machine where ~just execute~ will run, the
-_server certificates_ can be generate with the following instructions
+/server certificates/ can be generate with the following instructions
 #+BEGIN_SRC bash
 % openssl req -new -nodes -newkey rsa:4096 -keyout server.key -out server.csr -subj "/CN=localhost"
 % openssl x509 -req -days 365 -in server.csr -CA ca.crt -CAkey ca.key -set_serial 0 -out server.crt
@@ -409,7 +412,7 @@ $ docker run --network host --name execute-latex --mount type=bind,source="${HOM
 *** Compile statically
 
 Since ~just~ and ~just-mr~ must also be available in the host
-environment, the best way to have ~just~ inside the enviroment is to
+environment, the best way to have ~just~ inside the environment is to
 compile a static binary, and copy it into the chroot environment.
 
 Please refer to the [[../../INSTALL.md][installation guide]] for details.
@@ -451,10 +454,10 @@ RUN apt install -y --no-install-recommends \
                     clang \
                     python3 \
                     git \
-		    patch \
+                    patch \
                     unzip \
                     wget \
-		    ca-certificates
+                    ca-certificates
 RUN git clone https://github.com/just-buildsystem/justbuild.git
 # use a well defined commit to foster reproducibility
 RUN git checkout 246e1b7f28f319e4be5bd24466494e6b5868ca6f
diff --git a/doc/tutorial/tests.md b/doc/tutorial/tests.md
index 138769b1..f4d8897c 100644
--- a/doc/tutorial/tests.md
+++ b/doc/tutorial/tests.md
@@ -93,7 +93,7 @@ be provided. By specifying the appropriate target in this module the
 default test runner can be overwritten by a different test runner fom
 the rule's workspace root. Moreover, all test targets share runner
 infrastructure from `shell/test`, e.g., summarizing multiple runs per
-test (to detect flakyness) if the configuration variable `RUNS_PER_TEST`
+test (to detect flakiness) if the configuration variable `RUNS_PER_TEST`
 is set.
 
 However, in our case, we want to use the default runner and therefore it
diff --git a/doc/tutorial/third-party-software.md b/doc/tutorial/third-party-software.md
index daaf5b2d..644b7b21 100644
--- a/doc/tutorial/third-party-software.md
+++ b/doc/tutorial/third-party-software.md
@@ -467,6 +467,8 @@ staging mechanism the logical repository it belongs to is rooted in the
 }
 ```
 
+---
+
 [^1]: Explicit `TREE` references are always a list of length 3, to
       distinguish them from target references of length 2 (module and
       target name). Furthermore, the second list element is always `null`
-- 
cgit v1.2.3