Documentation: Default FILESDIR

Documentation: Default FILESDIR

[Darren Hart]

When a new user goes to write a recipe and add a patch or other file,
they need to understand FILESDIR and where to put these additional
files. I scanned the reference manual and the dev manual and came up
mostly empty handed. The one glipse of it is in section 5.1.4 of the
Reference Manual:

"
It is useful when making changes directly to the work directory files to
do so using the Quilt tool as detailed in the Modifying Package Source
Code with Quilt section. Using Quilt, you can copy patches into the
recipe directory and use the patches directly through use of the SRC_URI
variable.
"

Unfortunately, this doesn't say where the recipe directory is and what
it should be named.

Is this documented somewhere that I missed? If not, Scott can you add
this task to your list of doc gaps?

-- 
Darren Hart
Intel Open Source Technology Center
Yocto Project - Linux Kernel

Re: Documentation: Default FILESDIR

[Chris Larson]

On Wed, Feb 29, 2012 at 5:11 PM, Darren Hart <dvhart@linux.intel.com> wrote:
> When a new user goes to write a recipe and add a patch or other file,
> they need to understand FILESDIR and where to put these additional
> files. I scanned the reference manual and the dev manual and came up
> mostly empty handed. The one glipse of it is in section 5.1.4 of the
> Reference Manual:
>
> "
> It is useful when making changes directly to the work directory files to
> do so using the Quilt tool as detailed in the Modifying Package Source
> Code with Quilt section. Using Quilt, you can copy patches into the
> recipe directory and use the patches directly through use of the SRC_URI
> variable.
> "
>
> Unfortunately, this doesn't say where the recipe directory is and what
> it should be named.
>
> Is this documented somewhere that I missed? If not, Scott can you add
> this task to your list of doc gaps?

FILESDIR hasn't actually been used (or, shouldn't have been) for
years. FILESPATH replaced it.
-- 
Christopher Larson

Re: Documentation: Default FILESDIR

[Darren Hart]

On 02/29/2012 04:27 PM, Chris Larson wrote:
> On Wed, Feb 29, 2012 at 5:11 PM, Darren Hart <dvhart@linux.intel.com> wrote:
>> When a new user goes to write a recipe and add a patch or other file,
>> they need to understand FILESDIR and where to put these additional
>> files. I scanned the reference manual and the dev manual and came up
>> mostly empty handed. The one glipse of it is in section 5.1.4 of the
>> Reference Manual:
>>
>> "
>> It is useful when making changes directly to the work directory files to
>> do so using the Quilt tool as detailed in the Modifying Package Source
>> Code with Quilt section. Using Quilt, you can copy patches into the
>> recipe directory and use the patches directly through use of the SRC_URI
>> variable.
>> "
>>
>> Unfortunately, this doesn't say where the recipe directory is and what
>> it should be named.
>>
>> Is this documented somewhere that I missed? If not, Scott can you add
>> this task to your list of doc gaps?
> 
> FILESDIR hasn't actually been used (or, shouldn't have been) for
> years. FILESPATH replaced it.

Sorry, I should have said FILESPATH - that's what I get for not looking
it up. The situation is unchanged though.

-- 
Darren Hart
Intel Open Source Technology Center
Yocto Project - Linux Kernel

Re: Documentation: Default FILESDIR

[Rifenbark, Scott M]

Darren, 

Please look at http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#platdev-appdev-insitu in the YP Reference manual.  This is the section you refer to in this mail.  The link in this latest version correctly goes to the referenced Quilt section, which has significantly changed.  The little paragraph you quote below is now basically part of the 9-step Quilt process in the YP Dev manual (http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#using-a-quilt-workflow). 

Can you look at these two sections now and then provide me with FILESPATH information so I can create a glossary entry for the item and possibly work the use of FILESPATH into the updated Quilt section?

Thanks, 
Scott

