-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Cleanup reference manual lmp section
`reference-manual/linux` pages were checked and edited for grammar, spelling, and style. Pages which were a better fit for the user-guide were relocated under lmP Customization; an index page for that section was also added. Cleanup and possible relocation of linux-updating was skipped to avoid merge conflicts. Redirects added for moved pages. QA steps: checked rendered html. Ran linter within editor. Ran linkcheck. No issues to report, however this is a relatively large commit. This commit addresses FFTK 2791 This commit addresses FFTK 1887 This commit addresses FFTK 1741 This commit addresses FFTK 1681 This commit applies to FFTK 1687 This commit applies to FFTK 2730 This commit applies to FFTK 2732 This commit applies to FFTK 2731 This commit applies to FFTK 1702 This commit applies to FFTK 988 This commit applies to FFTK 2733 Signed-off-by: Katrina Prosise <katrina.prosise@foundries.io>
- Loading branch information
Showing
25 changed files
with
643 additions
and
843 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,31 +1,34 @@ | ||
.. _ref-development-tags: | ||
|
||
Understanding Development FIO Tags | ||
Understanding FIO Development Tags | ||
================================== | ||
|
||
When Foundries.io adds a patch to a repository with an upstream, we add an ``FIO`` | ||
tag in the Git shortlog to make the commit easy to see. For example, in | ||
Foundries.io U-Boot tree:: | ||
When Foundries.io™ adds a patch to a repository with an upstream, we add a ``FIO`` tag in the Git shortlog. | ||
This makes the commit easier to see. | ||
For example, in our U-Boot tree:: | ||
|
||
[FIO internal] common: foundries.io verified boot utility | ||
|
||
The most common used tags through the Foundries.io repositories are: | ||
The most common tags used throughout the repositories are: | ||
|
||
* ``[FIO fromtree]``: patches cherry-picked, rather than merged, from upstream (mainline) | ||
* ``[FIO fromlist]``: patches submitted to upstream for review (in mailing lists, pending PRs etc.), and revisions to them | ||
* ``[FIO toup]``: patches that want to go upstream | ||
* ``[FIO temphack]`` or ``[FIO hack]``: temporary patches that keep things working for now but need a better solution later for upstreaming | ||
* ``[FIO extras]``: patches pulled in for specific functionality that are useful for subscribers, but not critical | ||
* ``[FIO temphack]`` or ``[FIO hack]``: temporary patches that keep things working for now, but need a better solution later for upstreaming | ||
* ``[FIO extras]``: non-critical patches pulled in for extra, potentially useful functionality | ||
* ``[FIO internal]``: patches needed by the LmP, not intended for upstream use | ||
* ``[FIO squash]``: patch should be squashed with an original patch, fixing possible issues in that patch. This tag requires a commit message tag "Fixes:" filled out properly | ||
* ``[FIO squash]``: patch should be squashed with an original patch, fixing possible issues in that patch. | ||
This tag requires a commit message tag ``Fixes:`` to be filled out properly | ||
|
||
There are also exceptional tags for patches that were cherry-picked/sent from/to SoC vendor forks: | ||
|
||
* ``[FIO from<vendor_name>]``: patches cherry-picked from ``<vendor_name>`` forked tree, for example ``[FIO fromnxp]`` | ||
* ``[FIO to<vendor_name>]``: patches, that want to go to SoC vendor forked tree, for example ``[FIO tostm]`` | ||
* ``[FIO to<vendor_name>-altered]``: exceptional case, when not a whole patch was cherry-picked, but rather some parts or it was completely reimplemented. In this case ``-altered`` is added, for example ``[FIO fromnxp-altered]`` | ||
* ``[FIO to<vendor_name>-altered]``: exceptional case, when not a whole patch was cherry-picked, but rather some parts or it was completely reimplemented. | ||
In this case ``-altered`` is added, for example ``[FIO fromnxp-altered]`` | ||
|
||
|
||
.. important:: When a patch is cherry-picked, the Git cherry-pick command should be invoked with ``-x`` (append commit name) parameter, so | ||
the original commit hash is added to the new commit message (for example ``(cherry-picked from commit 1e24c2671acdbcf81207c43da39e09846f404dc3)``). | ||
With a hash, tracking the original commit in a mainline/SoC vendor tree is much easier. | ||
.. important:: When a patch is cherry-picked, the Git cherry-pick command should be invoked with ``-x`` (append commit name) parameter. | ||
This is so that the original commit hash is added to the new commit message. | ||
For example, ``cherry-picked from commit 1e24c2671acdbcf81207c43da39e09846f404dc3``. | ||
With a hash, tracking the original commit in a mainline/SoC vendor tree is easier. |
This file contains 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
Oops, something went wrong.