docs/manual/developers.txt

   1 // -*- mode:doc; -*-
   2 // vim: set syntax=asciidoc:
   3
   4 [[DEVELOPERS]]
   5 == DEVELOPERS file and get-developers
   6
   7 The main Buildroot directory contains a file named +DEVELOPERS+ that
   8 lists the developers involved with various areas of Buildroot. Thanks
   9 to this file, the +get-developer+ 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
  20 We ask developers adding new packages, new boards, or generally new
  21 functionality in Buildroot, to register themselves in the +DEVELOPERS+
  22 file. As an example, we expect a developer contributing a new package
  23 to include in his patch the appropriate modification to the
  24 +DEVELOPERS+ file.
  25
  26 The +DEVELOPERS+ file format is documented in detail inside the file
  27 itself.
  28
  29 The +get-developer+ tool, located in +support/scripts+ allows to use
  30 the +DEVELOPERS+ file for various tasks:
  31
  32 - When passing one or several patches as command line argument,
  33   +get-developer+ will return the appropriate +git send-email+
  34   command.
  35
  36 - When using the +-a <arch>+ command line option, +get-developer+ will
  37   return the list of developers in charge of the given architecture.
  38
  39 - When using the +-p <package>+ command line option, +get-developer+
  40   will return the list of developers in charge of the given package.
  41
  42 - When using the +-c+ command line option, +get-developer+ will look
  43   at all files under version control in the Buildroot repository, and
  44   list the ones that are not handled by any developer. The purpose of
  45   this option is to help completing the +DEVELOPERS+ file.
  46