<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<!DOCTYPE bugzilla SYSTEM "https://bugzilla.yoctoproject.org/page.cgi?id=bugzilla.dtd">

<bugzilla version="5.0.6"
          urlbase="https://bugzilla.yoctoproject.org/"
          
          maintainer="it-coreprojects-helpdesk@linuxfoundation.org"
>

    <bug>
          <bug_id>1717</bug_id>
          
          <creation_ts>2011-11-02 20:31:56 +0000</creation_ts>
          <short_desc>[NAS] kernel config manual is not straight forward.</short_desc>
          <delta_ts>2012-03-13 18:49:14 +0000</delta_ts>
          <reporter_accessible>1</reporter_accessible>
          <cclist_accessible>1</cclist_accessible>
          <classification_id>9</classification_id>
          <classification>Documentation</classification>
          <product>Reference</product>
          <component>handbook</component>
          <version>unspecified</version>
          <rep_platform>x86</rep_platform>
          <op_sys>Multiple</op_sys>
          <bug_status>RESOLVED</bug_status>
          <resolution>FIXED</resolution>
          
          
          <bug_file_loc>http://git.yoctoproject.org/cgit.cgi/yocto-docs/commit/?id=de8f85753ad1d6dde66adb6bb4cb09e9528c7cd6</bug_file_loc>
          <status_whiteboard>13-March-2012: Resolved/Fixed</status_whiteboard>
          <keywords></keywords>
          <priority>Medium</priority>
          <bug_severity>major</bug_severity>
          <target_milestone>1.2 M1</target_milestone>
          
          
          <everconfirmed>1</everconfirmed>
          <reporter name="Shane Wang">shane.wang</reporter>
          <assigned_to name="Scott Rifenbark">srifenbark</assigned_to>
          <cc>dvhart</cc>
    
    <cc>jessica.zhang</cc>
    
    <cc>ke.yu</cc>
    
    <cc>poky.doc.watcher</cc>
    
    <cc>poky.watcher</cc>
    
    <cc>tom.zanussi</cc>
          
          
          <cf_os>---</cf_os>
          <cf_regression_type>---</cf_regression_type>
          
          <cf_docchange>---</cf_docchange>

      

      

      

          <comment_sort_order>oldest_to_newest</comment_sort_order>  
          <long_desc isprivate="0" >
    <commentid>17057</commentid>
    <comment_count>0</comment_count>
    <who name="Shane Wang">shane.wang</who>
    <bug_when>2011-11-02 20:31:56 +0000</bug_when>
    <thetext>The kernel config manual is not straight forward. In order to find how to config the kernel, as an experienced meta-data developer, Ke spent much time digging out where and how in the documents.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>17078</commentid>
    <comment_count>1</comment_count>
    <who name="Darren Hart">dvhart</who>
    <bug_when>2011-11-03 15:42:36 +0000</bug_when>
    <thetext>This should be being addressed with the yocto developer manual as well as in the kernel architecture and use manual. What was Ke trying to change?</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>17079</commentid>
    <comment_count>2</comment_count>
    <who name="Darren Hart">dvhart</who>
    <bug_when>2011-11-03 15:45:15 +0000</bug_when>
    <thetext>.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>17085</commentid>
    <comment_count>3</comment_count>
    <who name="Ke Yu">ke.yu</who>
    <bug_when>2011-11-03 18:55:49 +0000</bug_when>
    <thetext>What I does in NAS project is to add the kernel NFS server configuration which is disabled in default configuration.

So finally I find the &quot;BSP developer guide&quot; (http://www.yoctoproject.org/docs/current/poky-ref-manual/poky-ref-manual.html#bsp-filelayout-kernel) actually meet my requirement.

meanwhile, I still have some suggestions for the doc.
1. when i read the doc on config file part, i am not quite sure what is the format of the configuration file, is it standard kernel config file, or in other format. later i know it is standard kernel config file. but it would be good if there are some content example of the configuration file. for example,  list the eth.cfg content as:
meta-&lt;bsp_name&gt;/recipes-kernel/linux/linux-yocto/eth.cfg 
CONFIG_xxx=Y
CONFIG_xxx=M
...

in this case, user will immediately knows it is the standard kernel config file which he is familiar with before, and he will be happy :)

2. The other question I meet is how to generate the desired config file 
what I does is: extract the kernel source, and &quot;make menuconfig&quot;, and use help to check the dependency. and then check the generated config file.
i know there can be many ways to achieve the goal. it would be helpful if we can provide one way for reference.

