Skip to content
Open
Show file tree
Hide file tree
Changes from 3 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
5 changes: 2 additions & 3 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,7 @@ useful for layout problems in the PDF or HTML pages.

**Our commitment**

We will work to solve the bug report in time for the upcoming
release. However, we would like to encourage you to submit the fix
yourself, if possible. If you intend to do so and this is your first
We will work to solve the bug report timely. However, we encourage you to submit
the fix yourself, if possible. If you intend to do so and this is your first
contribution, we recommend reading our [contribution
guidelines](https://github.com/ARM-software/acle/blob/main/CONTRIBUTING.md).
39 changes: 15 additions & 24 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,11 @@ title: Contribution Guidelines

# Thank you for considering contributing!

Contributions are always welcome. We accept [bug fixes](#bugs),
[proposals and new ideas](#proposals-for-new-content), or simply [editorial
improvements](#editorial-improvements).
Contributions are always welcome. We accept bug fixes, proposals and new ideas,
or simply editorial improvements.

By submitting a pull request you are implicitly adhering to the
[contribution agreement](#contribution-agreement)
contribution agreement below.
Comment thread
rgwott marked this conversation as resolved.

## Bugs

Expand Down Expand Up @@ -52,14 +51,9 @@ the specifications and stores them in the folder `pdfs`.

# Continuous integration

The continuous integration bot executes the script:

```
./build_with_docker.sh
```

PDFs are generated automatically in response to a pull request. You
can download the PDFs in the `Actions` tab of any pull request.
The continuous integration bot executes the script and generates PDFs
automatically in response to a pull request. You can download the PDFs in the
`Actions` tab of any pull request.

An additional step uses
[``markdown-link-check```](https://github.com/tcort/markdown-link-check)
Expand All @@ -68,20 +62,17 @@ correctly.

# Branches and pull requests.

The branch `latest-release` is the release branch, which contains the
code used to build the PDFs of the [latest official
release](https://github.com/ARM-software/acle/releases/latest). The
branch `latest-release` is also used to build the [website of the ACLE
project](https://arm-software.github.io/acle).
Development (bug-fixes, proposals, extensions, and so on) is conducted
exclusively on the `main` branch. Therefore, please submit your PR against
`main`.

New development (bug-fixes, proposals, extensions, and so on) is
committed on the `main` branch. Therefore, please submit your
PR against the branch `main`.
Branch `latest-release` was formerly used to generate releases. We have
moved from quarterly to rolling releases, so `latest-release` is now obsolete.
Do not use.
Comment thread
rgwott marked this conversation as resolved.
Outdated

It is good practice to track changes. In the section `Changes for next
release`, please list any changes that you have made to the
document. For an example, see [this
PR](https://github.com/ARM-software/acle/pull/19).
It is good practice to track changes. In section `Changes since 2026Q1`,
please list any changes that you have made to the document. As an example, see
[this PR](https://github.com/ARM-software/acle/pull/443/changes).

# Contribution agreement

Expand Down
51 changes: 33 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,32 @@
This repository contains the source material from which the
specifications for the Arm C Language Extensions (ACLE) are derived.

The latest release of the specifications can be browsed online at
The latest version of the specifications can be browsed online at
[arm-software.github.io/acle/](https://arm-software.github.io/acle/).

The PDF version of the documents can be retrieved from the [latest
release](https://github.com/ARM-software/acle/releases/latest) page.
## Versioning

The development version is stored on the branch `main` at
[github.com/ARM-software/acle/](https://github.com/ARM-software/acle/),
while the latest released version is tracked by the branch
`latest-release`.
We have transitioned from a quarterly release schedule to rolling versioning.
The specifications are now updated on every commit as changes are completed and
reviewed, providing more timely access to new features, clarifications, and
corrections.

The PDF version of the documents can be retrieved from the
[releases](https://github.com/ARM-software/acle/releases) page.

Branch `main` at
[github.com/ARM-software/acle/](https://github.com/ARM-software/acle/) is
ACLE's main development branch. Branch `latest-release` tracks the latest
quarterly release, and is now considered legacy.

## Legacy releases

Quarterly releases (now considered legacy) up to 2026Q1 are also present in the
[releases](https://github.com/ARM-software/acle/releases) page.

Pre-GitHub versions of the documents were previously released on
[Arm Developer](https://developer.arm.com), and are also hosted in this
repository, in [Legacy releases](legacyreleases/README.md).

## Contributing

Expand All @@ -43,19 +59,18 @@ an email to arm.acle@arm.com.

## List of documents

HTML version | PDF version
--- | ---
[Arm C Language Extensions](https://arm-software.github.io/acle/main/) | [download](https://github.com/ARM-software/acle/releases/latest)
[Morello Supplement to the Arm C Language Extensions](https://arm-software.github.io/acle/morello/) | [download](https://github.com/ARM-software/acle/releases/latest)
[Arm MVE Intrinsics](https://arm-software.github.io/acle/mve_intrinsics/) | [download](https://github.com/ARM-software/acle/releases/latest)
[Arm Neon Intrinsics Reference](https://arm-software.github.io/acle/neon_intrinsics/) | [download](https://github.com/ARM-software/acle/releases/latest)
[Arm®v8-M Security Extensions - Requirements on Development Tools](https://arm-software.github.io/acle/cmse/) | [download](https://github.com/ARM-software/acle/releases/latest)
[Arm C Language Extensions](https://arm-software.github.io/acle/main/)

## Legacy releases
[Morello Supplement to the Arm C Language Extensions](https://arm-software.github.io/acle/morello/)

[Arm MVE Intrinsics](https://arm-software.github.io/acle/mve_intrinsics/)

[Arm Neon Intrinsics Reference](https://arm-software.github.io/acle/neon_intrinsics/)

[Arm®v8-M Security Extensions - Requirements on Development Tools](https://arm-software.github.io/acle/cmse/)

Legacy versions of the documents were released on [Arm Developer](https://developer.arm.com).
They are now also hosted in this repository and are to be found in [Legacy releases](legacyreleases/README.md).
They follow the same folder naming scheme as the main document folders.
The PDF versions can be found in the latest GitHub
[release](https://github.com/ARM-software/acle/releases/latest).

# License

Expand Down
15 changes: 8 additions & 7 deletions cmse/cmse.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,13 +123,14 @@ Copyright 2019, 2021-2023 Arm Limited and/or its affiliates <open-source-office@

### Change history

| Issue | Date | By | Change |
| :--- | :--- | :--- | :--- |
| 1.0 | 23/10/2015 | Arm | First release |
| 1.1 | 01/11/2019 | Arm | Second release |
| 1.2 | 06 April 2022 | Arm | See [Changes for version 1.2](#changes-for-version-1.2)|
| 1.3 | 04 August 2023 | Arm | See [Changes for version 1.3](#changes-for-version-1.3)|
| 1.4 | 21 June 2024 | Arm | See [Changes for version 1.4](#changes-for-version-1.4)|
| Issue | Date | By | Change |
| :--------------- | :------------- | :--- | :------------------------------------------------------ |
| 1.0 | 23/10/2015 | Arm | First release |
| 1.1 | 01/11/2019 | Arm | Second release |
| 1.2 | 06 April 2022 | Arm | See [Changes for version 1.2](#changes-for-version-1.2) |
| 1.3 | 04 August 2023 | Arm | See [Changes for version 1.3](#changes-for-version-1.3) |
| 1.4 | 21 June 2024 | Arm | See [Changes for version 1.4](#changes-for-version-1.4) |
| Rolling releases | Every commit | Arm | None |

#### Changes for version 1.2

Expand Down
61 changes: 30 additions & 31 deletions main/acle.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: Arm C Language Extensions
version: 2026Q1
date-of-issue: 15 May 2026
# LaTeX specific variables
copyright-text: "Copyright: see section \\texorpdfstring{\\nameref{copyright}}{Copyright}."
draftversion: true
Expand Down Expand Up @@ -121,7 +119,7 @@ about Arm’s trademarks.

### Change control

#### Current Status and Anticipated Changes
#### Current status and anticipated changes

The following support level definitions are used by the ACLE
specifications:
Expand Down Expand Up @@ -155,34 +153,35 @@ unless a different support level is specified in the text.

#### Change history

| **Issue** | **Date** | **By** | **Change** |
| ------------ | ----------------- | ------ | -------------------------------------------------------------------------------------------------------------------- |
| A | 11/11/11 | AG | First release |
| B | 13/11/13 | AG | Version 1.1. Editorial changes. Corrections and completions to intrinsics as detailed in 3.3. Updated for C11/C++11. |
| C | 09/05/14 | TB | Version 2.0. Updated for Armv8 AArch32 and AArch64. |
| D | 24/03/16 | TB | Version 2.1. Updated for Armv8.1 AArch32 and AArch64. |
| E | 02/06/17 | Arm | Version ACLE Q2 2017. Updated for Armv8.2-A and Armv8.3-A. |
| F | 30/04/18 | Arm | Version ACLE Q2 2018. Updated for Armv8.4-A. |
| G | 30/03/19 | Arm | Version ACLE Q1 2019. Updated for Armv8.5-A and MVE. Various bugfixes. |
| H | 30/06/19 | Arm | Version ACLE Q2 2019. Updated for TME and more Armv8.5-A intrinsics. Various bugfixes. |
| ACLE Q3 2019 | 30/09/19 | Arm | Version ACLE Q3 2019. |
| ACLE Q4 2019 | 31/12/19 | Arm | Version ACLE Q4 2019. |
| ACLE Q2 2020 | 31/05/20 | Arm | Version ACLE Q2 2020. |
| ACLE Q3 2020 | 31/10/20 | Arm | Version ACLE Q3 2020. |
| 2021Q2 | 02 July 2021 | Arm | Version ACLE Q2 2021. Open source version. NFCI. |
| 2021Q3 | 30 September 2021 | Arm | Minor re-wording. NFCI. |
| 2021Q4 | 11 January 2022 | Arm | See [Changes between ACLE Q3 2021 and ACLE Q4 2021](#changes-between-acle-q3-2021-and-acle-q4-2021) |
| 2022Q1 | 06 April 2022 | Arm | See [Changes between ACLE Q4 2021 and ACLE Q1 2022](#changes-between-acle-q4-2021-and-acle-q1-2022) |
| 2022Q2 | 01 Jul 2022 | Arm | See [Changes between ACLE Q1 2021 and ACLE Q2 2022](#changes-between-acle-q1-2022-and-acle-q2-2022) |
| 2022Q4 | 23 November 2022 | Arm | See [Changes between ACLE Q2 2022 and ACLE Q4 2022](#changes-between-acle-q2-2022-and-acle-q4-2022) |
| 2023Q2 | 04 August 2023 | Arm | See [Changes between ACLE Q4 2022 and ACLE Q2 2023](#changes-between-acle-q4-2022-and-acle-q2-2023) |
| 2024Q1 | 11 April 2024 | Arm | See [Changes between ACLE Q2 2023 and ACLE Q1 2024](#changes-between-acle-q2-2023-and-acle-q1-2024) |
| 2024Q2 | 21 June 2024 | Arm | See [Changes between ACLE Q1 2024 and ACLE Q2 2024](#changes-between-acle-q1-2024-and-acle-q2-2024) |
| 2024Q3 | 30 September 2024 | Arm | See [Changes between ACLE Q2 2024 and ACLE Q3 2024](#changes-between-acle-q2-2024-and-acle-q3-2024) |
| 2024Q4 | 21 February 2025 | Arm | See [Changes between ACLE Q3 2024 and ACLE Q4 2024](#changes-between-acle-q3-2024-and-acle-q4-2024) |
| 2025Q2 | 06 June 2025 | Arm | See [Changes between ACLE Q4 2024 and ACLE Q2 2025](#changes-between-acle-q4-2024-and-acle-q2-2025) |
| 2025Q3 | 14 November 2025 | Arm | See [Changes between ACLE Q2 2025 and ACLE Q3 2025](#changes-between-acle-q2-2025-and-acle-q3-2025) |
| 2026Q1 | 15 May 2026 | Arm | See [Changes between ACLE Q3 2025 and ACLE Q1 2026](#changes-between-acle-q3-2025-and-acle-q1-2026) |
| **Issue** | **Date** | **By** | **Change** |
| ---------------- | ----------------- | ------ | -------------------------------------------------------------------------------------------------------------------- |
| A | 11/11/11 | AG | First release |
| B | 13/11/13 | AG | Version 1.1. Editorial changes. Corrections and completions to intrinsics as detailed in 3.3. Updated for C11/C++11. |
| C | 09/05/14 | TB | Version 2.0. Updated for Armv8 AArch32 and AArch64. |
| D | 24/03/16 | TB | Version 2.1. Updated for Armv8.1 AArch32 and AArch64. |
| E | 02/06/17 | Arm | Version ACLE Q2 2017. Updated for Armv8.2-A and Armv8.3-A. |
| F | 30/04/18 | Arm | Version ACLE Q2 2018. Updated for Armv8.4-A. |
| G | 30/03/19 | Arm | Version ACLE Q1 2019. Updated for Armv8.5-A and MVE. Various bugfixes. |
| H | 30/06/19 | Arm | Version ACLE Q2 2019. Updated for TME and more Armv8.5-A intrinsics. Various bugfixes. |
| ACLE Q3 2019 | 30/09/19 | Arm | Version ACLE Q3 2019. |
| ACLE Q4 2019 | 31/12/19 | Arm | Version ACLE Q4 2019. |
| ACLE Q2 2020 | 31/05/20 | Arm | Version ACLE Q2 2020. |
| ACLE Q3 2020 | 31/10/20 | Arm | Version ACLE Q3 2020. |
| 2021Q2 | 02 July 2021 | Arm | Version ACLE Q2 2021. Open source version. NFCI. |
| 2021Q3 | 30 September 2021 | Arm | Minor re-wording. NFCI. |
| 2021Q4 | 11 January 2022 | Arm | See [Changes between ACLE Q3 2021 and ACLE Q4 2021](#changes-between-acle-q3-2021-and-acle-q4-2021) |
| 2022Q1 | 06 April 2022 | Arm | See [Changes between ACLE Q4 2021 and ACLE Q1 2022](#changes-between-acle-q4-2021-and-acle-q1-2022) |
| 2022Q2 | 01 Jul 2022 | Arm | See [Changes between ACLE Q1 2021 and ACLE Q2 2022](#changes-between-acle-q1-2022-and-acle-q2-2022) |
| 2022Q4 | 23 November 2022 | Arm | See [Changes between ACLE Q2 2022 and ACLE Q4 2022](#changes-between-acle-q2-2022-and-acle-q4-2022) |
| 2023Q2 | 04 August 2023 | Arm | See [Changes between ACLE Q4 2022 and ACLE Q2 2023](#changes-between-acle-q4-2022-and-acle-q2-2023) |
| 2024Q1 | 11 April 2024 | Arm | See [Changes between ACLE Q2 2023 and ACLE Q1 2024](#changes-between-acle-q2-2023-and-acle-q1-2024) |
| 2024Q2 | 21 June 2024 | Arm | See [Changes between ACLE Q1 2024 and ACLE Q2 2024](#changes-between-acle-q1-2024-and-acle-q2-2024) |
| 2024Q3 | 30 September 2024 | Arm | See [Changes between ACLE Q2 2024 and ACLE Q3 2024](#changes-between-acle-q2-2024-and-acle-q3-2024) |
| 2024Q4 | 21 February 2025 | Arm | See [Changes between ACLE Q3 2024 and ACLE Q4 2024](#changes-between-acle-q3-2024-and-acle-q4-2024) |
| 2025Q2 | 06 June 2025 | Arm | See [Changes between ACLE Q4 2024 and ACLE Q2 2025](#changes-between-acle-q4-2024-and-acle-q2-2025) |
| 2025Q3 | 14 November 2025 | Arm | See [Changes between ACLE Q2 2025 and ACLE Q3 2025](#changes-between-acle-q2-2025-and-acle-q3-2025) |
| 2026Q1 | 15 May 2026 | Arm | See [Changes between ACLE Q3 2025 and ACLE Q1 2026](#changes-between-acle-q3-2025-and-acle-q1-2026) |
| Rolling releases | Every commit | Arm | See [Changes after ACLE Q1 2026](#changes-after-acle-q1-2026) |

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

We are not aiming for more releases, so perhaps "Single current version" is a good phrase to use?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Do you mean in place of "Rolling releases"?

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.

Rather than add a line in the table, how about adding a separate line stating: "After the 2026Q1 release, the project has moved to a rolling release model with the state of the main branch being authoritative.".
No need to add a link to the changelog.
Likewise for the tables below.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

yeah, I think @rockdreamer is right adding a new entry to the table could be misleading as we are not going to maintain a changeling for each of the merged commits.
Closing this table seems to be a good option.

I am not a big supporter of the phrase "rolling releases", can we choose something else?
Things which come to my mind are:

  1. Continuously updated specification
  2. Ongoing specification updates
  3. Single current version
  4. Living specification

No need to add a link to the changelog.
we could mention that there is going to be a e yearly change summary

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done, please verify.


#### Changes between ACLE Q2 2017 and ACLE Q2 2018

Expand Down
11 changes: 6 additions & 5 deletions morello/morello.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,11 +151,12 @@ All content in this document is at the **Alpha** quality level.

### Change History

| Issue | Date | Change |
| :--- | :--- | :--- |
| 00alpha | 30th September 2020 | Alpha release |
| 01alpha | 02 July 2021 | Open source release. NFCI. |
| 02alpha | 11 January 2022 | See [Changes for 02alpha](#changes-for-02alpha) |
| Issue | Date | Change |
| :--------------- | :------------------ | :---------------------------------------------- |
| 00alpha | 30th September 2020 | Alpha release |
| 01alpha | 02 July 2021 | Open source release. NFCI. |
| 02alpha | 11 January 2022 | See [Changes for 02alpha](#changes-for-02alpha) |
| Rolling releases | Every commit | None |

### Changes for 02alpha

Expand Down
Loading
Loading