[ATfL] Add package documentation #248
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pawosm-arm
requested review from
DaftanoPro,
dcandler,
pratlucas,
robcow-arm and
schander-arm
pawosm-arm
force-pushed
the
users/pawosm-arm/atfl-package-docs
branch
from
a76c490 to
cdaf740
Compare
Contributor
Author
|
After merging, this needs to be cherry-picked to the release branch! |
pawosm-arm
force-pushed
the
users/pawosm-arm/atfl-package-docs
branch
2 times, most recently
from
9eea1bb to
0ec8ecc
Compare
Contributor
Author
|
Note: this whole thing will be rearranged, so it will be easier managing more of the content. |
pawosm-arm
force-pushed
the
users/pawosm-arm/atfl-package-docs
branch
10 times, most recently
from
ff15f47 to
b792c0f
Compare
DavidTruby
reviewed
Apr 2, 2025
pawosm-arm
force-pushed
the
users/pawosm-arm/atfl-package-docs
branch
from
b792c0f to
6b35bc1
Compare
tblah
reviewed
Apr 3, 2025
pawosm-arm
force-pushed
the
users/pawosm-arm/atfl-package-docs
branch
2 times, most recently
from
583ebf2 to
83e12fa
Compare
pawosm-arm
force-pushed
the
users/pawosm-arm/atfl-package-docs
branch
2 times, most recently
from
fde79a5 to
0dc82a5
Compare
pawosm-arm
force-pushed
the
users/pawosm-arm/atfl-package-docs
branch
2 times, most recently
from
07791f7 to
2a2f89d
Compare
This patch adds the ATfL package documentation which should land into: 1. Our on-line page(s) 2. Our release .deb packages 3. Our release .rpm packages The markdown documents introduced by this patch have landed into the arm-software/linux/docs directory. This follows the same guidance that has been already agreed for the ATfE product (see [1]). Additionally, an index.md file has been created which follows the convention already observed in the LLVM's documentation directories (e.g., [2]). The files from the arm-software/linux/docs directory are being copied into the arm/docs directory of the tarball and this is happening in the build.sh script also modified by this patch. Whatever lands into that directory, should act as a basis for further rendering of the on-line page(s) and the PDF document(s) in our CI pipelines. [1] https://github.com/arm/arm-toolchain/blob/arm-software/arm-software/docs/README.md [2] https://github.com/arm/arm-toolchain/blob/arm-software/flang/docs/index.md
pawosm-arm
force-pushed
the
users/pawosm-arm/atfl-package-docs
branch
from
2a2f89d to
26a2a51
Compare
tblah
approved these changes
Apr 4, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This patch adds the ATfL package documentation which should land into:
Our on-line page(s)
Our release .deb packages
Our release .rpm packages
The markdown documents introduced by this patch have landed into the
arm-software/linux/docs directory. This follows the same guidance
that has been already agreed for the ATfE product (see [1]).
Additionally, an index.md file has been created which follows the
convention already observed in the LLVM's documentation directories
(e.g., [2]).
The files from the arm-software/linux/docs directory are being copied
into the arm/docs directory of the tarball and this is happening in
the build.sh script also modified by this patch. Whatever lands into
that directory, should act as a basis for further rendering of the
on-line page(s) and the PDF document(s) in our CI pipelines.
[1] https://github.com/arm/arm-toolchain/blob/arm-software/arm-software/docs/README.md
[2] https://github.com/arm/arm-toolchain/blob/arm-software/flang/docs/index.md