From 5b2ed2a5fa4ab37124457d9a749a889a78fc3470 Mon Sep 17 00:00:00 2001
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
Date: Thu, 27 Dec 2012 15:32:45 -0600
Subject: kernel-dev: Formatted the "SCC Reference" section.

(From yocto-docs rev: d688741743ff3ffeaf387dffc728af40331e8933)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
---
 documentation/kernel-dev/kernel-dev-advanced.xml | 64 ++++++++++++++++++++++++
 1 file changed, 64 insertions(+)

(limited to 'documentation')

diff --git a/documentation/kernel-dev/kernel-dev-advanced.xml b/documentation/kernel-dev/kernel-dev-advanced.xml
index 371a3b46db..b754cb9791 100644
--- a/documentation/kernel-dev/kernel-dev-advanced.xml
+++ b/documentation/kernel-dev/kernel-dev-advanced.xml
@@ -1544,6 +1544,70 @@ mybsp.scc:
     </para>
 </section>
 
+<section id='scc-reference'>
+    <title>SCC Reference</title>
+
+    <para>
+        This section provides short descriptions for the commands you can
+        use from an <filename>.scc</filename>:
+        <itemizedlist>
+            <listitem><para><filename>branch [ref]</filename>:
+                Creates a new branch relative to the current branch
+                (typically <filename>${KTYPE}</filename>) using
+                the currently checked-out branch, or "ref" if specified.</para>
+                <para><emphasis>TODO:</emphasis> Bruce, we need to clarify
+                the "relative to the current branch" bit.</para></listitem>
+            <listitem><para><filename>define</filename>:
+                Defines variables, such as <filename>KMACHINE</filename>,
+                <filename>KTYPE</filename>, <filename>KARCH</filename>,
+                and <filename>KFEATURE_DESCRIPTION</filename>.</para></listitem>
+            <listitem><para><filename>include SCC_FILE</filename>:
+                Includes an <filename>scc</filename> file in the current file.
+                It will be parsed as if inserted inline.</para></listitem>
+            <listitem><para><filename>kconf [hardware|non-hardware] CFG_FILE</filename>:
+                Queues a configuration fragment for merging into the final
+                Linux <filename>.config</filename> file.</para></listitem>
+            <listitem><para><filename>git merge GIT_BRANCH</filename>:
+                Merges the feature branch into the current branch.</para></listitem>
+            <listitem><para><filename>patch PATCH_FILE</filename>:
+                Applies the patch to the current Git branch.</para></listitem>
+        </itemizedlist>
+    </para>
+
+    <para>
+        Original text:
+        <literallayout class='monospaced'>
+* branch [ref]
+
+  Create a new branch relative to the current branch (typically ${KTYPE}) using
+  the currently checked-out branch, or "ref" if specified.
+
+  TODO: Bruce, we need to clarify the "relative to the current branch" bit.
+
+* define
+
+  Define variables, such as KMACHINE, KTYPE, KARCH, and KFEATURE_DESCRIPTION.
+
+* include SCC_FILE
+
+  Include an scc file in the current file. It will be parsed as if inserted
+  inline.
+
+* kconf [hardware|non-hardware] CFG_FILE
+
+  Queue a configuration fragment for merging into the final Linux .config file.
+
+* merge (or "git merge") GIT_BRANCH
+
+  Merge the feature branch into the current branch.
+
+* patch PATCH_FILE
+
+  Apply the patch to the current git branch.
+        </literallayout>
+    </para>
+</section>
+
 </chapter>
 <!--
 vim: expandtab tw=80 ts=4
-- 
cgit v1.2.3-54-g00ecf