-----Original Message-----
From: Darren Hart [mailto:dvhart@linux.intel.com] 
Sent: Wednesday, February 29, 2012 6:40 PM
To: Chris Larson
Cc: Yocto Project; Perez-Gonzalez, Inaky; Rifenbark, Scott M
Subject: Re: [yocto] Documentation: Default FILESDIR



On 02/29/2012 04:27 PM, Chris Larson wrote:
> On Wed, Feb 29, 2012 at 5:11 PM, Darren Hart <dvhart@linux.intel.com> wrote:
>> When a new user goes to write a recipe and add a patch or other file,
>> they need to understand FILESDIR and where to put these additional
>> files. I scanned the reference manual and the dev manual and came up
>> mostly empty handed. The one glipse of it is in section 5.1.4 of the
>> Reference Manual:
>>
>> "
>> It is useful when making changes directly to the work directory files to
>> do so using the Quilt tool as detailed in the Modifying Package Source
>> Code with Quilt section. Using Quilt, you can copy patches into the
>> recipe directory and use the patches directly through use of the SRC_URI
>> variable.
>> "
>>
>> Unfortunately, this doesn't say where the recipe directory is and what
>> it should be named.
>>
>> Is this documented somewhere that I missed? If not, Scott can you add
>> this task to your list of doc gaps?
> 
> FILESDIR hasn't actually been used (or, shouldn't have been) for
> years. FILESPATH replaced it.

Sorry, I should have said FILESPATH - that's what I get for not looking
it up. The situation is unchanged though.

-- 
Darren Hart
Intel Open Source Technology Center
Yocto Project - Linux Kernel

Re: Documentation: Default FILESDIR

[Paul Eggleton]

On Thursday 01 March 2012 15:36:27 Rifenbark, Scott M wrote:
> Please look at
> http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.htm
> l#platdev-appdev-insitu in the YP Reference manual.  This is the section you
> refer to in this mail.  The link in this latest version correctly goes to
> the referenced Quilt section, which has significantly changed.  The little
> paragraph you quote below is now basically part of the 9-step Quilt process
> in the YP Dev manual
> (http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#using-a
> -quilt-workflow).
> 
> Can you look at these two sections now and then provide me with FILESPATH
> information so I can create a glossary entry for the item and possibly work
> the use of FILESPATH into the updated Quilt section?

I think additional file paths are outside the scope of the Quilt section 
itself, but it could easily link to a separate section that does discuss it.

It's worth noting though that we tend not to modify FILESPATH directly 
anymore; instead we use FILESEXTRAPATHS. I believe there are examples of using 
this in the BSP guide, although we do still need to have this documented in 
the reference manual.

Cheers,
Paul

-- 

Paul Eggleton
Intel Open Source Technology Centre

Re: Documentation: Default FILESDIR

[Darren Hart]

