Rearrange scripts for PDF generation

All the files related to PDF generation have been moved into a new
directory called 'pdf'. Moreover, the script build_with_docker.sh has
been renamed to build-pdfs.sh because another script will be added to
build the GitHub Pages, so this name is more specific about what it
actually does.

Author: vhscampos

.github/workflows/ci.yml

@@ -1,27 +1,26 @@
-# SPDX-FileCopyrightText: Copyright 2021 Arm Limited and/or its affiliates <open-source-office@arm.com>
+# SPDX-FileCopyrightText: Copyright 2021, 2023 Arm Limited and/or its affiliates <open-source-office@arm.com>
 #
 # SPDX-License-Identifier: Apache-2.0
 name: CI
 
 on: [push, pull_request]
 
 jobs:
-  build:
+  build-pdfs:
     runs-on: ubuntu-latest
-
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: check the correctness of the sources and generate the PDFs
-      run: ./build_with_docker.sh
-    - uses: actions/upload-artifact@v2
+      run: ./tools/build-pdfs.sh
+    - uses: actions/upload-artifact@v3
       with:
         name: pdfs
-        path: pdfs
+        path: output_pdfs
 
   markdown-link-check:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@master
+    - uses: actions/checkout@v3
     - uses: gaurav-nelson/github-action-markdown-link-check@v1
       with:
           config-file: '.github/workflows/markdown-link-check.json'

build_with_docker.sh tools/build-pdfs.shbuild_with_docker.sh renamed to tools/build-pdfs.sh

@@ -6,7 +6,8 @@
 set -x
 IMAGE_NAME=acle_build
 # Build the image.
-docker build -t $IMAGE_NAME tools/docker
+docker build -t $IMAGE_NAME tools/pdf/docker
 # Run the image, mounting the current folder into the /src folder of
 # the docker image.
-docker run --rm --mount type=bind,source="$(pwd)",target=/src $IMAGE_NAME
+ROOTDIR=$(realpath "$(dirname "$(realpath "$0")")/..")
+docker run --rm -v "$ROOTDIR":/src $IMAGE_NAME

tools/docker/Dockerfile

@@ -0,0 +1,19 @@
+# SPDX-FileCopyrightText: Copyright 2021, 2023 Arm Limited and/or its affiliates <open-source-office@arm.com>
+# SPDX-License-Identifier: Apache-2.0
+# syntax=docker/dockerfile:1
+
+FROM debian:bullseye-slim
+
+RUN apt update
+RUN apt upgrade -y
+RUN apt install -y ruby
+RUN apt install -y pandoc
+RUN apt install -y inkscape
+RUN apt install -y librsvg2-bin
+RUN apt install -y python3
+RUN apt install -y python3-tabulate
+RUN apt install -y texlive-latex-extra
+RUN apt install -y texlive-fonts-extra
+
+COPY entrypoint.sh /entrypoint.sh
+ENTRYPOINT ["/entrypoint.sh"]

tools/acle_template.tex tools/pdf/acle_template.textools/acle_template.tex renamed to tools/pdf/acle_template.tex

@@ -9,6 +9,7 @@ ls -al
 
 # Generate the intrinsic specifications and the PDFs. If this step
 # fails at any point, stop the docker run.
-/src/tools/hyperref-check.sh || exit 1
-/src/tools/generate-intrinsics-specs.sh || exit 1
-/src/tools/generate-pdfs.sh || exit 1
+/src/tools/pdf/hyperref-check.sh || exit 1
+/src/tools/pdf/generate-intrinsics-specs.sh || exit 1
+/src/tools/pdf/generate-pdfs.sh || exit 1
+rm -rf tmp

tools/check-rst-syntax.sh tools/pdf/check-rst-syntax.shtools/check-rst-syntax.sh renamed to tools/pdf/check-rst-syntax.sh

