Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 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
4 changes: 1 addition & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ about: Technical issues, document format problems, bugs in scripts or feature pr

---

<!-- SPDX-FileCopyrightText: Copyright 2021-2022 Arm Limited and/or its affiliates <open-source-office@arm.com> -->
<!-- SPDX-FileCopyrightText: Copyright 2021-2022, 2026 Arm Limited and/or its affiliates <open-source-office@arm.com> -->
<!-- SPDX-License-Identifier: Apache-2.0 -->

**Thank you for submitting a pull request!**
Expand Down Expand Up @@ -60,7 +60,5 @@ Checklist: (mark with ``X`` those which apply)
correctness of the result in the PDF output (please refer to the
instructions on [how to build the PDFs
locally](https://github.com/ARM-software/acle/blob/main/CONTRIBUTING.md#continuous-integration)).
* [ ] The variable `draftversion` is set to `true` in the YAML header
of the sources of the specifications I have modified.
* [ ] Please *DO NOT* add my GitHub profile to the list of contributors
in the [README](https://github.com/ARM-software/acle/blob/main/README.md#contributors-) page of the project.
14 changes: 2 additions & 12 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: Copyright 2021 Arm Limited and/or its affiliates <open-source-office@arm.com>
# SPDX-FileCopyrightText: Copyright 2021, 2026 Arm Limited and/or its affiliates <open-source-office@arm.com>
#
# SPDX-License-Identifier: Apache-2.0
name: CI
Expand All @@ -12,7 +12,7 @@ jobs:
steps:
- uses: actions/checkout@v4.1.7
- name: check the correctness of the sources and generate the PDFs
run: ./build_with_docker.sh
run: ./build_with_docker.sh --finalversion
- uses: actions/upload-artifact@v4.4.0
with:
name: pdfs
Expand All @@ -32,13 +32,3 @@ jobs:
- uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
config-file: '.github/workflows/markdown-link-check.json'

draftversion-check:
runs-on: ubuntu-latest
if: github.base_ref == 'main' || github.ref == 'refs/heads/main'
steps:
- uses: actions/checkout@v4.1.7
with:
fetch-depth: 0
- name: Check correctness of draftversion fields
run: python ./tools/acle_draftversion_value_check.py .
16 changes: 14 additions & 2 deletions _includes/navbar.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!-- SPDX-License-Identifier: Apache-2.0 -->
<!-- SPDX-FileCopyrightText: Copyright 2021 Arm Limited and/or its affiliates <open-source-office@arm.com> -->
<!-- SPDX-FileCopyrightText: Copyright 2021, 2026 Arm Limited and/or its affiliates <open-source-office@arm.com> -->

<nav id="header">
<span id="left-side">
Expand All @@ -16,7 +16,19 @@
</span>
<img id="logo" src="{{site.baseurl}}/assets/images/Arm_logo_white_RGB.svg" alt="Logo">
<span id="right-side">
{% if page.version %} Version: {{ page.version }} &nbsp;:::&nbsp; {% endif %}
{% assign hash = site.commithash | default: site.github.build_revision %}
{% if hash %}
{% assign short_hash = hash | slice: 0, 12 %}
{% if site.finalversion %}
Version: <a id="link_finalversion" href="https://github.com/ARM-software/acle/commit/{{ hash }}">{{ hash }}</a> &nbsp;:::&nbsp;
{% elsif site.cleanrepo %}
Version: <span class="dev_version">Dev version (<a id="link_devversion" href="https://github.com/ARM-software/acle/commit/{{ hash }}">{{ short_hash }}</a>)</span> &nbsp;:::&nbsp;
{% else %}
Version: <span class="dev_version">Dev version (<a id="link_devversion" href="https://github.com/ARM-software/acle/commit/{{ hash }}">{{ short_hash }}</a>), modified</span> &nbsp;:::&nbsp;
{% endif %}
{% elsif page.version %}
Version: {{ page.version }} &nbsp;:::&nbsp;
{% endif %}
{% if page.date-of-issue %} Release Date: {{ page.date-of-issue }} &nbsp;:::&nbsp; {% endif %}
Comment thread
rgwott marked this conversation as resolved.
Outdated
<a href="https://github.com/ARM-software/acle/issues">
<button class="navbar_button"> Report a Bug </button>
Expand Down
16 changes: 15 additions & 1 deletion _sass/main.scss
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
SPDX-FileCopyrightText: Copyright 2021 Arm Limited and/or its affiliates <open-source-office@arm.com>
SPDX-FileCopyrightText: Copyright 2021, 2026 Arm Limited and/or its affiliates <open-source-office@arm.com>
SPDX-License-Identifier: Apache-2.0
The colors used for formatting have been added in accordance with corporate guidelines:
https://www.arm.com/company/policies/trademarks/guidelines-corporate-logo
Expand Down Expand Up @@ -114,3 +114,17 @@ https://www.arm.com/company/policies/trademarks/guidelines-corporate-logo
#index_logo {
height: 160px;
}

#link_finalversion {
color: white;
text-decoration: underline;
}

.dev_version {
color: red;
}

#link_devversion {
color: red;
text-decoration: underline;
}
36 changes: 35 additions & 1 deletion build_with_docker.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,44 @@
# SPDX-FileCopyrightText: Copyright 2021-2026 Arm Limited and/or its affiliates <open-source-office@arm.com>
# SPDX-License-Identifier: Apache-2.0

