Documentation improvement


Jim Abernathy
 

I was looking at the Yocto Development Manual (Latest), section 4.6.2. Creating Config Fragments.  I was confused about the file statement and the naming of the directory to locate the fragment file until I found a similar discussion in the BSP Guide (lastest) section 1.2.10. Linux Kernel Configuration.

The section there is much more understandable.  I think we need to modify the development manual or have it point to the BSP manual.  The text from there (below) I think is better.  I still think it's confusing about the naming of the subdirectory where the myconfig goes. Maybe a complete example would be good.

For example, suppose you had a set of configuration options in a file called myconfig. If you put that file inside a directory named linux-yocto and then added a SRC_URI statement such as the following to the append file, those configuration options will be picked up and applied when the kernel is built.
     SRC_URI += "file://myconfig"
                

As mentioned earlier, you can group related configurations into multiple files and name them all in the SRC_URI statement as well. For example, you could group separate configurations specifically for Ethernet and graphics into their own files and add those by using a SRC_URI statement like the following in your append file:

     SRC_URI += "file://myconfig \
            file://eth.cfg \
            file://gfx.cfg"
                


Rifenbark, Scott M <scott.m.rifenbark@...>
 

Jim,

 

I am looking at that section in the BSP Guide and it is actually out of date regarding the 1.2.10 section.  In the section it lists the linux-yocto_3.0.bbappend file (which is probably lagging as it should be 3.2).  Anyway, the listing uses KERNEL_FEATURES and I believe that KBRANCH is now used.  I am going to work on this section and get it up to speed and then address the issue you originally brought up, which is getting the best description for config fragments inside the dev manual.

 

ScottR

 

From: yocto-bounces@... [mailto:yocto-bounces@...] On Behalf Of jfabernathy
Sent: Friday, July 06, 2012 11:59 AM
To: yocto@...
Subject: [yocto] Documentation improvement

 

I was looking at the Yocto Development Manual (Latest), section 4.6.2. Creating Config Fragments.  I was confused about the file statement and the naming of the directory to locate the fragment file until I found a similar discussion in the BSP Guide (lastest) section 1.2.10. Linux Kernel Configuration.

The section there is much more understandable.  I think we need to modify the development manual or have it point to the BSP manual.  The text from there (below) I think is better.  I still think it's confusing about the naming of the subdirectory where the myconfig goes. Maybe a complete example would be good.

For example, suppose you had a set of configuration options in a file called myconfig. If you put that file inside a directory named linux-yocto and then added a SRC_URI statement such as the following to the append file, those configuration options will be picked up and applied when the kernel is built.

     SRC_URI += "file://myconfig"
                

As mentioned earlier, you can group related configurations into multiple files and name them all in the SRC_URI statement as well. For example, you could group separate configurations specifically for Ethernet and graphics into their own files and add those by using a SRC_URI statement like the following in your append file:

     SRC_URI += "file://myconfig \
            file://eth.cfg \
            file://gfx.cfg"
                


Jim Abernathy
 

Cool!


On Jul 6, 2012, at 5:06 PM, "Rifenbark, Scott M" <scott.m.rifenbark@...> wrote:

Jim,

 

I am looking at that section in the BSP Guide and it is actually out of date regarding the 1.2.10 section.  In the section it lists the linux-yocto_3.0.bbappend file (which is probably lagging as it should be 3.2).  Anyway, the listing uses KERNEL_FEATURES and I believe that KBRANCH is now used.  I am going to work on this section and get it up to speed and then address the issue you originally brought up, which is getting the best description for config fragments inside the dev manual.

 

ScottR

 

From: yocto-bounces@... [mailto:yocto-bounces@...] On Behalf Of jfabernathy
Sent: Friday, July 06, 2012 11:59 AM
To: yocto@...
Subject: [yocto] Documentation improvement

 

I was looking at the Yocto Development Manual (Latest), section 4.6.2. Creating Config Fragments.  I was confused about the file statement and the naming of the directory to locate the fragment file until I found a similar discussion in the BSP Guide (lastest) section 1.2.10. Linux Kernel Configuration.

The section there is much more understandable.  I think we need to modify the development manual or have it point to the BSP manual.  The text from there (below) I think is better.  I still think it's confusing about the naming of the subdirectory where the myconfig goes. Maybe a complete example would be good.

For example, suppose you had a set of configuration options in a file called myconfig. If you put that file inside a directory named linux-yocto and then added a SRC_URI statement such as the following to the append file, those configuration options will be picked up and applied when the kernel is built.

     SRC_URI += "file://myconfig"
                

