aboutsummaryrefslogtreecommitdiff
path: root/docs/manual/developers.txt
blob: ea1f894f205cf77f167bae90d31abbbc06cdc6c1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
// -*- mode:doc; -*-
// vim: set syntax=asciidoc:

[[DEVELOPERS]]
== DEVELOPERS file and get-developers

The main Buildroot directory contains a file named +DEVELOPERS+ that
list the developers involved with various areas of Buildroot. Thanks to
this file, the +get-developer+ tool allows to:

- 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.

The +get-developer+ tool, located in +support/scripts+ allows to use
the +DEVELOPERS+ file for various tasks:

- When passing one or several patches as command line argument,
  +get-developer+ will return the appropriate +git send-email+
  command.

- When using the +-a <arch>+ command line option, +get-developer+ will
  return the list of developers in charge of the given architecture.

- When using the +-p <package>+ command line option, +get-developer+
  will return the list of developers in charge of the given package.

- When using the +-c+ command line option, +get-developer+ will look
  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.