developers.txt 2.1 KB

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