3. Another question I meet is when i debug the NAS, I once need to disable IPv6 support. so the questions are: how to disable one feature, and what if my provided config file has conflict with the default config. e.g. in my config file CONFIG_IPV6=n, while in default config, the CONFIG_IPv6=y, will that conflict?

for the question &quot;how to disable one feature&quot;, i later know CONFIG_xxx=n works
for the question of conflict, i did not meet the conflict fortunately, so i did not know the answer actually

so I suggest the document also provide the content related to the above two question.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>17100</commentid>
    <comment_count>4</comment_count>
    <who name="Darren Hart">dvhart</who>
    <bug_when>2011-11-04 05:44:10 +0000</bug_when>
    <thetext>Thanks Ke. I&apos;m adding Tom to CC and thinking Scott R can drive the changes from here.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>17102</commentid>
    <comment_count>5</comment_count>
    <who name="Scott Rifenbark">srifenbark</who>
    <bug_when>2011-11-04 06:52:25 +0000</bug_when>
    <thetext>Yes - this manual needs work.  During the 1.1 release my time was focused on creating the YP Development manual.  The plan is to have the Kernel Manual simply be a reference and not a manual that tells you how to do much.  But rather a manual that explains how we maintain the kernel tree, how it is updated, etc.  i will try and address the specific concerns you pointed out in the appropriate place.

Thanks, 
Scott</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>17103</commentid>
    <comment_count>6</comment_count>
    <who name="Tom Zanussi">tom.zanussi</who>
    <bug_when>2011-11-04 07:16:02 +0000</bug_when>
    <thetext>Hmm, this shouldn&apos;t have been such a mystery.

I actually created a BKM covering such topics in preparation for a meeting with the PRC team several months ago when handing off the Pegasus BSP development. 

In it there&apos;s a section on the topic of changing config options:

BKM: starting a new BSP

&quot;Adding new options and/or changing kernel code&quot;

https://wiki.yoctoproject.org/wiki/BKM:_starting_a_new_BSP


In a similar vein, a couple of days ago Darren was becoming frustrated that people were having such a hard time dealing with all this kind of stuff, and I pointed him to other documents in the same place:

https://wiki.yoctoproject.org/wiki/BSPs

https://wiki.yoctoproject.org/wiki/Transcript:_from_git_checkout_to_meta-intel_BSP
https://wiki.yoctoproject.org/wiki/Transcript:_from_git_checkout_to_qemu_desktop
https://wiki.yoctoproject.org/wiki/Transcript:_creating_one_generic_Atom_BSP_from_another

Some of the above also provided the basis for sections already in the Developer&apos;s manual, such as Appendix A.

So the information is out there, but apparently nobody&apos;s able to find it, despite my having published links etc at various times.

So maybe the thing to do is to collect it all in a more visible place, and provide a little more narrative about where to find it and which applies to what use cases.  I know Darren was thinking of putting together something like that along with proxy information for people within Intel, sort of a one-stop-shop for people working in this area.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>17104</commentid>
    <comment_count>7</comment_count>
    <who name="Scott Rifenbark">srifenbark</who>
    <bug_when>2011-11-04 07:26:00 +0000</bug_when>
    <thetext>Agreed Tom, 

This is what i meant by getting these concerns addressed in the right places.  I think some organization and word-smithing will help on this one.

Scott</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>19018</commentid>
    <comment_count>8</comment_count>
    <who name="Scott Rifenbark">srifenbark</who>
    <bug_when>2012-03-13 18:49:14 +0000</bug_when>
    <thetext>I have created sections in the YP BSP Guide and the YP Development Manual that specifically address kernel configuration.  These two new sections combined with the &quot;Linux Kernel Configuration&quot; section that is in the YP Kernel manual all combine to address the initial confusion surrounding configuration of the kernel.  The aggregated text now presents configuration concepts, points to a specific example that shows how to use menuconfig and configuration fragments for creating kernel configurations, and provides the &quot;glue&quot; text to help tie things together.

Much of the information and reviews was provided by Bruce Ashfield.  Here are the updated sections, which are in the &quot;latest&quot; versions of the manuals:

BSP Guide - http://www.yoctoproject.org/docs/latest/bsp-guide/bsp-guide.html#bsp-filelayout-kernel

Kernel Manual - http://www.yoctoprojet.org/docs/latest/kernel-manual/kernel-manual.html#kernel-configuration

Development Manual - http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#configuring-the-kernel

Scott</thetext>
  </long_desc>
      
      

    </bug>

</bugzilla>