finalversion=""
cleanrepo=""

while [[ $# -gt 0 ]]; do
case "$1" in
--finalversion)
finalversion="--finalversion"
;;
*)
echo "Unknown option: $1" >&2
exit 1
;;
esac
shift
done

# Check if repo is in a clean state
git diff --quiet && git diff --cached --quiet
Comment thread
rgwott marked this conversation as resolved.
Outdated
if [[ $? -eq 0 ]]; then
cleanrepo="--cleanrepo"
fi

# Get last commit
commithash="--commithash $(git rev-parse HEAD)"

echo "Building pdfs with parameters:"
if [[ -n "$finalversion" ]]; then
echo " --finalversion"
fi
if [[ -n "$cleanrepo" ]]; then
echo " --cleanrepo"
fi
echo " $commithash"

set -x
IMAGE_NAME=acle_build
# Build the image.
docker build -t $IMAGE_NAME tools/docker
# Run the image, mounting the current folder into the /src folder of
# the docker image. Run as the host user so that the output files are owned by them.
docker run --rm -u $(id -u):$(id -g) --mount type=bind,source="$(pwd)",target=/src $IMAGE_NAME
docker run --rm -u $(id -u):$(id -g) --mount type=bind,source="$(pwd)",target=/src $IMAGE_NAME $finalversion $commithash $cleanrepo
4 changes: 1 addition & 3 deletions cmse/cmse.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
---
title: Arm®v8-M Security Extensions <br /> Requirements on Development Tools
version: 1.4
date-of-issue: 21 June 2024
set-quote-highlight: true
# LaTeX specific variables
copyright-text: Copyright 2019, 2021-2024 Arm Limited and/or its affiliates <open-source-office@arm.com>.
draftversion: true
copyright-text: Copyright 2019, 2021-2024, 2026 Arm Limited and/or its affiliates <open-source-office@arm.com>.
# Jekyll specific variables
header_counter: true
toc: true
Expand Down
2 changes: 0 additions & 2 deletions main/acle.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
---
title: Arm C Language Extensions
version: 2026Q1
date-of-issue: 15 May 2026
Comment thread
rockdreamer marked this conversation as resolved.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with @rockdreamer

