2016-09-12 22:54:55 +02:00
|
|
|
// -*- mode:doc; -*-
|
|
|
|
|
// vim: set syntax=asciidoc:
|
|
|
|
|
|
|
|
|
|
[[DEVELOPERS]]
|
|
|
|
|
== DEVELOPERS file and get-developers
|
|
|
|
|
|
|
|
|
|
The main Buildroot directory contains a file named +DEVELOPERS+ that
|
2016-09-21 23:43:00 +02:00
|
|
|
lists the developers involved with various areas of Buildroot. Thanks
|
2019-01-03 21:47:47 +01:00
|
|
|
to this file, the +get-developers+ tool allows to:
|
2016-09-12 22:54:55 +02:00
|
|
|
|
|
|
|
|
- Calculate the list of developers to whom patches should be sent, by
|
|
|
|
|
parsing the patches and matching the modified files with the
|
|
|
|
|
relevant developers. See xref:submitting-patches[] for details.
|
|
|
|
|
|
|
|
|
|
- Find which developers are taking care of a given architecture or
|
|
|
|
|
package, so that they can be notified when a build failure occurs on
|
|
|
|
|
this architecture or package. This is done in interaction with
|
|
|
|
|
Buildroot's autobuild infrastructure.
|
|
|
|
|
|
|
|
|
|
We ask developers adding new packages, new boards, or generally new
|
|
|
|
|
functionality in Buildroot, to register themselves in the +DEVELOPERS+
|
|
|
|
|
file. As an example, we expect a developer contributing a new package
|
|
|
|
|
to include in his patch the appropriate modification to the
|
|
|
|
|
+DEVELOPERS+ file.
|
|
|
|
|
|
|
|
|
|
The +DEVELOPERS+ file format is documented in detail inside the file
|
|
|
|
|
itself.
|
|
|
|
|
|
2019-01-03 21:47:47 +01:00
|
|
|
The +get-developers+ tool, located in +utils/+ allows to use
|
2016-09-12 22:54:55 +02:00
|
|
|
the +DEVELOPERS+ file for various tasks:
|
|
|
|
|
|
|
|
|
|
- When passing one or several patches as command line argument,
|
2019-01-03 21:47:47 +01:00
|
|
|
+get-developers+ will return the appropriate +git send-email+
|
2018-10-09 10:28:31 +02:00
|
|
|
command. If the +-e+ option is passed, only the email addresses are
|
|
|
|
|
printed in a format suitable for +git send-email --cc-cmd+.
|
2016-09-12 22:54:55 +02:00
|
|
|
|
2019-01-03 21:47:47 +01:00
|
|
|
- When using the +-a <arch>+ command line option, +get-developers+ will
|
2016-09-12 22:54:55 +02:00
|
|
|
return the list of developers in charge of the given architecture.
|
|
|
|
|
|
2019-01-03 21:47:47 +01:00
|
|
|
- When using the +-p <package>+ command line option, +get-developers+
|
2016-09-12 22:54:55 +02:00
|
|
|
will return the list of developers in charge of the given package.
|
|
|
|
|
|
2019-01-03 21:47:47 +01:00
|
|
|
- When using the +-c+ command line option, +get-developers+ will look
|
2016-09-12 22:54:55 +02:00
|
|
|
at all files under version control in the Buildroot repository, and
|
|
|
|
|
list the ones that are not handled by any developer. The purpose of
|
|
|
|
|
this option is to help completing the +DEVELOPERS+ file.
|
|
|
|
|
|
2022-07-23 15:42:26 +02:00
|
|
|
- When using the +-v+ command line option, it validates the integrity
|
|
|
|
|
of the DEVELOPERS file and will note WARNINGS for items that don't
|
|
|
|
|
match.
|
