diff options
| author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2013-04-15 08:47:18 -0700 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2013-04-17 22:34:12 +0100 |
| commit | a5d8b9ec17881206a8404909467bc28e6ea10069 (patch) | |
| tree | ad7bcc9bad19e07112ed3aba8466b220e68efbd5 | |
| parent | d78dcf56989d5e7fb5ac101f9af5cbf253f1a2df (diff) | |
| download | poky-a5d8b9ec17881206a8404909467bc28e6ea10069.tar.gz | |
dev-manual: Added methods to determine who a Maintainer is.
Provided three ways to dig out the information on who might
be contaced about a change or patch to an area of code:
1. See the "maintenance.inc" file.
2. Examine BSP README files or the MAINTAINERS file (for BSP)
3. Use the 'git shortlog -- <filename> command to see who
has committed the bulk of the changes for a particular file.
(From yocto-docs rev: 0757a2edddb55bcce2ea1507501220c3097f0a22)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
| -rw-r--r-- | documentation/dev-manual/dev-manual-newbie.xml | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml index 6d5650ae05..9d5e7a3646 100644 --- a/documentation/dev-manual/dev-manual-newbie.xml +++ b/documentation/dev-manual/dev-manual-newbie.xml | |||
| @@ -1265,6 +1265,46 @@ | |||
| 1265 | will want to extend, configure or optimize it for their specific uses. | 1265 | will want to extend, configure or optimize it for their specific uses. |
| 1266 | You should send patches to the appropriate mailing list so that they | 1266 | You should send patches to the appropriate mailing list so that they |
| 1267 | can be reviewed and merged by the appropriate maintainer. | 1267 | can be reviewed and merged by the appropriate maintainer. |
| 1268 | </para> | ||
| 1269 | |||
| 1270 | <para> | ||
| 1271 | Before submitting any change, be sure to find out who you should be | ||
| 1272 | notifying. | ||
| 1273 | Several methods exist through which you find out who you should be copying | ||
| 1274 | or notifying: | ||
| 1275 | <itemizedlist> | ||
| 1276 | <listitem><para><emphasis>Maintenance File:</emphasis> | ||
| 1277 | Examine the <filename>maintainers.inc</filename> file, which is | ||
| 1278 | located in the | ||
| 1279 | <link linkend='source-directory'>Source Directory</link> | ||
| 1280 | at <filename>meta-yocto/conf/distro/include</filename>, to | ||
| 1281 | see who is responsible for code. | ||
| 1282 | </para></listitem> | ||
| 1283 | <listitem><para><emphasis>Board Support Package (BSP) README Files:</emphasis> | ||
| 1284 | For BSP maintainers of supported BSPs, you can examine | ||
| 1285 | individual BSP <filename>README</filename> files. | ||
| 1286 | Alternatively, you can examine the | ||
| 1287 | <filename>MAINTAINERS</filename> file, which is found in the | ||
| 1288 | <filename>meta-intel</filename>, for a list of all supported | ||
| 1289 | BSP maintainers. | ||
| 1290 | </para></listitem> | ||
| 1291 | <listitem><para><emphasis>Search by File:</emphasis> | ||
| 1292 | Using <link linkend='git'>Git</link>, you can enter the | ||
| 1293 | following command to bring up a short list of all commits | ||
| 1294 | against a specific file: | ||
| 1295 | <literallayout class='monospaced'> | ||
| 1296 | git shortlog -- <filename> | ||
| 1297 | </literallayout> | ||
| 1298 | Just provide the name of the file for which you are interested. | ||
| 1299 | The information returned is not ordered by history but does | ||
| 1300 | include a list of all committers grouped by name. | ||
| 1301 | From the list, you can see who is responsible for the bulk of | ||
| 1302 | the changes against the file. | ||
| 1303 | </para></listitem> | ||
| 1304 | </itemizedlist> | ||
| 1305 | </para> | ||
| 1306 | |||
| 1307 | <para> | ||
| 1268 | For a list of the Yocto Project and related mailing lists, see the | 1308 | For a list of the Yocto Project and related mailing lists, see the |
| 1269 | "<ulink url='&YOCTO_DOCS_REF_URL;#resources-mailinglist'>Mailing lists</ulink>" section in | 1309 | "<ulink url='&YOCTO_DOCS_REF_URL;#resources-mailinglist'>Mailing lists</ulink>" section in |
| 1270 | the Yocto Project Reference Manual. | 1310 | the Yocto Project Reference Manual. |
