diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index 36f67f10c3..c5ff3b29b5 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml @@ -1602,18 +1602,21 @@ If you are fetching your source files from an upstream source - archived tarball then you normally do not need to set - S. + archived tarball and the tarball's internal structure matches + the common convention of a top-level subdirectory named + ${BPN}-${PV}, + then you do not need to set S. However, if SRC_URI specifies to fetch - source from an SCM like Git or Subversion, your recipe needs - to define S. + source from an archive that does not use this convention, + or from an SCM like Git or Subversion, your recipe needs to + define S. If processing your recipe using BitBake successfully unpacks - the source files, you need to be sure that the structure - created in ${S} matches the structure - from the source. + the source files, you need to be sure that the directory + pointed to by ${S} matches the structure + of the source.