Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Define new value for the __ARM_ACLE macro #294

Merged
merged 3 commits into from
Feb 14, 2024

Conversation

vhscampos
Copy link
Member

@vhscampos vhscampos commented Jan 29, 2024

The ACLE defines a feature macro called __ARM_ACLE:

__ARM_ACLE is defined to the version of this specification implemented, as 100 * major_version + minor_version. An implementation implementing version 2.1 of the ACLE specification will define __ARM_ACLE as 201.

However, a long time ago, we changed the versioning scheme of the ACLE from "major.minor" to a combination of year and quarter. For instance the latest release is 2023 Q2.

Since the macro's definition is now out of date, we now move to a new scheme:

__ARM_ACLE is defined to the version of this specification implemented, formatted as {YEAR}{QUARTER}{PATCH}.

The value would be the integer formed by the year (4 digits) concatenated to the quarter's number (1 digit), finally concatenated to the patch release (1 digit). So the macro's value for the 2023 Q2 release with no patch release would then be 202320. Using 4 digits for the year, and having it preceding the quarter, will be helpful to ensure the formed integer values will be greater than the ones using the previous/current format.

As for any pull request, please make sure to go through the below
checklist.

Checklist: (mark with X those which apply)

  • If an issue reporting the bug exists, I have mentioned it in the
    PR (do not bother creating the issue if all you want to do is
    fixing the bug yourself).
  • I have added/updated the SPDX-FileCopyrightText lines on top
    of any file I have edited. Format is SPDX-FileCopyrightText: Copyright {year} {entity or name} <{contact informations}>
    (Please update existing copyright lines if applicable. You can
    specify year ranges with hyphen , as in 2017-2019, and use
    commas to separate gaps, as in 2018-2020, 2022).
  • I have updated the Copyright section of the sources of the
    specification I have edited (this will show up in the text
    rendered in the PDF and other output format supported). The
    format is the same described in the previous item.
  • I have run the CI scripts (if applicable, as they might be
    tricky to set up on non-*nix machines). The sequence can be
    found in the contribution
    guidelines
    . Don't
    worry if you cannot run these scripts on your machine, your
    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
    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.
  • When modifying content and/or its rendering, I have checked the
    correctness of the result in the PDF output (please refer to the
    instructions on how to build the PDFs
    locally
    ).
  • 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 page of the project.

The ACLE defines a feature macro called __ARM_ACLE:

__ARM_ACLE is defined to the version of this specification implemented,
as 100 * major_version + minor_version. An implementation implementing
version 2.1 of the ACLE specification will define __ARM_ACLE as 201.

However, a long time ago, we changed the versioning scheme of the ACLE
from "major.minor" to a combination of year and quarter. For instance
the latest release is 2023 Q2.

Since the macro's definition is now out of date, we now move to a new
scheme:

`__ARM_ACLE` is defined to the version of this specification implemented,
formatted as `{YEAR}{QUARTER}{PATCH}`.

The value would be the integer formed by the year (4 digits)
concatenated to the quarter's number (1 digit), finally concatenated to
the patch release (1 digit). So the macro's value for the 2023 Q2
release with no patch release would then be 202320. Using 4 digits for
the year, and having it preceding the quarter, will be helpful to
ensure the formed integer values will be greater than the ones using the
previous/current format.
@vhscampos vhscampos linked an issue Jan 29, 2024 that may be closed by this pull request
@vhscampos vhscampos marked this pull request as ready for review January 29, 2024 14:43
@vhscampos
Copy link
Member Author

Also tagging @rearnsha for review

main/acle.md Outdated Show resolved Hide resolved
main/acle.md Show resolved Hide resolved
@vhscampos vhscampos merged commit 59c2d69 into ARM-software:main Feb 14, 2024
4 checks passed
@vhscampos vhscampos deleted the acle_macro branch February 14, 2024 09:38
hassnaaHamdi pushed a commit to hassnaaHamdi/ACLE that referenced this pull request Mar 11, 2024
The ACLE defines a feature macro called __ARM_ACLE:

__ARM_ACLE is defined to the version of this specification implemented,
as 100 * major_version + minor_version. An implementation implementing
version 2.1 of the ACLE specification will define __ARM_ACLE as 201.

However, a long time ago, we changed the versioning scheme of the ACLE
from "major.minor" to a combination of year and quarter. For instance
the latest release is 2023 Q2.

Since the macro's definition is now out of date, we now move to a new
scheme:

`__ARM_ACLE` is defined to the version of this specification implemented,
formatted as `{YEAR}{QUARTER}{PATCH}`.

The value would be the integer formed by the year (4 digits)
concatenated to the quarter's number (1 digit), finally concatenated to
the patch release (1 digit). So the macro's value for the 2023 Q2
release with no patch release would then be 202320. Using 4 digits for
the year, and having it preceding the quarter, will be helpful to
ensure the formed integer values will be greater than the ones using the
previous/current format.
Copy link
Contributor

@sallyarmneale sallyarmneale left a comment

Choose a reason for hiding this comment

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

No changes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] __ARM_ACLE macro definition is outdated
4 participants