diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml index d1bfc23362..fe4372adeb 100644 --- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml @@ -736,6 +736,10 @@ The fetcher's temporary working directory is set by P4DIR, which defaults to "DL_DIR/p4". + The fetcher does not make use of a perforce client, instead it + relies on p4 files to retrieve a list of + files and p4 print to transfer the content + of those files locally. @@ -783,6 +787,62 @@ to "${WORKDIR}/p4" in your recipe. + + + By default, the fetcher strips the depot location from the + local file paths. In the above example, the content of + example-depot/main/source/ + will be placed in ${WORKDIR}/p4. + For situations where preserving parts of the remote depot paths + locally is desirable, the fetcher supports two parameters: + + + + "module": + The top-level depot location or directory to fetch. The + value of this parameter can also point to a single file + within the depot, in which case the local file path will + include the module path. + + + "remotepath": + When used with the value "keep", + the fetcher will mirror the full depot paths locally + for the specified location, even in combination with + the module parameter. + + + + + + Here is an example use of the the module + parameter: + + + SRC_URI = "p4://user:passwd@example-depot/main;module=source/..." + + + In this case, the content of the top-level directory + source/ will be fetched to + ${P4DIR}, including the directory itself. + The top-level directory will be accesible at + ${P4DIR}/source/. + + + + Here is an example use of the the remotepath + parameter: + + + SRC_URI = "p4://user:passwd@example-depot/main;module=source/...;remotepath=keep" + + + In this case, the content of the top-level directory + source/ will be fetched to + ${P4DIR}, but the complete depot paths will + be mirrored locally. The top-level directory will be accessible + at ${P4DIR}/example-depot/main/source/. +