From a5d8b9ec17881206a8404909467bc28e6ea10069 Mon Sep 17 00:00:00 2001
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
Date: Mon, 15 Apr 2013 08:47:18 -0700
Subject: 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>
---
 documentation/dev-manual/dev-manual-newbie.xml | 40 ++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)

(limited to 'documentation/dev-manual/dev-manual-newbie.xml')

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 @@
         will want to extend, configure or optimize it for their specific uses.
         You should send patches to the appropriate mailing list so that they
         can be reviewed and merged by the appropriate maintainer.
+    </para>
+
+    <para>
+        Before submitting any change, be sure to find out who you should be
+        notifying.
+        Several methods exist through which you find out who you should be copying
+        or notifying:
+        <itemizedlist>
+            <listitem><para><emphasis>Maintenance File:</emphasis>
+                Examine the <filename>maintainers.inc</filename> file, which is 
+                located in the 
+                <link linkend='source-directory'>Source Directory</link>
+                at <filename>meta-yocto/conf/distro/include</filename>, to 
+                see who is responsible for code.
+                </para></listitem>
+            <listitem><para><emphasis>Board Support Package (BSP) README Files:</emphasis>
+                For BSP maintainers of supported BSPs, you can examine 
+                individual BSP <filename>README</filename> files.
+                Alternatively, you can examine the 
+                <filename>MAINTAINERS</filename> file, which is found in the 
+                <filename>meta-intel</filename>, for a list of all supported
+                BSP maintainers.
+                </para></listitem>
+            <listitem><para><emphasis>Search by File:</emphasis>
+                Using <link linkend='git'>Git</link>, you can enter the 
+                following command to bring up a short list of all commits 
+                against a specific file:
+                <literallayout class='monospaced'>
+     git shortlog -- &lt;filename&gt;
+                </literallayout>
+                Just provide the name of the file for which you are interested.
+                The information returned is not ordered by history but does 
+                include a list of all committers grouped by name. 
+                From the list, you can see who is responsible for the bulk of
+                the changes against the file.
+                </para></listitem>
+        </itemizedlist>
+    </para>
+
+    <para>                
         For a list of the Yocto Project and related mailing lists, see the
         "<ulink url='&YOCTO_DOCS_REF_URL;#resources-mailinglist'>Mailing lists</ulink>" section in
         the Yocto Project Reference Manual.
-- 
cgit v1.2.3-54-g00ecf