xref: /OK3568_Linux_fs/buildroot/docs/manual/developers.txt (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1// -*- mode:doc; -*-
2// vim: set syntax=asciidoc:
3
4[[DEVELOPERS]]
5== DEVELOPERS file and get-developers
6
7The main Buildroot directory contains a file named +DEVELOPERS+ that
8lists the developers involved with various areas of Buildroot. Thanks
9to this file, the +get-developers+ tool allows to:
10
11- Calculate the list of developers to whom patches should be sent, by
12  parsing the patches and matching the modified files with the
13  relevant developers. See xref:submitting-patches[] for details.
14
15- Find which developers are taking care of a given architecture or
16  package, so that they can be notified when a build failure occurs on
17  this architecture or package. This is done in interaction with
18  Buildroot's autobuild infrastructure.
19
20We ask developers adding new packages, new boards, or generally new
21functionality in Buildroot, to register themselves in the +DEVELOPERS+
22file. As an example, we expect a developer contributing a new package
23to include in his patch the appropriate modification to the
24+DEVELOPERS+ file.
25
26The +DEVELOPERS+ file format is documented in detail inside the file
27itself.
28
29The +get-developers+ tool, located in +utils/+ allows to use
30the +DEVELOPERS+ file for various tasks:
31
32- When passing one or several patches as command line argument,
33  +get-developers+ will return the appropriate +git send-email+
34  command. If the +-e+ option is passed, only the email addresses are
35  printed in a format suitable for +git send-email --cc-cmd+.
36
37- When using the +-a <arch>+ command line option, +get-developers+ will
38  return the list of developers in charge of the given architecture.
39
40- When using the +-p <package>+ command line option, +get-developers+
41  will return the list of developers in charge of the given package.
42
43- When using the +-c+ command line option, +get-developers+ will look
44  at all files under version control in the Buildroot repository, and
45  list the ones that are not handled by any developer. The purpose of
46  this option is to help completing the +DEVELOPERS+ file.
47
48- When using without any arguments, it validates the integrity of the
49  DEVELOPERS file and will note WARNINGS for items that don't match.
50