| Okash Khawaja | 671bed2 | 2022-11-10 15:51:19 +0000 | [diff] [blame] | 1 | This directory contains code related to long-term support management of TF-A. |
| 2 | |
| 3 | lts-triage.py |
| 4 | ============= |
| 5 | |
| 6 | Purpose of this script is to check a patch and determine if that patch qualifies |
| 7 | as a candidate for one of the LTS branches. |
| 8 | |
| 9 | Currently it focuses on cpu errata while it contains basic support for security |
| 10 | patches. It computes a crude score: |
| 11 | |
| 12 | 1 point if subject line matches tokens for cpu errata or security |
| 13 | 1 point for "report_errata ERRATA" in a lib/cpus/aarch{32,64}/*.S file |
| 14 | 1 point for "- ``ERRATA_" in docs/design/cpu-specific-build-macros.rst file |
| 15 | |
| 16 | Note that the script only looks at commits which are not merge commits. |
| 17 | |
| Okash Khawaja | 66a3a7e | 2023-01-24 11:06:16 +0000 | [diff] [blame^] | 18 | The script expects two branches: 'integration' and 'to_check'. 'integration' is |
| 19 | the actual integration branch of the TF-A project while 'to_check' points to the |
| 20 | tip of latest patch in the patchset that was submitted. |
| 21 | |
| 22 | The script needs to work out how many commits are in the current patchset which |
| 23 | will be the ones it needs to triage. In order to do that the script looks at two |
| 24 | parameters which are currently fixed in code. We can turn them into args if needed. |
| 25 | First is REBASE_DEPTH which is the number of commits in integration branch to look |
| 26 | for the common commit between patchset and integration branch. Second parameter is |
| 27 | MAX_PATCHSET_DEPTH which is the maximum number of commits we expect in the patchset |
| 28 | submitted. |
| 29 | |
| Okash Khawaja | 671bed2 | 2022-11-10 15:51:19 +0000 | [diff] [blame] | 30 | Running it: |
| 31 | ----------- |
| 32 | |
| 33 | To run it, provide it a path to a TF-A git repo. Here's help output for convenience: |
| 34 | |
| 35 | $ python lts/lts-triage.py -h |
| Okash Khawaja | 66a3a7e | 2023-01-24 11:06:16 +0000 | [diff] [blame^] | 36 | usage: lts-triage.py [-h] --repo REPO [--debug] |
| Okash Khawaja | 671bed2 | 2022-11-10 15:51:19 +0000 | [diff] [blame] | 37 | |
| 38 | check patches for LTS candidacy |
| 39 | |
| 40 | options: |
| 41 | -h, --help show this help message and exit |
| 42 | --repo REPO path to tf-a git repo |
| Okash Khawaja | 671bed2 | 2022-11-10 15:51:19 +0000 | [diff] [blame] | 43 | --debug print debug logs |
| 44 | |
| Okash Khawaja | 66a3a7e | 2023-01-24 11:06:16 +0000 | [diff] [blame^] | 45 | |
| Okash Khawaja | 671bed2 | 2022-11-10 15:51:19 +0000 | [diff] [blame] | 46 | Below is an example output. On left is commit hash of each of the commits |
| 47 | observed by this script and on right is score assigned to it. |
| 48 | |
| 49 | $ python lts/lts-triage.py --repo ../trusted-firmware-a/ |
| 50 | 888eafa00b99aa06b4ff688407336811a7ff439a: 3 |
| 51 | 79544126943a90d31d81177655be11f75330ffed: 3 |
| 52 | 43438ad1ad6651964e9ae75d35f40aed8d86d088: 3 |
| 53 | 028c4e42d8f632d40081b88f66d0d05c7d7c9b23: 0 |
| 54 | 20155112c5d2fb296fef40a12b1c6ce12f49b1c8: 0 |
| 55 | 4090ac33f44bd24d73161032faa817eb03f2e41d: 0 |
| 56 | cf58b2d41cb0d24239b98de98264b31690711549: 0 |
| 57 | e74d658181e5e69b6b5e16b40adc1ffef4c1efb9: 1 |
| 58 | ad6eb1951b986f30635025bbdf29e257b6b1e362: 0 |
| 59 | 8a6a9560b5dcccfb68064c0c8c9b4b47981c6ac7: 0 |
| 60 | 93cec697deb654303379cae8f25a31dc8b90cd31: 0 |
| 61 | a194255d75ed9e2ef56bd6e14349a3e7d86af934: 0 |
| 62 | 98a43d9f6c22498d9e1a6e7ace1bc6d23ac58d5a: 0 |
| 63 | 07dc8ba93b319de2bf0be0c287373db74019878e: 0 |
| 64 | c6877763cd3a286983df160c8207368174c1b820: 0 |
| 65 | 03ebf409c711e9f2006cedded7dc415dfe566975: 1 |
| 66 | de7e9b562afccd6d71df1abf1907f48d164a3a7e: 0 |
| 67 | 720e7b66f2353ef7ed32a8f85f8396fbc0766ffc: 0 |
| 68 | 62a93aa7afcd022f06d322c36979f0aa02713beb: 0 |
| 69 | b5f06d3dfad8c27bdf528b083ef919ce4022c52d: 0 |