On 03/01/2012 07:36 AM, Rifenbark, Scott M wrote:
> Darren,
> 
> Please look at
> http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#platdev-appdev-insitu
> in the YP Reference manual.  This is the section you refer to in this
> mail.  The link in this latest version correctly goes to the
> referenced Quilt section, which has significantly changed.  The
> little paragraph you quote below is now basically part of the 9-step
> Quilt process in the YP Dev manual
> (http://www.yoctoproject.org/docs/latest/dev-manual/dev-manual.html#using-a-quilt-workflow).

OK, this does cover where to put the patch. However, someone looking to
write a recipe when they already have the patches they want may not
think to look for how to do this in a "Using a Quilt Workflow" section.
I think we should have a blurb about this in a section about writing
recipes:

"Add any additional files and patches referenced in the SRC_URI in the
same directory as the recipe so bitbake can find them."

> 
> Can you look at these two sections now and then provide me with
> FILESPATH information so I can create a glossary entry for the item
> and possibly work the use of FILESPATH into the updated Quilt
> section?

I don't know that I'm the best person to define these... however, this
is my understanding, someone else should confirm:

FILESPATH: The ":" delimited set of paths that bitbake will search for
files referenced in the SRC_URI. Defaults to ".:files:${PN}".

FILESEXTRAPATHS: Appends a ":" delimited set of paths to FILESPATH. This
is intended for use in .bbappend files to include any additional files
provided in that layer. This is typically done as:
FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:"

As an aside, it might be nice to make this 'FILESEXTRAPATHS_prepend :=
"${THISDIR}/${PN}:"' the default for bbappend files. Although I imagine
there are good reasons for why it is the way it is.

--
Darren

> 
> Thanks, Scott
> 
> -----Original Message----- From: Darren Hart
> [mailto:dvhart@linux.intel.com] Sent: Wednesday, February 29, 2012
> 6:40 PM To: Chris Larson Cc: Yocto Project; Perez-Gonzalez, Inaky;
> Rifenbark, Scott M Subject: Re: [yocto] Documentation: Default
> FILESDIR
> 
> 
> 
> On 02/29/2012 04:27 PM, Chris Larson wrote:
>> On Wed, Feb 29, 2012 at 5:11 PM, Darren Hart
>> <dvhart@linux.intel.com> wrote:
>>> When a new user goes to write a recipe and add a patch or other
>>> file, they need to understand FILESDIR and where to put these
>>> additional files. I scanned the reference manual and the dev
>>> manual and came up mostly empty handed. The one glipse of it is
>>> in section 5.1.4 of the Reference Manual:
>>> 
>>> " It is useful when making changes directly to the work directory
>>> files to do so using the Quilt tool as detailed in the Modifying
>>> Package Source Code with Quilt section. Using Quilt, you can copy
>>> patches into the recipe directory and use the patches directly
>>> through use of the SRC_URI variable. "
>>> 
>>> Unfortunately, this doesn't say where the recipe directory is and
>>> what it should be named.
>>> 
>>> Is this documented somewhere that I missed? If not, Scott can you
>>> add this task to your list of doc gaps?
>> 
>> FILESDIR hasn't actually been used (or, shouldn't have been) for 
>> years. FILESPATH replaced it.
> 
> Sorry, I should have said FILESPATH - that's what I get for not
> looking it up. The situation is unchanged though.
> 

-- 
Darren Hart
Intel Open Source Technology Center
Yocto Project - Linux Kernel

Re: Documentation: Default FILESDIR

[Joshua Immanuel]

[-- Attachment #1: Type: text/plain, Size: 1268 bytes --]

Hello Darren,

On Thu, 2012-03-01 at 11:17 -0800, Darren Hart wrote:
> FILESPATH: The ":" delimited set of paths that bitbake will search for
> files referenced in the SRC_URI. Defaults to ".:files:${PN}".
> 
> FILESEXTRAPATHS: Appends a ":" delimited set of paths to FILESPATH.
> This
> is intended for use in .bbappend files to include any additional files
> provided in that layer. This is typically done as:
> FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:"
> 
> As an aside, it might be nice to make this 'FILESEXTRAPATHS_prepend :=
> "${THISDIR}/${PN}:"' the default for bbappend files. Although I
> imagine
> there are good reasons for why it is the way it is.

Thanks for the documentation. In this regard I would like to clarify a
small doubt. When I bbappend the xserver-xf86-config_0.1 recipe in order
to override the default xorg.conf, FILESEXTRAPATHS_prepend doesn't seem
to have an effect. As I am not adding an extra file but trying to
replace the default file of the recipe, should I manipulate the
FILESPATH variable?

I am asking this because Paul mentioned that we should not modify the
FILESPATH directly.

Please guide me.

Regards
Joshua
-- 
Joshua Immanuel
HiPro IT Solutions Private Limited
http://hipro.co.in

[-- Attachment #2: This is a digitally signed message part --]
[-- Type: application/pgp-signature, Size: 205 bytes --]