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

[CONTRIBUTING] Add section on extension documents #169

Merged
merged 1 commit into from
Oct 15, 2024
Merged
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
35 changes: 35 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,41 @@ changes.
If you want to make ABI changes that for some reason can't be discussed in
public, you can send an email to arm.eabi@arm.com.

### Extension documents
While the majority of new proposals can be added to existing
documents. Proposals that extend the ABI, but are not yet stable are
placed in an extension document. An example of an extension document
is the PAuth Extension to ELF for Arm 64-bit Architecture. Extension
documents have the following requirements:

1. The document status must be Alpha.
2. The document has an owner recorded in the table below. The owner
need not be from Arm.
3. The document must not clash with other ABI extension documents, or
both extensions must be marked as being incompatible.


The Arm approval process for accepting the extension is as follows:

1. At least one person within Arm has reviewed and accepted the pull
request.
2. There is a consensus within Arm that the extension can be added to
the ABI.

Extension documents can move into the main ABI when the following conditions hold:

1. The information in the document is stable.
2. There is an implementation of the extension.
3. The boundaries of when the extension applies are clear.

An extension document that moves into the main ABI will add the
necessary information to the main documents. In addition any design
and rationale in the extension document will be moved to a new
document in the design-documents folder.

When the extension has either moved into the main ABI or has been
withdrawn it will be moved to an archive folder.

## Manual checking of the PDF documents and Continuous Integration

To check the outcome of your changes, run the `tools/rst2pdf/generate-pdfs.sh`
Expand Down