Merge "fix(docs): fix some broken links" into integration

fix(docs): fix some broken links

Fix few broken links from docs.

Link check was done with following steps -

[..]
tf-a/docs$ make clean -j8; poetry run make html -j8
tf-a/docs$ poetry run sphinx-bu

fix(docs): fix some broken links

Fix few broken links from docs.

Link check was done with following steps -

[..]
tf-a/docs$ make clean -j8; poetry run make html -j8
tf-a/docs$ poetry run sphinx-build -j8 -q -b linkcheck . build/
[..]

Add link check conf values to config.py
- avoid reporting false broken links when `#`(anchors) are present
in the link.
- avoid checking for broken links in "change-log.md", this is summary
of commit msg's we are not going to fix broken links in cmt-msg's

Change-Id: I384094c8dcf3e93875c9052afa79ad826b9901d9
Signed-off-by: Govindraj Raja <govindraj.raja@arm.com>

show more ...

Merge "docs: remove reference to phabricator pages" into integration

docs: remove reference to phabricator pages

Phabricator wiki is deprecated, remove TF-A links to this website.

Signed-off-by: Olivier Deprez <olivier.deprez@arm.com>
Change-Id: I1255a1513524504636b

docs: remove reference to phabricator pages

Phabricator wiki is deprecated, remove TF-A links to this website.

Signed-off-by: Olivier Deprez <olivier.deprez@arm.com>
Change-Id: I1255a1513524504636b9c914f9dacf3c54063196

show more ...

Merge "docs(contributing): various improvements" into integration

docs(contributing): various improvements

- Warn contributors that they need to register their email address in
their Gerrit profile. Not doing so causes errors at patch submission
and is a re

docs(contributing): various improvements

- Warn contributors that they need to register their email address in
their Gerrit profile. Not doing so causes errors at patch submission
and is a recurrent question on the mailing list.

- Add some links where useful.

- Remove confusing CGit link to TF-A source code. In the context of
setting up a local copy of the repo for contributing patches,
developers should rather clone it through Gerrit and this is best
covered by the "Getting the TF-A Source" section of TF-A
documentation.

- Add references to the OpenCI documentation, which has a lot more
details on some of the topics we briefly cover in the contribution
guidelines.

- Encourage the user to use the 'git review' command for patch
submission, inline with OpenCI documentation instructions. This
automatically sorts out which Gerrit server to push to and against
which repo branch (thanks to the '.gitreview' configuration file in
TF-A root directory).

- Elaborate the Coverity Scan section.

Signed-off-by: Sandrine Bailleux <sandrine.bailleux@arm.com>
Change-Id: I1131662d8bc3502967b269a599869ea130897efb

show more ...

Merge "docs: fix mailing lists URLs" into integration

docs: fix mailing lists URLs

With the transition to mailman3, the URLs of TF-A and TF-A Tests
mailing lists have changed. However, we still refer to the old
location, which are now dead links.

Upda

docs: fix mailing lists URLs

With the transition to mailman3, the URLs of TF-A and TF-A Tests
mailing lists have changed. However, we still refer to the old
location, which are now dead links.

Update all relevant links throughout the documentation.

There is one link referring to a specific thread on the TF-A mailing
list in the SPM documentation, for which I had to make a guess as to
what's the equivalent mailman3 URL. The old URL scheme indicates that
the thread dates from February 2020 but beyond that, I could not make
sense of the thread id within the old URL so I picked the most likely
match amongst the 3 emails posted on the subject in this time period.

Signed-off-by: Sandrine Bailleux <sandrine.bailleux@arm.com>
Reported-by: Kuohong Wang <kuohong.wang@mediatek.com>
Change-Id: I83f4843afd1dd46f885df225931d8458152dbb58

show more ...

Merge "docs(contribution-guidelines): updated the build configuration section" into integration

docs(contribution-guidelines): updated the build configuration section

Added a couple of sub-sections (Coverity Scan and Test Configuration)
under "Add build configuration" to update the patch owner

docs(contribution-guidelines): updated the build configuration section

Added a couple of sub-sections (Coverity Scan and Test Configuration)
under "Add build configuration" to update the patch owners on the
sections they need to be aware of while introducing new source files.

Signed-off-by: Jayanth Dodderi Chidanand <jayanthdodderi.chidanand@arm.com>
Change-Id: I84adb182f9633863aac864df43578249c2269c1e

show more ...

Merge changes from topic "ck/changelog" into integration

* changes:
docs(changelog): categorize scopes
docs(commit-style): add commit style documentation
build(docs): introduce release script

Merge changes from topic "ck/changelog" into integration

* changes:
docs(changelog): categorize scopes
docs(commit-style): add commit style documentation
build(docs): introduce release script
build(docs): add support for Markdown documentation
build(hooks): add commitlint checks for trailers
build(npm): add Standard Version v9.3.2
build(npm): add additional package metadata
build(npm): add license field
build(npm): update Husky to v7.0.4
build(npm): update commitlint to v14.1.0
build(npm): update lockfile format to v2
docs(prerequisites): update to Node.js v16
build(docs): update Python dependencies
build(docs): pin Python dependencies

show more ...

docs(commit-style): add commit style documentation

This change adds a new documentation page describing the commit style,
acceptable Conventional Commits types and scopes, and documents the
process

docs(commit-style): add commit style documentation

