diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 0b199b66..f60b875d 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -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). diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 5859c7e7..a0c81495 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -50,9 +50,9 @@ Checklist: (mark with ``X`` those which apply) patch will be automatically checked in the Actions of the pull request. * [ ] I have added an item that describes the changes I have - introduced in this PR in the section **Changes for next - release** of the section **Change Control**/**Document history** - of the document. Create **Changes for next release** if it does + introduced in this PR in the section **Changes for year 20xx** (this year) + of the section **Change Control**/**Document history** + of the document. Create **Changes for year 20xx** if it does not exist. Notice that changes that are not modifying the content and rendering of the specifications (both HTML and PDF) do not need to be listed. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bd641d4e..0a632259 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. ## Bugs @@ -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) @@ -68,20 +62,13 @@ 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). - -New development (bug-fixes, proposals, extensions, and so on) is -committed on the `main` branch. Therefore, please submit your -PR against the branch `main`. +Development (bug-fixes, proposals, extensions, and so on) is conducted +exclusively on the `main` branch. Therefore, please submit your PR against +`main`. -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 after ACLE Q1 2026`, +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 diff --git a/README.md b/README.md index d261e466..da575d70 100644 --- a/README.md +++ b/README.md @@ -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 a continuously updated +specification. The specification is 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 @@ -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 diff --git a/main/acle.md b/main/acle.md index 2496db92..edb5844b 100644 --- a/main/acle.md +++ b/main/acle.md @@ -1,6 +1,5 @@ --- title: Arm C Language Extensions -date-of-issue: 15 May 2026 # LaTeX specific variables copyright-text: "Copyright: see section \\texorpdfstring{\\nameref{copyright}}{Copyright}." # Jekyll specific variables @@ -119,7 +118,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: @@ -182,6 +181,13 @@ unless a different support level is specified in the text. | 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) | +#### Continuously updated specification + +After 2026Q1, this specification is published continuously from the +main branch. Each published version is identified by its Git commit hash. + +See [Changes for year 2026](#changes-for-year-2026). + #### Changes between ACLE Q2 2017 and ACLE Q2 2018 Most changes in ACLE Q2 2018 are updates to support features introduced in @@ -488,7 +494,7 @@ Armv8.4-A [[ARMARMv84]](#ARMARMv84). Support is added for the Dot Product intrin for Brain 16-bit floating-point vector multiplication intrinsics. * Redesigned atomic store with hints intrinsics. -#### Changes after ACLE Q1 2026 +#### Changes for year 2026 * Added [**Alpha**](#current-status-and-anticipated-changes) support for SVE2.3 (FEAT_SVE2p3), SME2.3 (FEAT_SME2p3), FEAT_F16F32DOT diff --git a/neon_intrinsics/advsimd.md b/neon_intrinsics/advsimd.md index f0d95674..572a466d 100644 --- a/neon_intrinsics/advsimd.md +++ b/neon_intrinsics/advsimd.md @@ -1,6 +1,5 @@ --- title: Arm Neon Intrinsics Reference -date-of-issue: 15 May 2026 # LaTeX specific variables landscape: true copyright-text: "Copyright: see section \\texorpdfstring{\\nameref{copyright}}{Copyright}." @@ -128,6 +127,13 @@ for more information about Arm’s trademarks. | N | 06 June 2025 | 2025Q2 | | O | 15 May 2026 | 2026Q1 | +### Continuously updated specification + +After 2026Q1, this specification is published continuously from the +main branch. Each published version is identified by its Git commit hash. + +See [Changes for year 2026](#changes-for-year-2026). + ### Changes between 2021Q2 and 2021Q3 * Fixed the guard macro for the base intrinsics. @@ -168,7 +174,7 @@ for more information about Arm’s trademarks. floating point conversion intrinsics from "Half Precision to 32-bit" and "Half Precision to 64-bit". -### Changes since 2026Q1 +### Changes for year 2026 * Added support for FEAT_F16F32DOT * Added support for FEAT_F16F32MM and FEAT_F16MM diff --git a/neon_intrinsics/advsimd.template.md b/neon_intrinsics/advsimd.template.md index 2737d884..2c153664 100644 --- a/neon_intrinsics/advsimd.template.md +++ b/neon_intrinsics/advsimd.template.md @@ -1,6 +1,5 @@ --- title: Arm Neon Intrinsics Reference -date-of-issue: 15 May 2026 # LaTeX specific variables landscape: true copyright-text: "Copyright: see section \\texorpdfstring{{\\nameref{{copyright}}}}{{Copyright}}." @@ -128,6 +127,13 @@ for more information about Arm’s trademarks. | N | 06 June 2025 | 2025Q2 | | O | 15 May 2026 | 2026Q1 | +#### Continuously updated specification + +After 2026Q1, this specification is published continuously from the +main branch. Each published version is identified by its Git commit hash. + +See [Changes for year 2026](#changes-for-year-2026). + ### Changes between 2021Q2 and 2021Q3 * Fixed the guard macro for the base intrinsics. @@ -168,7 +174,7 @@ for more information about Arm’s trademarks. floating point conversion intrinsics from "Half Precision to 32-bit" and "Half Precision to 64-bit". -### Changes since 2026Q1 +### Changes for year 2026 * Added support for FEAT_F16F32DOT * Added support for FEAT_F16F32MM and FEAT_F16MM