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 f168cfa686..2a3340b399 100644 --- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml @@ -670,8 +670,8 @@ The module and vob options are combined to create the load rule in the view config spec. - As an example, consider the vob and - module values from the + As an example, consider the vob and + module values from the SRC_URI statement at the start of this section. Combining those values results in the following: @@ -716,6 +716,68 @@ +
+ Perforce Fetcher (<filename>p4://</filename>) + + + This fetcher submodule fetches code from the + Perforce + source control system. + The executable used is specified by + FETCHCMD_p4, which defaults + to "p4". + The fetcher's temporary working directory is set by + P4DIR, + which defaults to "DL_DIR/p4". + + + + To use this fetcher, make sure your recipe has proper + SRC_URI, + SRCREV, and + PV values. + The p4 executable is able to use the config file defined by your + system's P4CONFIG environment variable in + order to define the Perforce server URL and port, username, and + password if you do not wish to keep those values in a recipe + itself. + If you choose not to use P4CONFIG, + or to explicitly set variables that P4CONFIG + can contain, you can specify the P4PORT value, + which is the server's URL and port number, and you can + specify a username and password directly in your recipe within + SRC_URI. + + + + Here is an example that relies on P4CONFIG + to specify the server URL and port, username, and password, and + fetches the Head Revision: + + SRC_URI = "p4://example-depot/main/source/..." + SRCREV = "${AUTOREV}" + PV = "p4-${SRCPV}" + S = "${WORKDIR}/p4" + + + + + Here is an example that specifies the server URL and port, + username, and password, and fetches a Revision based on a Label: + + P4PORT = "tcp:p4server.example.net:1666" + SRC_URI = "p4://user:passwd@example-depot/main/source/..." + SRCREV = "release-1.0" + PV = "p4-${SRCPV}" + S = "${WORKDIR}/p4" + + + You should always set S + to "${WORKDIR}/p4" in your recipe. + + +
+
Other Fetchers @@ -725,9 +787,6 @@ Bazaar (bzr://) - - Perforce (p4://) - Trees using Git Annex (gitannex://) diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml index e26422a421..e81f3ed653 100644 --- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.xml @@ -52,7 +52,7 @@ M O - P + P R S @@ -1769,6 +1769,15 @@ P + P4DIR + + + The directory in which a local copy of a Perforce depot + is stored when it is fetched. + + + + PACKAGES The list of packages the recipe creates.