This change adds a new documentation page describing the commit style,
acceptable Conventional Commits types and scopes, and documents the
process for expanding the list of scopes.

Change-Id: Iad957b67fa71a879e8aa0790c58a5b08cec300d6
Signed-off-by: Chris Kay <chris.kay@arm.com>

show more ...

Merge "fix(docs-contributing.rst): fix formatting for code snippet" into integration

fix(docs-contributing.rst): fix formatting for code snippet

This patch will fix the formatting errors concerning code snippet,
lines 245 and 256 respectively.
The code snippet is updated to 'shell'

fix(docs-contributing.rst): fix formatting for code snippet

This patch will fix the formatting errors concerning code snippet,
lines 245 and 256 respectively.
The code snippet is updated to 'shell' to lex it appropriately.

Signed-off-by: Jayanth Dodderi Chidanand <jayanthdodderi.chidanand@arm.com>
Change-Id: I53aefd81da350b6511e7a97b5fee7b0d6f9dde2d

show more ...

Merge "docs(contribution-guidelines): add coverity build configuration section" into integration

docs(contribution-guidelines): add coverity build configuration section

Added a sub-section in the "Processes and Policies" chapter under
Contributor's guide on how to add new build configurations w

docs(contribution-guidelines): add coverity build configuration section

Added a sub-section in the "Processes and Policies" chapter under
Contributor's guide on how to add new build configurations when new
source files are added to the TF-A repository. This will help the patch
contributor to update their files to get analysed by Coverity Scan.

Signed-off-by: Jayanth Dodderi Chidanand <jayanthdodderi.chidanand@arm.com>
Change-Id: I71f410a061028f89bd0e984e48e61e5935616d71

show more ...

Merge changes from topic "ck/conventional-commits" into integration

* changes:
build(hooks): add commitlint hook
build(hooks): add Commitizen hook
build(hooks): add Gerrit hook
build(hooks):

Merge changes from topic "ck/conventional-commits" into integration

* changes:
build(hooks): add commitlint hook
build(hooks): add Commitizen hook
build(hooks): add Gerrit hook
build(hooks): add Husky configuration

show more ...

build(hooks): add commitlint hook

This change adds a configuration for commitlint - a tool designed to
enforce a particular commit message style - and run it as part of Git's
commit-msg hook. This v

build(hooks): add commitlint hook

This change adds a configuration for commitlint - a tool designed to
enforce a particular commit message style - and run it as part of Git's
commit-msg hook. This validates commits immediately after the editor has
been exited, and the configuration is derived from the configuration we
provide to Commitizen.

While the configuration provided suggests a maximum header and body
length, neither of these are hard errors. This is to accommodate the
occasional commit where it may be difficult or impossible to comply
with the length requirements (for example, with a particularly long
scope, or a long URL in the message body).

Change-Id: Ib5e90472fd1f1da9c2bff47703c9682232ee5679
Signed-off-by: Chris Kay <chris.kay@arm.com>

show more ...

Merge "docs: code review guidelines" into integration

docs: code review guidelines

Document the code review process in TF-A.
Specifically:

* Give an overview of code review and best practices.
* Give guidelines for the participants in code review.

docs: code review guidelines

Document the code review process in TF-A.
Specifically:

* Give an overview of code review and best practices.
* Give guidelines for the participants in code review.
* Outline responsibilities of each type of participant.
* Explain the Gerrit labels used in the review process.

Change-Id: I519ca4b2859601a7b897706e310f149a0c92e390
Signed-off-by: Sandrine Bailleux <sandrine.bailleux@arm.com>
Signed-off-by: David Horstmann <david.horstmann@arm.com>

show more ...

Merge "doc: Improve contribution guidelines" into integration

doc: Improve contribution guidelines

- Add some guidance about the type of information a patch author should
provide to facilitate the review (and for future reference).

- Make a number of implic

doc: Improve contribution guidelines

- Add some guidance about the type of information a patch author should
provide to facilitate the review (and for future reference).

- Make a number of implicit expectations explicit:
- Every patch must compile.
- All CI tests must pass.

- Mention that the patch author is expected to add reviewers and explain
how to choose them.

- Explain the patch submission rules in terms of Gerrit labels.

Also do some cosmetic changes, like adding empty lines, shuffling some
paragraphs around.

Change-Id: I6dac486684310b5a35aac7353e10fe5474a81ec5
Signed-off-by: Sandrine Bailleux <sandrine.bailleux@arm.com>

show more ...

Merge "doc: Refactor the contribution guidelines" into integration

Merge "doc: Stop advising the creation of Phabricator issues" into integration

doc: Refactor the contribution guidelines

Ensuring that each file changed by a patch has the correct copyright and
license information does not only apply to documentation files but to
all files wit

doc: Refactor the contribution guidelines

Ensuring that each file changed by a patch has the correct copyright and
license information does not only apply to documentation files but to
all files within the source tree.

Move the guidance for copyright and license headers out of the paragraph
about updating the documentation to avoid any confusion.

Also do some cosmetic changes (adding empty lines, fitting in longer
lines in the 80-column limit, ...) to improve the readability of the RST
file.

Change-Id: I241a2089ca9db70f5a9f26b7070b947674b43265
Signed-off-by: Sandrine Bailleux <sandrine.bailleux@arm.com>

show more ...