Bump version to 1.19.0

Author: angelonakos

CHANGELOG

@@ -1,8 +1,21 @@
                               CHANGELOG
                               `````````
+Version 1.19.0 -- 2022-01-24
+----------------------------
+
+- Change man page extension from .roff to its chapter. 
+
+  This commit is in preparation for Litani to be installed on users'
+  systems, where the man pages need to be installed in the correct
+  location and have the correct prefix in order for the man program to
+  find them.
+
+- Inform user that jobs must be added in order for Litani to run a build
+
 
 Version 1.18.0 -- 2022-01-24
 ----------------------------
+
 - Add new transform-jobs command
 - Add --fast option to Litani test suite
 - Add --output-dir flag to Litani test suite

doc/bin/build-html-doc

@@ -33,7 +33,7 @@ def get_args():
             "required": True,
             "type": pathlib.Path,
     }, {
-            "flags": ["--roff-html-dir"],
+            "flags": ["--man-html-dir"],
             "required": True,
             "type": pathlib.Path,
     }, {
@@ -50,12 +50,12 @@ def get_args():
     return pars.parse_args()
 
 
-def get_manual(man, roff_html_dir):
+def get_manual(man, man_html_dir):
     record = {
         "title": re.sub("litani-", "litani ", man.stem),
         "anchor": man.stem,
         "body": [],
-        "chapter": get_chapter(roff_html_dir / man.name),
+        "chapter": get_chapter(man_html_dir / man.name),
     }
     with open(man) as handle:
         for line in handle:
@@ -70,14 +70,14 @@ def get_chapter(man_html):
             if m:
                 return int(m["chap"])
     raise UserWarning(
-        f"No line of roff html output '{man_html}' matched chapter pattern "
+        f"No line of man html output '{man_html}' matched chapter pattern "
         f"'{CHAPTER_PAT_STR}'")
 
 
-def get_manuals(html_manuals, roff_html_dir):
+def get_manuals(html_manuals, man_html_dir):
     ret = []
     for man in html_manuals:
-        ret.append(get_manual(man, roff_html_dir))
+        ret.append(get_manual(man, man_html_dir))
     return ret
 
 
@@ -88,7 +88,7 @@ def main():
         autoescape=jinja2.select_autoescape(
             enabled_extensions=('html'),
             default_for_string=True))
-    manuals = get_manuals(args.html_manuals, args.roff_html_dir)
+    manuals = get_manuals(args.html_manuals, args.man_html_dir)
 
     templ = env.get_template("index.jinja.html")
     page = templ.render(manuals=manuals)

doc/configure

@@ -17,8 +17,6 @@
 import sys
 import pathlib
 
-import jinja2
-
 
 DOC_DIR = pathlib.Path(sys.path[0]).resolve()
 sys.path.insert(1, str(DOC_DIR.parent))
@@ -36,19 +34,19 @@ SRC_DIR = DOC_DIR / "src"
 TEMPLATE_DIR = DOC_DIR / "templates"
 TMP_DIR = DOC_DIR / "tmp"
 
-ROFF_DIR = OUT_DIR / "man"
+MAN_DIR = OUT_DIR / "man"
 
-HTML_MAN_SRC_DIR = TMP_DIR / "roff_to_html"
+HTML_MAN_SRC_DIR = TMP_DIR / "man_to_html"
 HTML_UNIQUE_DIR = TMP_DIR / "html_unique"
 
 
 RULES = [{
-    "name": "sc_to_roff",
-    "description": "converting ${man-name} to roff",
+    "name": "sc_to_man",
+    "description": "converting ${man-name} to man",
     "command": "scdoc < ${in} > ${out}"
 }, {
-    "name": "voluptuous_to_roff",
-    "description": "converting ${man-name} to roff",
+    "name": "voluptuous_to_man",
+    "description": "converting ${man-name} to man",
     "command": f"{BIN_DIR / 'schema-to-scdoc'}"
                f" --project-root { DOC_DIR.parent }"
                " --page-name ${man-name}"
@@ -57,8 +55,8 @@ RULES = [{
                f" { TEMPLATE_DIR / 'voluptuous-man.jinja.scdoc' }"
                " | scdoc > ${out}"
 }, {
-    "name": "roff_to_html",
-    "description": "converting ${man-name}.roff HTML",
+    "name": "man_to_html",
+    "description": "converting ${man-name} HTML",
     "command": "mandoc -O fragment -Thtml < ${in} > ${out}"
 }, {
     "name": "uniquify_header_ids",
@@ -79,7 +77,7 @@ RULES = [{
                "  --html-manuals ${html-mans}"
                f" --template-dir {TEMPLATE_DIR}"
                "  --out-file ${out}"
-               "  --roff-html-dir ${roff-html-dir}"
+               "  --man-html-dir ${man-html-dir}"
 }]
 
 
@@ -97,12 +95,12 @@ def make_html_unique(man, html_man, html_mans, builds):
     html_mans.append(html_unique)
 
 
-def roff_to_html(man, roff_out, builds):
+def man_to_html(man, man_out, builds):
     html_man = HTML_MAN_SRC_DIR / f"{man.stem}.html"
     builds.append({
-        "inputs": [roff_out],
+        "inputs": [man_out],
         "outputs": [html_man],
-        "rule": "roff_to_html",
+        "rule": "man_to_html",
         "variables": {
             "man-name": man.stem,
             "in-file": html_man,
@@ -111,30 +109,36 @@ def roff_to_html(man, roff_out, builds):
     return html_man
 
 
-def convert_man_dir_to_roff(src_dir, dst_dir, rule, html_mans, builds):
+def convert_man_dir_to_man(src_dir, dst_dir, rule, html_mans, builds):
     for man in (src_dir).iterdir():
-        roff_out = dst_dir / f"{man.stem}.roff"
+        if man.suffix == ".scdoc":
+            with open(man) as fp:
+                line = fp.readline().rstrip()
+            index = line[line.find('(')+1:line.find(')')]
+            man_out = dst_dir / f"{man.stem}.{index}"
+        else:
+            man_out = dst_dir / f"{man.stem}.5"
         builds.append({
             "inputs": [man],
-            "outputs": [roff_out],
+            "outputs": [man_out],
             "rule": rule,
             "variables": {
                 "man-name": man.stem,
                 "data-path": man.resolve(),
             }
         })
-        html_man = roff_to_html(man, roff_out, builds)
+        html_man = man_to_html(man, man_out, builds)
         make_html_unique(man, html_man, html_mans, builds)
 
 
 def main():
     builds = []
     html_mans = []
 
-    convert_man_dir_to_roff(
-        SRC_DIR / "man", ROFF_DIR, "sc_to_roff", html_mans, builds)
-    convert_man_dir_to_roff(
-        SRC_DIR / "voluptuous-man", ROFF_DIR, "voluptuous_to_roff", html_mans,
+    convert_man_dir_to_man(
+        SRC_DIR / "man", MAN_DIR, "sc_to_man", html_mans, builds)
+    convert_man_dir_to_man(
+        SRC_DIR / "voluptuous-man", MAN_DIR, "voluptuous_to_man", html_mans,
         builds)
 
     builds.append({
@@ -146,7 +150,7 @@ def main():
         "rule": "build_html_doc",
         "variables": {
             "html-mans": " ".join([str(h) for h in html_mans]),
-            "roff-html-dir": HTML_MAN_SRC_DIR,
+            "man-html-dir": HTML_MAN_SRC_DIR,
         }
     })
 

lib/litani.py

@@ -33,7 +33,7 @@
 TIME_FORMAT_W = "%Y-%m-%dT%H:%M:%SZ"
 TIME_FORMAT_MS = "%Y-%m-%dT%H:%M:%S.%fZ"
 VERSION_MAJOR = 1
-VERSION_MINOR = 18
+VERSION_MINOR = 19
 VERSION_PATCH = 0
 RC = False
 
@@ -239,6 +239,11 @@ def add_jobs_to_cache():
     jobs = []
     cache_dir = get_cache_dir()
     jobs_dir = cache_dir / JOBS_DIR
+    if not jobs_dir.exists():
+        logging.error(
+            "Cannot run build: no jobs were added. Run `litani add-job` one or "
+            "more times before running `litani run-build`.")
+        sys.exit(1)
     for job_file in os.listdir(jobs_dir):
         with open(jobs_dir / job_file) as handle:
             jobs.append(json.load(handle))