summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2017-09-26 17:25:34 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2017-10-06 12:06:33 +0100
commit025cbf0168afd0e6d5f0ab6ecb297e2c69f4d857 (patch)
treedaf4b31a4c9488afbfb0f6855d2edb41d4329be4 /documentation
parentd48af3ed2141da46ef04a329bd8d9f9ef9237f1f (diff)
downloadpoky-025cbf0168afd0e6d5f0ab6ecb297e2c69f4d857.tar.gz
kernel-dev: Moved "dirty" kernel procedure up a level
This procedure needed to be pulled out of the section that was/is called "Using an Iterative Development Process". The section on how to deal with "dirty" kernel version strings is a procedure in its own right. It is now up a level. (From yocto-docs rev: cd8834fa8d77ac750b06c3367aee577c80dcc64e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/kernel-dev/kernel-dev-common.xml94
1 files changed, 49 insertions, 45 deletions
diff --git a/documentation/kernel-dev/kernel-dev-common.xml b/documentation/kernel-dev/kernel-dev-common.xml
index 310e2236f7..50e420c8d6 100644
--- a/documentation/kernel-dev/kernel-dev-common.xml
+++ b/documentation/kernel-dev/kernel-dev-common.xml
@@ -1848,6 +1848,55 @@
1848 </section> 1848 </section>
1849 </section> 1849 </section>
1850 1850
1851 <section id='working-with-a-dirty-kernel-version-string'>
1852 <title>Working with a "Dirty" Kernel Version String</title>
1853
1854 <para>
1855 If you build a kernel image and the version string has a
1856 "+" or a "-dirty" at the end, uncommitted modifications exist
1857 in the kernel's source directory.
1858 Follow these steps to clean up the version string:
1859 <orderedlist>
1860 <listitem><para>
1861 <emphasis>Discover the Uncommitted Changes:</emphasis>
1862 Go to the kernel's locally cloned Git repository
1863 (source directory) and use the following Git command
1864 to list the files that have been changed, added, or
1865 removed:
1866 <literallayout class='monospaced'>
1867 $ git status
1868 </literallayout>
1869 </para></listitem>
1870 <listitem><para>
1871 <emphasis>Commit the Changes:</emphasis>
1872 You should commit those changes to the kernel source
1873 tree regardless of whether or not you will save,
1874 export, or use the changes:
1875 <literallayout class='monospaced'>
1876 $ git add
1877 $ git commit -s -a -m "getting rid of -dirty"
1878 </literallayout>
1879 </para></listitem>
1880 <listitem><para>
1881 <emphasis>Rebuild the Kernel Image:</emphasis>
1882 Once you commit the changes, rebuild the kernel.</para>
1883
1884 <para>Depending on your particular kernel development
1885 workflow, the commands you use to rebuild the
1886 kernel might differ.
1887 For information on building the kernel image when
1888 using <filename>devtool</filename>, see the
1889 "<link linkend='using-devtool-to-patch-the-kernel'>Using <filename>devtool</filename> to Patch the Kernel</link>"
1890 section.
1891 For information on building the kernel image when
1892 using Bitbake, see the
1893 "<link linkend='using-traditional-kernel-development-to-patch-the-kernel'>Using Traditional Kernel Development to Patch the Kernel</link>"
1894 section.
1895 </para></listitem>
1896 </orderedlist>
1897 </para>
1898 </section>
1899
1851 <section id='using-an-iterative-development-process'> 1900 <section id='using-an-iterative-development-process'>
1852 <title>Using an Iterative Development Process</title> 1901 <title>Using an Iterative Development Process</title>
1853 1902
@@ -1868,51 +1917,6 @@
1868 "linux-yocto". 1917 "linux-yocto".
1869 </para> 1918 </para>
1870 1919
1871 <section id='tip-dirty-string'>
1872 <title>"-dirty" String</title>
1873
1874<!--
1875 <para>
1876 <emphasis>AR - Darren Hart:</emphasis> This section
1877 originated from the old Yocto Project Kernel Architecture
1878 and Use Manual.
1879 It was decided we need to put it in this section here.
1880 Darren needs to figure out where we want it and what part
1881 of it we want (all, revision???)
1882 </para>
1883-->
1884
1885 <para>
1886 If kernel images are being built with "-dirty" on the
1887 end of the version string, this simply means that
1888 modifications in the source directory have not been committed.
1889 <literallayout class='monospaced'>
1890 $ git status
1891 </literallayout>
1892 </para>
1893
1894 <para>
1895 You can use the above Git command to report modified,
1896 removed, or added files.
1897 You should commit those changes to the tree regardless of
1898 whether they will be saved, exported, or used.
1899 Once you commit the changes, you need to rebuild the kernel.
1900 </para>
1901
1902 <para>
1903 To force a pickup and commit of all such pending changes,
1904 enter the following:
1905 <literallayout class='monospaced'>
1906 $ git add .
1907 $ git commit -s -a -m "getting rid of -dirty"
1908 </literallayout>
1909 </para>
1910
1911 <para>
1912 Next, rebuild the kernel.
1913 </para>
1914 </section>
1915
1916 <section id='generating-configuration-files'> 1920 <section id='generating-configuration-files'>
1917 <title>Generating Configuration Files</title> 1921 <title>Generating Configuration Files</title>
1918 1922