summaryrefslogtreecommitdiffstats
path: root/bitbake/doc/bitbake-user-manual
diff options
context:
space:
mode:
authorAlexandru N. Onea <onea.alex@gmail.com>2020-06-23 12:00:51 +0300
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-06-25 10:24:02 +0100
commite95c36f8a7355aae12e310b2879b106a3f010adb (patch)
tree6c5a4ec7fdc3f3180e8763ca401c4f464bf94f5b /bitbake/doc/bitbake-user-manual
parentb7006f50c7b4b98ed15a1d8c15aeeb88719a9d8a (diff)
downloadpoky-e95c36f8a7355aae12e310b2879b106a3f010adb.tar.gz
bitbake: bitbake-user-manual: update perforce fetcher docs
This change updates the perforce documentation by describing two new parameters: module and remotepath. Additionally, a general statement regarding the fetcher implementation has been added, to make it clear that the fetcher does not use a perforce client for the job. (Bitbake rev: 44b57216548fa96a5ecab02cfed517e0d631dc44) Signed-off-by: Alexandru N. Onea <onea.alex@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'bitbake/doc/bitbake-user-manual')
-rw-r--r--bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.xml60
1 files changed, 60 insertions, 0 deletions
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 @@
736 The fetcher's temporary working directory is set by 736 The fetcher's temporary working directory is set by
737 <link linkend='var-bb-P4DIR'><filename>P4DIR</filename></link>, 737 <link linkend='var-bb-P4DIR'><filename>P4DIR</filename></link>,
738 which defaults to "DL_DIR/p4". 738 which defaults to "DL_DIR/p4".
739 The fetcher does not make use of a perforce client, instead it
740 relies on <filename>p4 files</filename> to retrieve a list of
741 files and <filename>p4 print</filename> to transfer the content
742 of those files locally.
739 </para> 743 </para>
740 744
741 <para> 745 <para>
@@ -783,6 +787,62 @@
783 to <filename>"${WORKDIR}/p4"</filename> in your recipe. 787 to <filename>"${WORKDIR}/p4"</filename> in your recipe.
784 </note> 788 </note>
785 </para> 789 </para>
790
791 <para>
792 By default, the fetcher strips the depot location from the
793 local file paths. In the above example, the content of
794 <filename>example-depot/main/source/</filename>
795 will be placed in <filename>${WORKDIR}/p4</filename>.
796 For situations where preserving parts of the remote depot paths
797 locally is desirable, the fetcher supports two parameters:
798
799 <itemizedlist>
800 <listitem><para>
801 <emphasis>"module":</emphasis>
802 The top-level depot location or directory to fetch. The
803 value of this parameter can also point to a single file
804 within the depot, in which case the local file path will
805 include the module path.
806 </para></listitem>
807 <listitem><para>
808 <emphasis>"remotepath":</emphasis>
809 When used with the value "<filename>keep</filename>",
810 the fetcher will mirror the full depot paths locally
811 for the specified location, even in combination with
812 the <filename>module</filename> parameter.
813 </para></listitem>
814 </itemizedlist>
815 </para>
816
817 <para>
818 Here is an example use of the the <filename>module</filename>
819 parameter:
820
821 <literallayout class='monospaced'>
822 SRC_URI = "p4://user:passwd@example-depot/main;module=source/..."
823 </literallayout>
824
825 In this case, the content of the top-level directory
826 <filename>source/</filename> will be fetched to
827 <filename>${P4DIR}</filename>, including the directory itself.
828 The top-level directory will be accesible at
829 <filename>${P4DIR}/source/</filename>.
830 </para>
831
832 <para>
833 Here is an example use of the the <filename>remotepath</filename>
834 parameter:
835
836 <literallayout class='monospaced'>
837 SRC_URI = "p4://user:passwd@example-depot/main;module=source/...;remotepath=keep"
838 </literallayout>
839
840 In this case, the content of the top-level directory
841 <filename>source/</filename> will be fetched to
842 <filename>${P4DIR}</filename>, but the complete depot paths will
843 be mirrored locally. The top-level directory will be accessible
844 at <filename>${P4DIR}/example-depot/main/source/</filename>.
845 </para>
786 </section> 846 </section>
787 847
788 <section id='repo-fetcher'> 848 <section id='repo-fetcher'>