Hi Yann,

 

I think we should get started with easy fixes (such as docs/plat/<platform>, adding path to header files to existing entries). Please push patches whenever you are ready.

For core/generic modules in TF-A that are missing maintainers, I will initiate a discussion internally within Arm and find volunteers who can serve the owners of the said modules. I will push patches to update the documentation to reflect the new owners.

I agree there are a lot of similarities between the doc page(docs/about/maintainers.rst) and the Gerrit reviewers’ plugin[1] that holds the list of reviewers for a specific module. Once we identify owners for orphan modules, we can update the plugin.

 

Hi Chris,

 

I am wondering how easy is it to set up the Github CODEOWNERS flow for TF-A. I think you can pursue it for the long term while we update the files manually in the short term. In general, we don’t get to see new generic/core modules being added to our project often. I feel that manually updating the reviewers' plugin and maintainers.rst is not that big of an effort.

 

[1] reviewers.config - TF-A/trusted-firmware-a - Gitiles (trustedfirmware.org)

 

Thanks,

Madhu

 

From: Chris Kay via TF-A <tf-a@lists.trustedfirmware.org>
Sent: Wednesday, April 17, 2024 7:51 AM
To: Yann Gautier <yann.gautier@foss.st.com>; tf-a@lists.trustedfirmware.org
Subject: [TF-A] Re: About unmaintained files

 

Hi Yann,

 

Perhaps it makes sense to use a GitHub CODEOWNERS file (https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners) and have the CI keep the Gerrit code owners list in sync with it? It’s quite machine-friendly so could also help us to monitor unmaintained parts of the repository automatically.

 

Regards,

Chris

 

From: Yann Gautier via TF-A <tf-a@lists.trustedfirmware.org>
Date: Wednesday, 17 April 2024 at 10:08
To: tf-a@lists.trustedfirmware.org <tf-a@lists.trustedfirmware.org>
Subject: [TF-A] About unmaintained files

Hello,

Recently I wondered who was the Code-Owner of the files in this patch:
fix(pmu): fix breakage on ARMv7 CPUs with SP_min as BL32
(https://review.trustedfirmware.org/c/TF-A/trusted-firmware-a/+/27162)
By the way it still doesn't have the Code-Owner review vote ;-)

But that triggered a more generic question about files and directories
in docs/about/maintainers.rst: are all the paths listed here reflect all
the files in TF-A repository?
The answer is unfortunately no.

I've then ended up writing some shell commands to try to list
unmaintained files:
for p in $(grep ^':|F|' docs/about/maintainers.rst | cut -d" " -f2 |
grep ^[a-zA-Z] | grep -v "drivers/nuvoton" | sed "s;\\\;;g"); do find $p
-type f >> /tmp/find_tf-a_maintained_files.txt; done; sort -u -o
/tmp/find_tf-a_maintained_files.txt{,}; git ls-files | sort -u >
/tmp/tf-a_files.txt; diff /tmp/find_tf-a_maintained_files.txt
/tmp/tf-a_files.txt > /tmp/tf-a_unmaintained_files.txt

Some are easy to correct, e.g. some docs/plat/<platform> files should be
added to the list of files for a given <platform>. Or some
include/drivers paths missing. I may push some patches for this if I
can. The drivers/nuvoton path is listed but it doesn't exist.
Some platforms or drivers are completely missing, and that would be good
their maintainers add a chapter for them.
But some generic & core files are also not listed. The goal of this mail
is to open the discussion about that.
That could be tricky as maintainer may change.
But all of that would ease the contributors way of working.


I've also seen that gerrit automatically adds Code-Owner for the review.
So it seems there is another list for that, and we could somehow try to
align those 2 lists.


Best regards,
Yann
--
TF-A mailing list -- tf-a@lists.trustedfirmware.org
To unsubscribe send an email to tf-a-leave@lists.trustedfirmware.org