Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 50 additions & 10 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,30 +6,70 @@ name: CI
on: [push, pull_request]

jobs:
build:
build-pdfs:
runs-on: ubuntu-latest

container:
image: docker.io/library/ubuntu:24.04
steps:
- uses: actions/checkout@v4.1.7
- name: check the correctness of the sources and generate the PDFs
run: ./build_with_docker.sh
- uses: actions/upload-artifact@v4.4.0
- uses: actions/checkout@v6.0.2
# The step below is equivalent to the Dockerfile in tools/docker
- name: Install required dependencies
run: |
apt-get update \
&& DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends \
texlive-latex-base \
texlive-fonts-recommended \
texlive-fonts-extra \
texlive-latex-extra \
lmodern \
pandoc \
inkscape \
python3 \
python3-tabulate \
librsvg2-bin \
nodejs

# The steps below are equivalent to the entrypoint of the Dockerfile in tools/docker
- name: Check that the internal links in the markdown files are correct
run: ./tools/hyperref-check.sh || exit 1

- name: Recreate the full markdown files from the templates and check that the saved ones are consistent.
run: ./tools/generate-intrinsics-specs.sh || exit 1

- name: Create PDFs
run: ./tools/generate-pdfs.sh || exit 1

- uses: actions/upload-artifact@v7
with:
name: pdfs
path: pdfs

build-github-pages:
runs-on: ubuntu-latest
container:
image: ghcr.io/github/pages-gem:latest
steps:
- uses: actions/checkout@v4.1.7
- uses: actions/checkout@v6.0.2
- name: generate the GitHub Pages locally in order to check for errors
run: ./tools/build-github-pages.sh build
run: |
echo -e "plugins:\n \
- jekyll-coffeescript\n \
- jekyll-default-layout\n \
- jekyll-gist\n \
- jekyll-github-metadata\n \
- jekyll-optional-front-matter\n \
- jekyll-paginate\n \
- jekyll-readme-index\n \
- jekyll-titles-from-headings\n \
- jekyll-relative-links\n" >> _config.yml
SITE=.
jekyll build

markdown-link-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4.1.7
- uses: gaurav-nelson/github-action-markdown-link-check@v1
- uses: actions/checkout@v6.0.2
- uses: tcort/github-action-markdown-link-check@v1
with:
config-file: '.github/workflows/markdown-link-check.json'

Expand Down
3 changes: 2 additions & 1 deletion .github/workflows/markdown-link-check.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,6 @@
{
"pattern": "^https://developer.arm.com/architectures/instruction-sets/intrinsics/"
}
]
],
"aliveStatusCodes": [200, 206, 403, 429]
}
4 changes: 2 additions & 2 deletions mve_intrinsics/mve.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ version: 2021Q4
date-of-issue: 11 January 2022
# LaTeX specific variables
landscape: true
copyright-text: Copyright 2019-2022 Arm Limited and/or its affiliates <open-source-office@arm.com>.
copyright-text: Copyright 2019-2026 Arm Limited and/or its affiliates <open-source-office@arm.com>.
draftversion: true
# Jekyll specific variables
header_counter: true
toc: true
---

<!--
SPDX-FileCopyrightText: Copyright 2019-2022 Arm Limited and/or its affiliates <open-source-office@arm.com>
SPDX-FileCopyrightText: Copyright 2019-2026 Arm Limited and/or its affiliates <open-source-office@arm.com>
CC-BY-SA-4.0 AND Apache-Patent-License
See LICENSE.md file for details
-->
Expand Down
8 changes: 4 additions & 4 deletions mve_intrinsics/mve.template.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ version: 2021Q4
date-of-issue: 11 January 2022
# LaTeX specific variables
landscape: true
copyright-text: Copyright 2019-2022 Arm Limited and/or its affiliates <open-source-office@arm.com>.
copyright-text: Copyright 2019-2026 Arm Limited and/or its affiliates <open-source-office@arm.com>.
draftversion: true
# Jekyll specific variables
header_counter: true
toc: true
---

<!--
SPDX-FileCopyrightText: Copyright 2019-2022 Arm Limited and/or its affiliates <open-source-office@arm.com>
SPDX-FileCopyrightText: Copyright 2019-2026 Arm Limited and/or its affiliates <open-source-office@arm.com>
CC-BY-SA-4.0 AND Apache-Patent-License
See LICENSE.md file for details
-->
Expand All @@ -24,7 +24,7 @@ to generate the Table of Contents via Jekyll.
They are automatically removed by the scripts that generate the pdfs.
-->
* TOC
{{:toc}}
{:toc}
# Preface

## Abstract
Expand Down Expand Up @@ -137,4 +137,4 @@ It is automatically removed by the scripts that generate the pdfs.

# List of Intrinsics

{intrinsic_table}
REPLACE_INTRINSIC_TABLE_HERE
2 changes: 1 addition & 1 deletion neon_intrinsics/advsimd.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ toc: true
---

<!--
SPDX-FileCopyrightText: Copyright 2014-2025 Arm Limited and/or its affiliates <open-source-office@arm.com>
SPDX-FileCopyrightText: Copyright 2014-2026 Arm Limited and/or its affiliates <open-source-office@arm.com>
SPDX-FileCopyrightText: Copyright 2021 Matt P. Dziubinski <matdzb@gmail.com>
CC-BY-SA-4.0 AND Apache-Patent-License
See LICENSE.md file for details
Expand Down
8 changes: 4 additions & 4 deletions neon_intrinsics/advsimd.template.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ version: 2025Q2
date-of-issue: 06 June 2025
# LaTeX specific variables
landscape: true
copyright-text: "Copyright: see section \\texorpdfstring{{\\nameref{{copyright}}}}{{Copyright}}."
copyright-text: "Copyright: see section \\texorpdfstring{\\nameref{copyright}}{Copyright}."
draftversion: true
# Jekyll specific variables
header_counter: true
toc: true
---

<!--
SPDX-FileCopyrightText: Copyright 2014-2025 Arm Limited and/or its affiliates <open-source-office@arm.com>
SPDX-FileCopyrightText: Copyright 2014-2026 Arm Limited and/or its affiliates <open-source-office@arm.com>
SPDX-FileCopyrightText: Copyright 2021 Matt P. Dziubinski <matdzb@gmail.com>
CC-BY-SA-4.0 AND Apache-Patent-License
See LICENSE.md file for details
Expand All @@ -25,7 +25,7 @@ to generate the Table of Contents via Jekyll.
They are automatically removed by the scripts that generate the pdfs.
-->
* TOC
{{:toc}}
{:toc}
# Preface

## Abstract
Expand Down Expand Up @@ -179,4 +179,4 @@ It is automatically removed by the scripts that generate the pdfs.

# List of Intrinsics

{intrinsic_table}
REPLACE_INTRINSIC_TABLE_HERE
Loading
Loading