# LaTeX specific variables
copyright-text: "Copyright: see section \\texorpdfstring{\\nameref{copyright}}{Copyright}."
draftversion: true
# Jekyll specific variables
header_counter: true
toc: true
Expand Down
4 changes: 1 addition & 3 deletions morello/morello.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
---
title: Morello Supplement to the Arm C Language Extensions
version: 02alpha
date-of-issue: 11 January 2022
# LaTeX specific variables
copyright-text: Copyright 2020-2022 Arm Limited and/or its affiliates <open-source-office@arm.com>.
draftversion: true
copyright-text: Copyright 2020-2022, 2026 Arm Limited and/or its affiliates <open-source-office@arm.com>.
# Jekyll specific variables
header_counter: true
toc: true
Expand Down
4 changes: 1 addition & 3 deletions mve_intrinsics/mve.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
---
title: Arm MVE Intrinsics
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>.
draftversion: true
copyright-text: Copyright 2019-2022, 2026 Arm Limited and/or its affiliates <open-source-office@arm.com>.
# Jekyll specific variables
header_counter: true
toc: true
Expand Down
4 changes: 1 addition & 3 deletions mve_intrinsics/mve.template.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
---
title: Arm MVE Intrinsics
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>.
draftversion: true
copyright-text: Copyright 2019-2022, 2026 Arm Limited and/or its affiliates <open-source-office@arm.com>.
# Jekyll specific variables
header_counter: true
toc: true
Expand Down
2 changes: 0 additions & 2 deletions neon_intrinsics/advsimd.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
---
title: Arm Neon Intrinsics Reference
version: 2026Q1
date-of-issue: 15 May 2026
# LaTeX specific variables
landscape: true
copyright-text: "Copyright: see section \\texorpdfstring{\\nameref{copyright}}{Copyright}."
draftversion: true
# Jekyll specific variables
header_counter: true
toc: true
Expand Down
2 changes: 0 additions & 2 deletions neon_intrinsics/advsimd.template.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
---
title: Arm Neon Intrinsics Reference
version: 2026Q1
date-of-issue: 15 May 2026
# LaTeX specific variables
landscape: true
copyright-text: "Copyright: see section \\texorpdfstring{{\\nameref{{copyright}}}}{{Copyright}}."
draftversion: true
# Jekyll specific variables
header_counter: true
toc: true
Expand Down
89 changes: 0 additions & 89 deletions tools/acle_draftversion_value_check.py

This file was deleted.

12 changes: 8 additions & 4 deletions tools/acle_template.tex
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
% Copyright (c) 2014--2021, John MacFarlane
% SPDX-FileCopyrightText: Copyright 2021-2022 Arm Limited and/or its affiliates <open-source-office@arm.com>
% SPDX-FileCopyrightText: Copyright 2021-2022, 2026 Arm Limited and/or its affiliates <open-source-office@arm.com>
% SPDX-License-Identifier: BSD-3-Clause
% Based on default.latex template released with Pandoc (www.pandoc.org).
% See `data/templates` in `COPYRIGHT` at https://github.com/jgm/pandoc
Expand Down Expand Up @@ -38,10 +38,14 @@
\makeatother

\sectionfont{\color{armblue}}
$if(draftversion)$
\newcommand{\versiontext}{\textcolor{red}{Development version based on $version$}}
$if(finalversion)$
\newcommand{\versiontext}{\href{https://github.com/ARM-software/acle/commit/$commithash$}{$commithash$}}
Comment thread
CarolineConcatto marked this conversation as resolved.
$else$
\newcommand{\versiontext}{$version$}
$if(cleanrepo)$
Comment thread
rgwott marked this conversation as resolved.
\newcommand{\versiontext}{\textcolor{red}{Development version based on \href{https://github.com/ARM-software/acle/commit/$commithash$}{$commithash$}}}
$else$
\newcommand{\versiontext}{\textcolor{red}{Development version based on \href{https://github.com/ARM-software/acle/commit/$commithash$}{$commithash$}, with modifications}}
Comment thread
CarolineConcatto marked this conversation as resolved.
$endif$
$endif$
\newcommand{\dateofissue}{$if(draftversion)$TBD$else$$date-of-issue$$endif$}

Expand Down
Loading
Loading