@@ -32,21 +32,21 @@ function check_changes() {
 # Function that invokes the script to generate the md out of the db
 # of the specs.
 function generate_specs() {
-    ./tools/gen-intrinsics-specs.py --intrinsic-defs $1 \
+    ./tools/pdf/gen-intrinsics-specs.py --intrinsic-defs $1 \
 			    --classification $2 \
 			    --template $3 --outfile $4 \
 			    --workflow $5
 }
 
 # Generate specs
-generate_specs ./tools/intrinsic_db/advsimd.csv \
-		   ./tools/intrinsic_db/advsimd_classification.csv \
+generate_specs ./tools/pdf/intrinsic_db/advsimd.csv \
+		   ./tools/pdf/intrinsic_db/advsimd_classification.csv \
 		   ./neon_intrinsics/advsimd.template.md \
 		   ./tmp/advsimd.new.md \
 		   markdown
 
-generate_specs ./tools/intrinsic_db/mve.csv \
-		   ./tools/intrinsic_db/mve_classification.csv \
+generate_specs ./tools/pdf/intrinsic_db/mve.csv \
+		   ./tools/pdf/intrinsic_db/mve_classification.csv \
 		   ./mve_intrinsics/mve.template.md \
 		   ./tmp/mve.new.md \
 		   markdown
@@ -56,14 +56,14 @@ check_changes ./tmp/advsimd.new.md ./neon_intrinsics/advsimd.md
 check_changes ./tmp/mve.new.md ./mve_intrinsics/mve.md
 
 # Generate tmp file for pdfs
-generate_specs ./tools/intrinsic_db/mve.csv \
-       ./tools/intrinsic_db/mve_classification.csv \
+generate_specs ./tools/pdf/intrinsic_db/mve.csv \
+       ./tools/pdf/intrinsic_db/mve_classification.csv \
        ./mve_intrinsics/mve.template.md \
        ./tmp/mve.for-pdf.md \
        pdf
 
-generate_specs ./tools/intrinsic_db/advsimd.csv \
-       ./tools/intrinsic_db/advsimd_classification.csv \
+generate_specs ./tools/pdf/intrinsic_db/advsimd.csv \
+       ./tools/pdf/intrinsic_db/advsimd_classification.csv \
        ./neon_intrinsics/advsimd.template.md \
        ./tmp/advsimd.for-pdf.md \
        pdf

tools/pdf/docker/Dockerfile

@@ -36,16 +36,16 @@ function generate_pdfs_from_md() {
 	# in the specific case of the cmse.md file.
 	sed -u ':a;N;$!ba;s/\*\sTOC\n{*{:toc}}*//' $inputMdFile | \
 	sed -u "s/<!--latex_geometry_conf-->/$geometryForIntrinsics/" | \
-	pandoc --template=tools/acle_template.tex -o $outputPdfFile --resource-path=$(dirname $inputMdFile)
+	pandoc --template=tools/pdf/acle_template.tex -o $outputPdfFile --resource-path=$(dirname $inputMdFile):.
 }
 
-mkdir -p pdfs tmp
+mkdir -p output_pdfs tmp
 
 # Convert svg image to pdf for use in pdf generation via pandoc.
-inkscape -z Arm_logo_blue_RGB.svg  -e tmp/Arm-logo-blue-RGB.pdf
+inkscape Arm_logo_blue_RGB.svg  -o tmp/Arm-logo-blue-RGB.pdf
 
-generate_pdfs_from_md ./cmse/cmse.md ./pdfs/cmse.pdf
-generate_pdfs_from_md ./morello/morello.md ./pdfs/morello.pdf
-generate_pdfs_from_md ./main/acle.md ./pdfs/acle.pdf
-generate_pdfs_from_md ./tmp/mve.for-pdf.md ./pdfs/mve.pdf
-generate_pdfs_from_md ./tmp/advsimd.for-pdf.md ./pdfs/advsimd.pdf
+generate_pdfs_from_md ./cmse/cmse.md ./output_pdfs/cmse.pdf
+generate_pdfs_from_md ./morello/morello.md ./output_pdfs/morello.pdf
+generate_pdfs_from_md ./main/acle.md ./output_pdfs/acle.pdf
+generate_pdfs_from_md ./tmp/mve.for-pdf.md ./output_pdfs/mve.pdf
+generate_pdfs_from_md ./tmp/advsimd.for-pdf.md ./output_pdfs/advsimd.pdf