As mentioned earlier, you can group related configurations into multiple files and name them all in the SRC_URI statement as well. For example, you could group separate configurations specifically for Ethernet and graphics into their own files and add those by using a SRC_URI statement like the following in your append file:

     SRC_URI += "file://myconfig \
            file://eth.cfg \
            file://gfx.cfg"
                


Jim Abernathy
 



On Fri, Jul 6, 2012 at 5:06 PM, Rifenbark, Scott M <scott.m.rifenbark@...> wrote:

Jim,

 

I am looking at that section in the BSP Guide and it is actually out of date regarding the 1.2.10 section.  In the section it lists the linux-yocto_3.0.bbappend file (which is probably lagging as it should be 3.2).  Anyway, the listing uses KERNEL_FEATURES and I believe that KBRANCH is now used.  I am going to work on this section and get it up to speed and then address the issue you originally brought up, which is getting the best description for config fragments inside the dev manual.

 

ScottR

 

Scott,

I found out over the weekend that the config fragment file needs to have the .cfg extension.  This would agree with the example in the Developer Manual, but make the BSP Guide in error, as it uses no extension.  A note to the .cfg requirement would seem to be a required addition.

JIm A

 

From: yocto-bounces@... [mailto:yocto-bounces@...] On Behalf Of jfabernathy
Sent: Friday, July 06, 2012 11:59 AM
To: yocto@...
Subject: [yocto] Documentation improvement

 

I was looking at the Yocto Development Manual (Latest), section 4.6.2. Creating Config Fragments.  I was confused about the file statement and the naming of the directory to locate the fragment file until I found a similar discussion in the BSP Guide (lastest) section 1.2.10. Linux Kernel Configuration.

The section there is much more understandable.  I think we need to modify the development manual or have it point to the BSP manual.  The text from there (below) I think is better.  I still think it's confusing about the naming of the subdirectory where the myconfig goes. Maybe a complete example would be good.

For example, suppose you had a set of configuration options in a file called myconfig. If you put that file inside a directory named linux-yocto and then added a SRC_URI statement such as the following to the append file, those configuration options will be picked up and applied when the kernel is built.

     SRC_URI += "file://myconfig"
                

As mentioned earlier, you can group related configurations into multiple files and name them all in the SRC_URI statement as well. For example, you could group separate configurations specifically for Ethernet and graphics into their own files and add those by using a SRC_URI statement like the following in your append file:

     SRC_URI += "file://myconfig \
            file://eth.cfg \
            file://gfx.cfg"
                


Rifenbark, Scott M <scott.m.rifenbark@...>
 

Jim,

 

I am addressing issues in my email box (bottom up) and was not sure if I ever closed this one with you.  I have made changes to the “Creating Configuration Fragments” section in the YP Development Manual “latest” version (http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#creating-config-fragments).  I added wording from the BSP guide to help clear this up.  If you want to examine the new section against the 1.2 version, see the same section in the current manual at http://www.yoctoproject.org/docs/current/dev-manual/dev-manual.html#creating-config-fragments.

 

Thanks,
Scott

 

From: yocto-bounces@... [mailto:yocto-bounces@...] On Behalf Of jfabernathy
Sent: Friday, July 06, 2012 11:59 AM
To: yocto@...
Subject: [yocto] Documentation improvement

 

I was looking at the Yocto Development Manual (Latest), section 4.6.2. Creating Config Fragments.  I was confused about the file statement and the naming of the directory to locate the fragment file until I found a similar discussion in the BSP Guide (lastest) section 1.2.10. Linux Kernel Configuration.

The section there is much more understandable.  I think we need to modify the development manual or have it point to the BSP manual.  The text from there (below) I think is better.  I still think it's confusing about the naming of the subdirectory where the myconfig goes. Maybe a complete example would be good.

For example, suppose you had a set of configuration options in a file called myconfig. If you put that file inside a directory named linux-yocto and then added a SRC_URI statement such as the following to the append file, those configuration options will be picked up and applied when the kernel is built.

     SRC_URI += "file://myconfig"
                

As mentioned earlier, you can group related configurations into multiple files and name them all in the SRC_URI statement as well. For example, you could group separate configurations specifically for Ethernet and graphics into their own files and add those by using a SRC_URI statement like the following in your append file:

     SRC_URI += "file://myconfig \
            file://eth.cfg \
            file://gfx.cfg"