summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-12-27 15:32:45 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-01-16 15:59:12 +0000
commit5b2ed2a5fa4ab37124457d9a749a889a78fc3470 (patch)
tree15b4cefb4e732f9f0da32c0d7cd4354eb37b4eaa /documentation
parentece3e83e8b01f7968ac76c46a3c278c93a6ff448 (diff)
downloadpoky-5b2ed2a5fa4ab37124457d9a749a889a78fc3470.tar.gz
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>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/kernel-dev/kernel-dev-advanced.xml64
1 files changed, 64 insertions, 0 deletions
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:
1544 </para> 1544 </para>
1545</section> 1545</section>
1546 1546
1547<section id='scc-reference'>
1548 <title>SCC Reference</title>
1549
1550 <para>
1551 This section provides short descriptions for the commands you can
1552 use from an <filename>.scc</filename>:
1553 <itemizedlist>
1554 <listitem><para><filename>branch [ref]</filename>:
1555 Creates a new branch relative to the current branch
1556 (typically <filename>${KTYPE}</filename>) using
1557 the currently checked-out branch, or "ref" if specified.</para>
1558 <para><emphasis>TODO:</emphasis> Bruce, we need to clarify
1559 the "relative to the current branch" bit.</para></listitem>
1560 <listitem><para><filename>define</filename>:
1561 Defines variables, such as <filename>KMACHINE</filename>,
1562 <filename>KTYPE</filename>, <filename>KARCH</filename>,
1563 and <filename>KFEATURE_DESCRIPTION</filename>.</para></listitem>
1564 <listitem><para><filename>include SCC_FILE</filename>:
1565 Includes an <filename>scc</filename> file in the current file.
1566 It will be parsed as if inserted inline.</para></listitem>
1567 <listitem><para><filename>kconf [hardware|non-hardware] CFG_FILE</filename>:
1568 Queues a configuration fragment for merging into the final
1569 Linux <filename>.config</filename> file.</para></listitem>
1570 <listitem><para><filename>git merge GIT_BRANCH</filename>:
1571 Merges the feature branch into the current branch.</para></listitem>
1572 <listitem><para><filename>patch PATCH_FILE</filename>:
1573 Applies the patch to the current Git branch.</para></listitem>
1574 </itemizedlist>
1575 </para>
1576
1577 <para>
1578 Original text:
1579 <literallayout class='monospaced'>
1580* branch [ref]
1581
1582 Create a new branch relative to the current branch (typically ${KTYPE}) using
1583 the currently checked-out branch, or "ref" if specified.
1584
1585 TODO: Bruce, we need to clarify the "relative to the current branch" bit.
1586
1587* define
1588
1589 Define variables, such as KMACHINE, KTYPE, KARCH, and KFEATURE_DESCRIPTION.
1590
1591* include SCC_FILE
1592
1593 Include an scc file in the current file. It will be parsed as if inserted
1594 inline.
1595
1596* kconf [hardware|non-hardware] CFG_FILE
1597
1598 Queue a configuration fragment for merging into the final Linux .config file.
1599
1600* merge (or "git merge") GIT_BRANCH
1601
1602 Merge the feature branch into the current branch.
1603
1604* patch PATCH_FILE
1605
1606 Apply the patch to the current git branch.
1607 </literallayout>
1608 </para>
1609</section>
1610
1547</chapter> 1611</chapter>
1548<!-- 1612<!--
1549vim: expandtab tw=80 ts=4 1613vim: expandtab tw=80 ts=4