2019-03-07 15:47:15 +00:00
|
|
|
Contributor's Guide
|
|
|
|
|
===================
|
2017-06-28 15:23:03 +01:00
|
|
|
|
|
|
|
|
Getting Started
|
|
|
|
|
---------------
|
|
|
|
|
|
2020-05-12 09:36:05 +01:00
|
|
|
- Make sure you have a Github account and you are logged on both
|
|
|
|
|
`developer.trustedfirmware.org`_ and `review.trustedfirmware.org`_.
|
2017-06-28 15:23:03 +01:00
|
|
|
|
2020-08-03 09:27:19 +01:00
|
|
|
- If you plan to contribute a major piece of work, it is usually a good idea to
|
|
|
|
|
start a discussion around it on the mailing list. This gives everyone
|
|
|
|
|
visibility of what is coming up, you might learn that somebody else is
|
|
|
|
|
already working on something similar or the community might be able to
|
|
|
|
|
provide some early input to help shaping the design of the feature.
|
|
|
|
|
|
|
|
|
|
If you intend to include Third Party IP in your contribution, please mention
|
|
|
|
|
it explicitly in the email thread and ensure that the changes that include
|
|
|
|
|
Third Party IP are made in a separate patch (or patch series).
|
2017-06-28 15:23:03 +01:00
|
|
|
|
2019-05-29 13:59:40 +01:00
|
|
|
- Clone `Trusted Firmware-A`_ on your own machine as described in
|
|
|
|
|
:ref:`prerequisites_get_source`.
|
2020-08-12 10:29:46 +01:00
|
|
|
|
2019-05-28 13:13:39 +01:00
|
|
|
- Create a local topic branch based on the `Trusted Firmware-A`_ ``master``
|
2017-06-28 15:23:03 +01:00
|
|
|
branch.
|
|
|
|
|
|
|
|
|
|
Making Changes
|
|
|
|
|
--------------
|
|
|
|
|
|
|
|
|
|
- Make commits of logical units. See these general `Git guidelines`_ for
|
|
|
|
|
contributing to a project.
|
2020-08-12 10:29:46 +01:00
|
|
|
|
2019-05-16 13:33:18 +01:00
|
|
|
- Follow the :ref:`Coding Style` and :ref:`Coding Guidelines`.
|
2017-06-28 15:23:03 +01:00
|
|
|
|
|
|
|
|
- Use the checkpatch.pl script provided with the Linux source tree. A
|
2019-05-29 13:59:40 +01:00
|
|
|
Makefile target is provided for convenience.
|
2017-06-28 15:23:03 +01:00
|
|
|
|
|
|
|
|
- Keep the commits on topic. If you need to fix another bug or make another
|
2020-08-03 09:27:19 +01:00
|
|
|
enhancement, please address it on a separate topic branch.
|
2020-08-12 10:29:46 +01:00
|
|
|
|
2017-06-28 15:23:03 +01:00
|
|
|
- Avoid long commit series. If you do have a long series, consider whether
|
|
|
|
|
some commits should be squashed together or addressed in a separate topic.
|
2020-08-12 10:29:46 +01:00
|
|
|
|
2017-06-28 15:23:03 +01:00
|
|
|
- Make sure your commit messages are in the proper format. If a commit fixes
|
2019-03-22 11:47:22 +00:00
|
|
|
an `issue`_, include a reference.
|
2017-06-28 15:23:03 +01:00
|
|
|
|
2020-08-12 10:29:46 +01:00
|
|
|
- Where appropriate, please update the documentation.
|
2017-06-28 15:23:03 +01:00
|
|
|
|
2020-08-12 10:29:46 +01:00
|
|
|
- Consider whether the :ref:`Porting Guide`, :ref:`Firmware Design` document
|
|
|
|
|
or other in-source documentation needs updating.
|
2017-06-28 15:23:03 +01:00
|
|
|
|
2020-05-12 09:36:05 +01:00
|
|
|
- If you are submitting new files that you intend to be the code owner for
|
|
|
|
|
(for example, a new platform port), then also update the
|
|
|
|
|
:ref:`code owners` file.
|
2020-08-12 10:29:46 +01:00
|
|
|
|
|
|
|
|
- For topics with multiple commits, you should make all documentation changes
|
|
|
|
|
(and nothing else) in the last commit of the series. Otherwise, include
|
|
|
|
|
the documentation changes within the single commit.
|
|
|
|
|
|
|
|
|
|
- Ensure that each changed file has the correct copyright and license
|
|
|
|
|
information. Files that entirely consist of contributions to this project
|
|
|
|
|
should have a copyright notice and BSD-3-Clause SPDX license identifier of
|
|
|
|
|
the form as shown in :ref:`license`. Files that contain changes to imported
|
|
|
|
|
Third Party IP files should retain their original copyright and license
|
|
|
|
|
notices.
|
|
|
|
|
|
|
|
|
|
For significant contributions you may add your own copyright notice in the
|
|
|
|
|
following format:
|
|
|
|
|
|
|
|
|
|
::
|
|
|
|
|
|
|
|
|
|
Portions copyright (c) [XXXX-]YYYY, <OWNER>. All rights reserved.
|
|
|
|
|
|
|
|
|
|
where XXXX is the year of first contribution (if different to YYYY) and YYYY
|
|
|
|
|
is the year of most recent contribution. <OWNER> is your name or your company
|
|
|
|
|
name.
|
2017-06-28 15:23:03 +01:00
|
|
|
|
2019-03-22 11:47:22 +00:00
|
|
|
- Please test your changes. As a minimum, ensure that Linux boots on the
|
2019-05-29 13:59:40 +01:00
|
|
|
Foundation FVP. See :ref:`Arm Fixed Virtual Platforms (FVP)` for more
|
|
|
|
|
information. For more extensive testing, consider running the `TF-A Tests`_
|
|
|
|
|
against your patches.
|
2017-06-28 15:23:03 +01:00
|
|
|
|
|
|
|
|
Submitting Changes
|
|
|
|
|
------------------
|
|
|
|
|
|
|
|
|
|
- Ensure that each commit in the series has at least one ``Signed-off-by:``
|
|
|
|
|
line, using your real name and email address. The names in the
|
2019-03-22 11:47:22 +00:00
|
|
|
``Signed-off-by:`` and ``Author:`` lines must match. If anyone else
|
|
|
|
|
contributes to the commit, they must also add their own ``Signed-off-by:``
|
|
|
|
|
line. By adding this line the contributor certifies the contribution is made
|
doc: Convert internal links to RST format
Currently links between documents are using the format:
<path/to/><filename>.rst
This was required for services like GitHub because they render each
document in isolation - linking to another document is like linking
to any other file, just provide the full path.
However, with the new approach, the .rst files are only the raw
source for the documents. Once the documents have been rendered
the output is now in another format (HTML in our case) and so,
when linking to another document, the link must point to the
rendered version and not the .rst file.
The RST spec provides a few methods for linking between content.
The parent of this patch enabled the automatic creation of anchors
for document titles - we will use these anchors as the targets for
our links. Additional anchors can be added by hand if needed, on
section and sub-section titles, for example.
An example of this new format, for a document with the title
"Firmware Design" is :ref:`Firmware Design`.
One big advantage of this is that anchors are not dependent on
paths. We can then move documents around, even between directories,
without breaking any links between documents. Links will need to be
updated only if the title of a document changes.
Change-Id: I9e2340a61dd424cbd8fd1ecc2dc166f460d81703
Signed-off-by: Paul Beesley <paul.beesley@arm.com>
2019-04-12 14:19:42 +01:00
|
|
|
under the terms of the
|
|
|
|
|
:download:`Developer Certificate of Origin <../../dco.txt>`.
|
2019-03-22 11:47:22 +00:00
|
|
|
|
|
|
|
|
More details may be found in the `Gerrit Signed-off-by Lines guidelines`_.
|
|
|
|
|
|
|
|
|
|
- Ensure that each commit also has a unique ``Change-Id:`` line. If you have
|
|
|
|
|
cloned the repository with the "`Clone with commit-msg hook`" clone method
|
2019-05-29 13:59:40 +01:00
|
|
|
(following the :ref:`Prerequisites` document), this should already be the
|
|
|
|
|
case.
|
2019-03-22 11:47:22 +00:00
|
|
|
|
|
|
|
|
More details may be found in the `Gerrit Change-Ids documentation`_.
|
|
|
|
|
|
|
|
|
|
- Submit your changes for review at https://review.trustedfirmware.org
|
|
|
|
|
targeting the ``integration`` branch.
|
|
|
|
|
|
|
|
|
|
- The changes will then undergo further review and testing by the
|
2020-05-12 09:36:05 +01:00
|
|
|
:ref:`code owners` and :ref:`maintainers`. Any review comments will be
|
|
|
|
|
made directly on your patch. This may require you to do some rework. For
|
|
|
|
|
controversial changes, the discussion might be moved to the `TF-A mailing
|
|
|
|
|
list`_ to involve more of the community.
|
2017-06-28 15:23:03 +01:00
|
|
|
|
2019-03-22 11:47:22 +00:00
|
|
|
Refer to the `Gerrit Uploading Changes documentation`_ for more details.
|
2017-06-28 15:23:03 +01:00
|
|
|
|
doc: Convert internal links to RST format
Currently links between documents are using the format:
<path/to/><filename>.rst
This was required for services like GitHub because they render each
document in isolation - linking to another document is like linking
to any other file, just provide the full path.
However, with the new approach, the .rst files are only the raw
source for the documents. Once the documents have been rendered
the output is now in another format (HTML in our case) and so,
when linking to another document, the link must point to the
rendered version and not the .rst file.
The RST spec provides a few methods for linking between content.
The parent of this patch enabled the automatic creation of anchors
for document titles - we will use these anchors as the targets for
our links. Additional anchors can be added by hand if needed, on
section and sub-section titles, for example.
An example of this new format, for a document with the title
"Firmware Design" is :ref:`Firmware Design`.
One big advantage of this is that anchors are not dependent on
paths. We can then move documents around, even between directories,
without breaking any links between documents. Links will need to be
updated only if the title of a document changes.
Change-Id: I9e2340a61dd424cbd8fd1ecc2dc166f460d81703
Signed-off-by: Paul Beesley <paul.beesley@arm.com>
2019-04-12 14:19:42 +01:00
|
|
|
- When the changes are accepted, the :ref:`maintainers` will integrate them.
|
2017-06-28 15:23:03 +01:00
|
|
|
|
doc: Convert internal links to RST format
Currently links between documents are using the format:
<path/to/><filename>.rst
This was required for services like GitHub because they render each
document in isolation - linking to another document is like linking
to any other file, just provide the full path.
However, with the new approach, the .rst files are only the raw
source for the documents. Once the documents have been rendered
the output is now in another format (HTML in our case) and so,
when linking to another document, the link must point to the
rendered version and not the .rst file.
The RST spec provides a few methods for linking between content.
The parent of this patch enabled the automatic creation of anchors
for document titles - we will use these anchors as the targets for
our links. Additional anchors can be added by hand if needed, on
section and sub-section titles, for example.
An example of this new format, for a document with the title
"Firmware Design" is :ref:`Firmware Design`.
One big advantage of this is that anchors are not dependent on
paths. We can then move documents around, even between directories,
without breaking any links between documents. Links will need to be
updated only if the title of a document changes.
Change-Id: I9e2340a61dd424cbd8fd1ecc2dc166f460d81703
Signed-off-by: Paul Beesley <paul.beesley@arm.com>
2019-04-12 14:19:42 +01:00
|
|
|
- Typically, the :ref:`maintainers` will merge the changes into the
|
2019-03-22 11:47:22 +00:00
|
|
|
``integration`` branch.
|
|
|
|
|
- If the changes are not based on a sufficiently-recent commit, or if they
|
doc: Convert internal links to RST format
Currently links between documents are using the format:
<path/to/><filename>.rst
This was required for services like GitHub because they render each
document in isolation - linking to another document is like linking
to any other file, just provide the full path.
However, with the new approach, the .rst files are only the raw
source for the documents. Once the documents have been rendered
the output is now in another format (HTML in our case) and so,
when linking to another document, the link must point to the
rendered version and not the .rst file.
The RST spec provides a few methods for linking between content.
The parent of this patch enabled the automatic creation of anchors
for document titles - we will use these anchors as the targets for
our links. Additional anchors can be added by hand if needed, on
section and sub-section titles, for example.
An example of this new format, for a document with the title
"Firmware Design" is :ref:`Firmware Design`.
One big advantage of this is that anchors are not dependent on
paths. We can then move documents around, even between directories,
without breaking any links between documents. Links will need to be
updated only if the title of a document changes.
Change-Id: I9e2340a61dd424cbd8fd1ecc2dc166f460d81703
Signed-off-by: Paul Beesley <paul.beesley@arm.com>
2019-04-12 14:19:42 +01:00
|
|
|
cannot be automatically rebased, then the :ref:`maintainers` may rebase it
|
2020-05-12 09:36:05 +01:00
|
|
|
on the ``integration`` branch or ask you to do so.
|
2019-03-22 11:47:22 +00:00
|
|
|
- After final integration testing, the changes will make their way into the
|
2020-05-12 09:36:05 +01:00
|
|
|
``master`` branch. If a problem is found during integration, the
|
|
|
|
|
:ref:`maintainers` will request your help to solve the issue. They may
|
|
|
|
|
revert your patches and ask you to resubmit a reworked version of them or
|
|
|
|
|
they may ask you to provide a fix-up patch.
|
2017-06-28 15:23:03 +01:00
|
|
|
|
2019-04-19 00:47:46 +01:00
|
|
|
Binary Components
|
|
|
|
|
-----------------
|
|
|
|
|
|
|
|
|
|
- Platforms may depend on binary components submitted to the `Trusted Firmware
|
|
|
|
|
binary repository`_ if they require code that the contributor is unable or
|
|
|
|
|
unwilling to open-source. This should be used as a rare exception.
|
|
|
|
|
- All binary components must follow the contribution guidelines (in particular
|
|
|
|
|
licensing rules) outlined in the `readme.rst <tf-binaries-readme_>`_ file of
|
|
|
|
|
the binary repository.
|
|
|
|
|
- Binary components must be restricted to only the specific functionality that
|
|
|
|
|
cannot be open-sourced and must be linked into a larger open-source platform
|
|
|
|
|
port. The majority of the platform port must still be implemented in open
|
|
|
|
|
source. Platform ports that are merely a thin wrapper around a binary
|
|
|
|
|
component that contains all the actual code will not be accepted.
|
|
|
|
|
- Only platform port code (i.e. in the ``plat/<vendor>`` directory) may rely on
|
|
|
|
|
binary components. Generic code must always be fully open-source.
|
|
|
|
|
|
2017-06-28 15:23:03 +01:00
|
|
|
--------------
|
|
|
|
|
|
2019-05-16 13:33:18 +01:00
|
|
|
*Copyright (c) 2013-2020, Arm Limited and Contributors. All rights reserved.*
|
2017-06-28 15:23:03 +01:00
|
|
|
|
2019-03-22 11:47:22 +00:00
|
|
|
.. _developer.trustedfirmware.org: https://developer.trustedfirmware.org
|
2020-05-12 09:36:05 +01:00
|
|
|
.. _review.trustedfirmware.org: https://review.trustedfirmware.org
|
2019-03-22 11:47:22 +00:00
|
|
|
.. _issue: https://developer.trustedfirmware.org/project/board/1/
|
2019-05-28 13:13:39 +01:00
|
|
|
.. _Trusted Firmware-A: https://git.trustedfirmware.org/TF-A/trusted-firmware-a.git
|
2017-06-28 15:23:03 +01:00
|
|
|
.. _Git guidelines: http://git-scm.com/book/ch5-2.html
|
2019-03-22 11:47:22 +00:00
|
|
|
.. _Gerrit Uploading Changes documentation: https://review.trustedfirmware.org/Documentation/user-upload.html
|
|
|
|
|
.. _Gerrit Signed-off-by Lines guidelines: https://review.trustedfirmware.org/Documentation/user-signedoffby.html
|
|
|
|
|
.. _Gerrit Change-Ids documentation: https://review.trustedfirmware.org/Documentation/user-changeid.html
|
2020-05-12 09:36:05 +01:00
|
|
|
.. _TF-A Tests: https://trustedfirmware-a-tests.readthedocs.io
|
2019-04-19 00:47:46 +01:00
|
|
|
.. _Trusted Firmware binary repository: https://review.trustedfirmware.org/admin/repos/tf-binaries
|
|
|
|
|
.. _tf-binaries-readme: https://git.trustedfirmware.org/tf-binaries.git/tree/readme.rst
|
2020-05-12 09:36:05 +01:00
|
|
|
.. _TF-A mailing list: https://lists.trustedfirmware.org/mailman/listinfo/tf-a
|
