MAINTAINERS

   1
   2
   3         List of maintainers and how to submit coreboot changes
   4
   5 Please try to follow the guidelines below.  This will make things
   6 easier on the maintainers.  Not all of these guidelines matter for every
   7 trivial patch so apply some common sense.
   8
   9 1.      Always _test_ your changes, however small, on at least 1 or
  10         2 people, preferably many more.
  11
  12 2.      Try to release a few ALPHA test versions to gerrit. Announce
  13         them onto the coreboot mailing list and IRC channel and await
  14         results. This is especially important on coreboot core changes,
  15         but also for device drivers, because often that's the only way
  16         you will find things like the fact revision 3 chipset needs
  17         a magic fix you didn't know about, or some clown changed the
  18         chips on a board and not its name.  (Don't laugh!)
  19
  20 3.      Make sure your changes compile correctly in multiple
  21         configurations. In particular check that changes work for all
  22         boards in the tree (use abuild!)
  23
  24 4.      When you are happy with a change make it generally available for
  25         testing in gerrit and await feedback.
  26
  27 5.      Make your patch available through coreboot's gerrit code review
  28         system, and add the relevant maintainer from this list as a code
  29         reviewer. Be prepared to get your changes sent back with seemingly
  30         silly requests about formatting and variable names.  These aren't
  31         as silly as they seem. One job the maintainers do is to keep
  32         things looking the same.  Sometimes this means that the clever
  33         hack in your mainboard or chipset to get around a problem actually
  34         needs to become a generalized coreboot feature ready for next time.
  35
  36         PLEASE check your patch with the automated style checker
  37         (util/lint/checkpatch.pl) to catch trival style violations.
  38         See http://coreboot.org/Coding_Style for guidance here.
  39
  40         PLEASE add the maintainers that are generated by
  41         util/scripts/get_maintainer.pl as reviewers.  The results returned
  42         by the script will be best if you have git installed and are
  43         making your changes in a branch derived from coreboot.org's latest
  44         git tree.
  45
  46         PLEASE try to include any credit lines you want added with the
  47         patch. It avoids people being missed off by mistake and makes
  48         it easier to know who wants adding and who doesn't.
  49
  50         PLEASE document known bugs. If it doesn't work for everything
  51         or does something very odd once a month document it.
  52
  53         PLEASE remember that submissions must be made under the terms
  54         of the OSDL certificate of contribution and should include a
  55         Signed-off-by: line.  The current version of this "Developer's
  56         Certificate of Origin" (DCO) is listed at
  57         http://coreboot.org/Development_Guidelines#Sign-off_Procedure.
  58
  59 6.      Make sure you have the right to send any changes you make. If you
  60         do changes at work you may find your employer owns the patch
  61         not you.
  62
  63 7.      Happy hacking.
  64
  65 Descriptions of section entries:
  66
  67         M: Maintainer: FullName <address@domain>
  68         R: Designated reviewer: FullName <address@domain>
  69            These reviewers should be CCed on patches.
  70         L: Mailing list that is relevant to this area
  71         W: Web-page with status/info
  72         Q: Patchwork web based patch tracking system site
  73         T: SCM tree type and location.
  74            Type is one of: git, hg, quilt, stgit, topgit
  75         S: Status, one of the following:
  76            Supported:   Someone is actually paid to look after this.
  77            Maintained:  Someone actually looks after it.
  78            Odd Fixes:   It has a maintainer but they don't have time to do
  79                         much other than throw the odd patch in. See below..
  80            Orphan:      No current maintainer [but maybe you could take the
  81                         role as you write your new code].
  82            Obsolete:    Old code. Something tagged obsolete generally means
  83                         it has been replaced by a better system and you
  84                         should be using that.
  85         F: Files and directories with wildcard patterns.
  86            A trailing slash includes all files and subdirectory files.
  87            F:   drivers/net/    all files in and below drivers/net
  88            F:   drivers/net/*   all files in drivers/net, but not below
  89            F:   */net/*         all files in "any top level directory"/net
  90            One pattern per line.  Multiple F: lines acceptable.
  91         N: Files and directories with regex patterns.
  92            N:   [^a-z]tegra     all files whose path contains the word tegra
  93            One pattern per line.  Multiple N: lines acceptable.
  94            scripts/get_maintainer.pl has different behavior for files that
  95            match F: pattern and matches of N: patterns.  By default,
  96            get_maintainer will not look at git log history when an F: pattern
  97            match occurs.  When an N: match occurs, git log history is used
  98            to also notify the people that have git commit signatures.
  99         X: Files and directories that are NOT maintained, same rules as F:
 100            Files exclusions are tested before file matches.
 101            Can be useful for excluding a specific subdirectory, for instance:
 102            F:   net/
 103            X:   net/ipv6/
 104            matches all files in and below net excluding net/ipv6/
 105         K: Keyword perl extended regex pattern to match content in a
 106            patch or file.  For instance:
 107            K: of_get_profile
 108               matches patches or files that contain "of_get_profile"
 109            K: \b(printk|pr_(info|err))\b
 110               matches patches or files that contain one or more of the words
 111               printk, pr_info or pr_err
 112            One regex pattern per line.  Multiple K: lines acceptable.
 113
 114 Note: For the hard of thinking, this list is meant to remain in alphabetical
 115 order. If you could add yourselves to it in alphabetical order that would be
 116 so much easier [Ed]
 117
 118 Maintainers List (try to look for most precise areas first)
 119
 120                 -----------------------------------
 121
 122 RISC-V ARCHITECTURE
 123 M:      Ronald Minnich <rminnich@gmail.com>
 124 S:      Maintained
 125 F:      src/arch/riscv/
 126 F:      src/mainboard/emulation/qemu-riscv/
 127
 128 GOOGLE PANTHER MAINBOARD
 129 M:      Stefan Reinauer <stefan.reinauer@coreboot.org>
 130 S:      Supported
 131 F:      src/mainboard/google/panther/
 132
 133 ATI MACH64 Driver
 134 S:      Orphan
 135 F:      drivers/ati/mach64/
 136
 137 LINT SCRIPTS
 138 M:      Patrick Georgi <patrick@georgi-clan.de>
 139 S:      Supported
 140 F:      util/lint/
 141
 142 BUILD SYSTEM
 143 M:      Patrick Georgi <patrick@georgi-clan.de>
 144 S:      Supported
 145 F:      Makefile
 146 F:      *.inc
 147 F:      util/kconfig/
 148 F:      util/sconfig/
 149
 150 THE REST
 151 M:      Stefan Reinauer <stefan.reinauer@coreboot.org>
 152 L:      coreboot@coreboot.org
 153 T:      git http://review.coreboot.org/coreboot
 154 S:      Buried alive in mainboards
 155 F:      *
 156 F:      */