This section from the glossar "SRC_URI": """ Standard and recipe-specific options for SRC_URI exist. Here are standard options: apply - Whether to apply the patch or not. The default action is to apply the patch. striplevel - Which striplevel to use when applying the patch. The default level is 1. patchdir - Specifies the directory in which the patch should be applied. The default is ${S}. Here are options specific to recipes building code from a revision control system: mindate - Apply the patch only if SRCDATE is equal to or greater than mindate. maxdate - Apply the patch only if SRCDATE is not later than mindate. minrev - Apply the patch only if SRCREV is equal to or greater than minrev. maxrev - Apply the patch only if SRCREV is not later than maxrev. rev - Apply the patch only if SRCREV is equal to rev. notrev - Apply the patch only if SRCREV is not equal to rev. Here are some additional options worth mentioning: unpack - Controls whether or not to unpack the file if it is an archive. The default action is to unpack the file. destsuffix - Places the file (or extracts its contents) into the specified subdirectory of WORKDIR when the Git fetcher is used. subdir - Places the file (or extracts its contents) into the specified subdirectory of WORKDIR when the local (file://) fetcher is used. localdir - Places the file (or extracts its contents) into the specified subdirectory of WORKDIR when the CVS fetcher is used. subpath - Limits the checkout to a specific subpath of the tree when using the Git fetcher is used. name - Specifies a name to be used for association with SRC_URI checksums when you """ should also be mentioned prominently in the "Fetchers" section.
IMHO, I'd actually rather these were expanded upon in the fetchers section *instead of* the SRC_URI glossary entry, with a link to the former from the latter. The SRC_URI glossary entry is way too long at the moment.
+1
Hi, So in looking into this a bit with Paul it gets a bit confusing where to really place all the SRC_URI stuff that appears with the variable's description - http://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#var-SRC_URI. My opinion is that a reference manual is the spot regardless of how big or long this list becomes. The issue with the YP manual set and SRC_URI is that there are many many linked references to that particular variable. No one spot exists to describe all this stuff, hence, it is suited for reference material. There is a "Fetchers" section in the BitBake User's Manual but we are trying to keep that manual somewhat "divorced" from the mainstream YP docs. In fact, we don't link into the YP docs from the BB manual, although links the other way are acceptable. We need to research this a bit more and decide what the best solution here is for covering all the URI protocols and other options that are currently in the SRC_URI variable description. My two cents are to keep them in the variable description as part of the reference. By nature, reference material can get long and sometime redundant but that is acceptable for that kind of information. Scott
Hi, My opinion is that this stuff still needs to stay in the ref-manual. The many areas in the YP doc set and the BB manual that deal with fetching all adequately cross-reference the SRC_URI variable. Having the SRC_URI well documented in the glossary I think is the way to go. Scott
I think we're going to need to resolve this in 2.3.
I compared the glossary entries for SRC_URI in the dev-manual against the same entry in the bitbake-user-manual. The list in the dev-manual is much more comprehensive that the same one in the BB manual. I still feel that the reference glossary entry for the SRC_URI variable should list all these items as part of the SRC_URI glossary entry. The fetcher section in the BB manual can point to a more complete version of the SRC_URI glossary description in the BB manual. Is it safe to say that the information in the SRC_URI variable in the ref-manual would be the same for the SRC_URI glossary description in the BB manual? Here are the links to each of them: BB-manual - http://www.yoctoproject.org/docs/2.3/bitbake-user-manual/bitbake-user-manual.html#var-SRC_URI ref-manual - http://www.yoctoproject.org/docs/2.3/ref-manual/ref-manual.html#var-SRC_URI Scott Also - regarding doing this in 2.3... we are well past the time where any changes in the docs will get into the tarball that is released for 2.3. However, any changes made at this time would certainly be included as part of the HTML version of the manuals available on the website, which is probably what most people use for referencing the documentation anyway.
The Bitbake manual section is intentionally limited to those items that bitbake intrinsically supports; e.g. any functionality to do with patch application is provided by OE and not bitbake and thus it should only be in the YP ref manual, so we don't want to make these the same.
Ok - then we have two disparate reference for SRC_URI, which is what we currently have. I can bolster the referencing of the fetcher's section into the BB glossary description of SRC_URI. I do not want to pull that reference information out and put it or duplicate it in the fetcher's section. Scott
Bulk move of 5.1 M4 to 5.2 M2 as approved by AlexB.
Bulk move of bugs I am assigned to from Milestone 5.2M4 to 5.3M1.