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