From 51cf12c25380483518ec324d8e3ea4badef3a8db Mon Sep 17 00:00:00 2001 From: Derek G Foster Date: Tue, 12 Sep 2023 07:09:12 -0700 Subject: [PATCH] Document config-cross-recipe.sh helper script (#276) Signed-off-by: Derek G Foster --- docs/scripts/config-cross-recipe-flow.png | Bin 0 -> 10700 bytes docs/scripts/config-cross-recipe.rst | 171 ++++++++++++++++++++++ docs/scripts/helper-scripts.rst | 1 + 3 files changed, 172 insertions(+) create mode 100644 docs/scripts/config-cross-recipe-flow.png create mode 100644 docs/scripts/config-cross-recipe.rst diff --git a/docs/scripts/config-cross-recipe-flow.png b/docs/scripts/config-cross-recipe-flow.png new file mode 100644 index 0000000000000000000000000000000000000000..ab1ab1dec0c79d6a0984955dc913585d872b7e85 GIT binary patch literal 10700 zcmb_?Wl)?=@Fx-+g1ZM;+})Po5ZpotAp~38Jy>uJE?JxeLJ01z!C5Rg!50rMi^Dy6 zuj)Qs{p&v5R_$(2&Ga+ROixdD|GJ~KHI?zOsj!idknmJh6m*f0P+kCZ7bXhu+t8P{ z4E!Ox>nh73RgBT>0gY$YvKq2TNYx2A_hx878_Pw-$Q=pk`LBOpKi( z-j7#5fLUE#UBHuYy+&IZR$k8SIcNj4QlpZghlhu#7|%VF2M z_OVq(+Tf%DqN2smDY+-e3=LIYF{X?X$YC-XL<-1bGBUqp6AUAeLkasI8hRG#M4r(s z!Wx*2laT_%X1@hYmIh$)TD@oPa@x?cGmr zSUs5i@S($Rc#F#n#9l+_o1b%o4yeKih=@|5!vsk(p#;%!kU@4e!)a5$SwfTy(2qTZ zp4P~?HTb4s)@8O>y&CAi99W}e9^i*^IFjdiZEbjmBb-a=Du>_OP`NH6*b z0=b@G0X_B!bn4QbVd}qDc&tlzmi_G*gAu0O0vpND?=7WX971PHtd>&x}ELe=W_QA$G1BFadgsc1bR5zHu^_ z^A|H2lru;}LiAs)_QUt-Bzh9WQ{_mSHDrxxO;CkO)HWYhBMuU;=Fmq zz3q4&6Joo2U4G8nLf}iL!ua@ZMiD{2bR#Z@y4(qDz993~=@juJ677wB&mH0m zBonZnRSeVNc<)Pk9#@BSZ8|RH7AldCn7Zos;*egFqIF-`$4;LMDpO9 zp$|QQ$IuugQ*I2*qM1^mh}IDK*U#sD_u&|%@)EW$s;3ya;l`7TI?{%O$YY0odm$(4 zAoVa3&KX4t^&ZJ@!Qs-)8VVqgi-KrFP!uqu&P4>ZSl=osIzWevWoHNVM@rZ#_QMFi z5~e~Kf|)Jppiz`KPd1b#)Q{MRTFPoL6R)Q9bXZKuQ1%9(l4kNyM&PtFq*4M}iY)j4 z*7#}(@$gYdy}8*)Bduq1 zv#>=jdGz-7HW(FSdO%<3?&`R5fi`F@7z2D+qE!O@3eC#WGo;`f85!A6M4pu=WuHVt)-Lat{vL1J>b}MJ5{anR5)y~e&jDHtRy|$oY zZ9~I%o&?L#*BQ5QF{q8yHPefWF*Yx$Waq$(P3-@eTkwaa~m52Mhb zs|G8mMYMINF?iYqX2?SMLnb1Sx}?{>+JWR4Ho6YwZ9j~Sjm5{s{h%b`Gh^Wo^m2bI z|8JBfdR=3qa%Em|Ypb7?mE!0$O<0!6pQ>_731(oB^?!r-tbqHwzOL>ER3%XzR4UL= z?m%#Tl4M8v_#y(V8kcACWmX#!$Dj^H)}g}5ADT+yG_1I|x+GOdi|1uzQPYXMYsdYr17n%~RI<&X=cJXWxQu>5de8FRnZ<`mU% z9H9-Ppi%RusSV>YZ{lG&^?7hhEVh0B>CYmB=-Rn28z9f#jR50;r|Ht&d)XYTyNMc#E)*o8vIkCfcE1sy0+qR9?pRLtMaYVKTia z?0m@tohVo)-B=7X@G^ozb!W6+)JdOZ-$Jadi(<{?%43B9)`9#wC6JK1m5?$o)b-;~ zSVI$Lb>6TzG$HWfo1>$nUCEIDvEORzamU@JV(_4hm=%#8ol>E2Q?Z7I#{cF@8f7DW zddEj#;?6BWwr zr_6R$d=e6DOi(+grljmX(+$X;MxvD*B_Kf@EHH)UGq2t;PsB94ZDHd+zce=f^Qd8X zznb@m54X;36T4g5_>D7XdLP-i5{Mtf|8P({o^vz8swHz8UQr=t_Z6ItL0Ib|i7ERk zCm1Kpb~MXJygO|pc}BSDCCO{yGo)@6P>PGipsJzaTz4qO_!}nq#X@N4h z6^T!;Bs{3aMHV_ot^2j6Vj#Fl2Hu5s~fV z#AiR1L`wAS{Qdn`I|2yeCMR`%3>vf4w6uJ@y|8V@prLY9um8JdMxHm{1FB6RYBKRMXkj}Ld_Ig;Mz+ZrrXq@Uuf?d-7GHI0ppC(M5_gT(Ao zX4jtg5U(e&YBI0ET~4qA?k`1GA`5EfTDX`DB@}4&4 zI{j)BPn!>TBTozFsm@uARu&$osEwV2_J(Q+_%Nd_q8=U|1PH#VZjm#(2Pb-XdylB0 zYPv<>`+oR2omCyY3=ey28T60u9oLyRMb@LF=L>+pd^^Fgc|GPQ{&J))^-L?My z@VU$N+V}lCJb#~# zk1P_TJ1U!f0|V&>6k&2Cbd;3QmQxh6M$hMRv$K2AUU-H^nzneT+RA-+`77UYqL$-1 z@dqM3wGb8iDlJST|0P=m^d0!G=oGOa;?@qlzE2Jyx&(SDpIv2{$LNu30laMg{+-6o zp8m+1hYF6$`_1CW=XkyF<-8l1b)sX56GU!yT5MEcl`YPL`6jnt}7YEb|)q#O7x1SOGuuTBy<|) zsH!)SsMyDN(CGi6j}36XdpPR4|1ay?yWG=;)sO<*da*wC14(9a>^uZXU$E@CaIg0F!p46*xrdkfV%3%`F0Bt6(kg7_s81HeFsjmE4S#U>AM=R$Ke!57*IyG7hBv9r!WX%u;SfwebOx_{4i zM*Uda%?N0L3k@%~m*iJZj~s9qgOylNUgroC$TuWGdv_yP%e$AmA3}bUP|RLV_x5&& zMs9wXoCu)l=yFBwF8Bt^mJ&a^nH+F{j|jQAQRdZj>VC#AqPX)rPN-SB>ml#J9M{>g z24l{amzU2~ni`tDM|E0hqm1oyL)0?Ks8rt^LG`oc6}{ zVht*&g}x8x!QdSpAdXI9Vq)4SQ8k#mYZ~~e*I{HAYDz6DY+EPxG`=Kj4(z7SQM78mBR#{B_;iJS2uqSnAt^?gViIBrCOfJsp`)Ej_yw?Q>Qz5-@k`47Z)^qx3=qDU7tYX7H8E>P4iPz@Qb~> zUt~76w(JvoT0L@LxpTM>PI^YhI()d>^YYZ^-Mwyvl$kE6M-mi>m4z&VT(3lbUoRo7 zsR1$c^cz+`Y>9wVW!ia%olX5{`Nt**6L-e*@B`i%@xx$%;CzW#<4y`u(h{+Fz-23h>C z>wLn28R}c_I{cd}E455sjwW>`lk@ky>Xtt}twB>tUwvAqwX~?;llY}GO&ddSbVAVq zySThG&3*D}IAy;ZvGAX%=@bA4hKGl51bGX*<6>Q{3~AK4Kp-N{u+fFOTED5hfiqiF zr_Ti4v)=lE`v(SQXk*AUYeAM!*{tgNdhS1uZWQ#dMnCgbJ}lq8OhX{Nm~sgiSYJZ& zUo`5JRaEqw^LtYEs+UEE;M?!PebM?)U27${>sTzINuxB4r#FX{Kl=@n9>n{-k3;cw z0G3qG@%_^gt;=HCWH0O7o|WpR8~-^w58>CdhyF-iYPkHuY6rGDP6`rIdX;hGU@ zxC!?|9Pl6cxxEEgnNx-)gRXoM`wa^p(wzNk7*g%;zSj2lE8&?Y8F6G~Wu3SqvM2`t z*A3b!MU6}^<8?rBzV`}K1F~^?v~}E}-F8}#Y93_3-;r~OulOf>@gnlcNsORN!Mr;C zc=cNL6nx}%l6iAI_B_7EB^(u*;{^>=7JYGI;$-o!b8}p!%H27|DyLRstf5hM(?`c2 zPS^>7b?*!wel%>kUSxN-K6 z+tYw6yV!BkssDTL0`RG4!U>6Aj(o6T(?O$e9FBh;PxK>!Ud*NI#!)**W!%GS48|Oj z4mIxrpO-}G{L`rG)yF$gcdFIZ+^Us2R-#mx$8xlN&ou*w{4cwOiF)tVR!F5XU9F9k z;I;i!Qd^Fr|6IgO=DKB#g&5;@1i6`itPQRTky`rcx_qh!XzIwea!Y*c?7q#ZQml3{ z`7?)#a!5r5Pduk^luz4T>uNy3M-)933mSTSxeu1jLZUl2>)CIaLW1PNnT!p%l2n-v zM$k0tUcokhIGAyU`8k`*f+jq@7WL+z&rE0QjRKn?65z+3^Xu`^3p3{H!STMf$z8Z{ z`l+n5=DT{!?-lU9KYSgAxlZK7$7WcY3KV&X(9TwoCD--mup>lxe1ZK!zc)9dqGGD# zP<%_Tux$_lG=7tI-J$!C_KwQBqJ?muJL7$Ijr@jO#Qmu~6)*Za? zTM+0dl~08F9WQHQLkZEXhvKd|DLc|tO^N1Kp4QSVm6Zj`g#03vhqNr!OQS zb;arRQiJY6PBCK10uYgBV+fH76<`IxnadS(l~deRaXDHNfBaOz?qE!pq-9~p#K&ep zNMZE8K2Ss1q6(K*%!VQ4`_@cF#7pKNe7NrCf% zK?s+)Y&A$QA{>8S)oN)<97nwh(HW|rPt5*m{E5YY9<8drzHiRJpl5OMEjTM<{7L$G zylzaFej&dB2}Lo(#Lp4VSO9a;7m7mSXJf)$FaukQq_oyZXBc$n>c(ccmH(o0U=zKf z3sRO#q`daxnoS8H^?^|ERMn+B!KW%Dhv-_kSCAfEd%zM?}y-;)4jb<=^qc?A~30s~qpqA_D4TL6B+FxxQ-foX(-60P3G7Rww zVJff4sYf(o>DTo_-uU>>*Rnv=&QI1p4GjT-xybqXIp9}6TL(;y(yh;85_JF0C*0XG z5;mAns$R|B9rmh>Mv8F|x9of{=^HY|s`P30D#T~f%3l^cj;kQf*2_|9gN#~XGfUL@ zCuR<@!aaN-sR{F7qEdg&mqqYJWwjVM?OP4A-oUU%wh{j^IPA?~1!pZ({gRgW$LQ$j zJ{ZY;B#yapKC0{eDJFe&uymL*k2e~My=Z*P4=letb4hFEvEbepJH13|Us6YC!_Rn2 zB;sKzOXh;&;y2_$r{O>#b$n0}U9e|4a8i{?t@(bp3S=p%i@Q@D+=U4>YPmvwoUxL& zCbc(M^;xiTaUnQkuWZMqfhMJLiSUFjK$AHzv@it(`T0+aSjWj6{lyQ)*?B$>Eq9d! zcMYEP@donKCBT2%VR3ZN)yfn7*i(av2Ndgyj<$To3BDs29B(5Z!LYNo| z@_ibMxVJe*2#r9>0)^hur*)b?^;&ZREdGxyWKs6}8>OF6F8=Xmrt z;d2pxBgoPcI#FgQIv|(2FCEIrEI+nHzp|d{9ww*=Cy{1QwT&@HAukP<%!ura7tn!BX7!tPmuCI^lFXKLBp{ z#rtIaq9e1{w7&gwJ6PGuUcjEp$BQJ)OsAvnyXE2%70^t zj{Uiwa@>0_IGbc$I!m45%Af({&h5>8I)a=0Ld%mHwurJ()=kFKYxhKCKN#9}Vwa=` zLE2#NISqQe6^suBeBef2OiCT_b13EeI)9q|uN^Tij!jI^^!=~#oWCh|W3m(D_wHzx zz{Ym6kjFi(ptr!PHUYqDdD*eIlIgV^AW%t3$!syB+|z;sHa<4tS&G!8B*J$YEj@47 z_k>UhC~i{Sb}}F>Lb4I}xZ<_Y>@;cP7Dyj+4HWizR=)ujRUvle>WxCq#@ohmEje1) z<+DniT7|0W6z9CluudOjFK!V|0_25AN12Py9#XfWeo96<@yJA0(7o9g_m4CE zcvceQPqPrm!u|D)fJL*H5`>I69rosli(ZRW(m;f1y6@JqSD`P!O0%TOVrj}2eXX-~ zlX?KqHr&(o$UCX@$eM4!`~TptC#NvF{dFB6*a%yDw)E?R*Q2nYf`5GpZ${N!4Fj58 z`|e}SP(^l$1-BQZ&p%ykE0OZ5ma^6SeSYSIrl;>r7q?(Dno@{Oh24U0aOg5)xXt(3 z9qM%^=I%fd3*N@YWGzz~t3={49bzoQO7cYGXhohrSIw@WvU|0k@y3wEH?4>CrSVc9 zrvcZJ<;DkLFDW2UYa`xN#Ordx()!vul1cFFyAd(ewGhp8Q%Ai-n{-K_*6*1TQ3#Ad z-of5}+{!=vV4S}r1f^Ci&c9hII5_z2&89 zy^!LIY4g&ZF*vE|>&;lI{(?&(tO+Amj3HtJf(D1zOxF>z<5Wy9Cv%dr3$|)}US@vJgzN;9G~|^XhZH}^pd#!J9e zdhw$3-b3^JKfC?UtDV##Enw=No}LD>87)#@MG2e>qXC;u(%J9RR*Ala_cvyG%T^0i z!FY|;Hza+sEJ#hW{!F><;kYp9ZO8+bnNGrEuZpjl16S~#3P{ng!O{QP#}QhsoE0_s zSL_=}GKM&~!s?Tt9y zNTx{mJ5#pw-q_yB>Gd20slq`iD!QBlA#kei%I+sJNFzl9jrR8LJn4yLp~$<8P`fM- zoRgQHn4Dx+%4V~78H&4XHe&=E7qb6sKm!}Mc9icBFwTLBo>$MEUM837nCzsLSh@IEYXz_E*fq=}^GtzDsHmah&&6uN8N2aypv4+QCtM4g!I4rS4LJ z==|)qsdV={KO1R0q(VHt!Ez+dSY4`CmM9)pX56kG{+V~=kqeqsd8F*RB`AlVZFJ*_ z+Bya6C!!b!y$(MRwRoL48g_Ocq^zW*#1P1#Nj(ODC|X(xEqvxEZZB=k=*PvHOoT`% zjO2XL{8$F36~lxwHU`7V%#*A|#N_;3mY0_9;l{k=wm~e^d1`_oJd0k76;X|wUL|6V zVgT|g@{?QjnN46(&@Hd*jSpUIMEeE=2znTb!G4I6{J6>pflwUe{huD@00sph%aUyi zFaj4wNIeVIOYp<(?$Rlz~PS`&t|d_)?udwVNX-# zXwm&ukmpt+B%4zw@v9w(h)J;1qBevUOAnGfvx;Bgr^BIH(s-aeSa2 z+};N91WQ9AP%xTZ%re0pBfw~aXF%dA@TS!8oHB145vh;9Q+dPoXJKKXpn#FI7H@OJ z^zjTx@U&2vQ`yinkop{6imH=Pq~?`Z!taHzTpxf(AZ20|mxc9<-O2M8L5XAgUK<)3 z%!^=enyFarZYo*SB}ATWU+xmtz!*XR)7IvH*I?8i>E`E%XYHi$EG!R*&VLR%l6?F2 ztpM}pb$t-BIp3yAFk$;GoYOu|{tT}3%T5heO@jHB2Vc|sJrO)+O65jA0Xy{^VSE@@zd76L=m2}}_p(ihcxUb`FE6{Kx3sh<(+7}D zeZRh@Ha50Vw!21Wm!Fh_d^(UgUviL+ZPr5b`}mQJj7*zAriS3?(q;bx^Y;9S2niZORBvJB-i;IK7N6o7(qzg)V)(%tvY>2rk z>b#=A{!Z=po{(lTo+@$h6NlMQzb`#4M|NKJ#dWGvxM^yM1l17kON$*KM%=0RtEYZ9 z8coCCKVZ)9XzJ0>+`KR|Q*=1ur(%{^BP1%y=~#U#)fa}*ogkH4q}41Y37C|xV`=(W z?Uv|}#pUIP2WnBNtM`#-$(Km%DAMAboSgX57X&CR*oP9`1CQU&bB_I$hhje$Pa@%m z(06A^Jr>E!Zpz+Ae@gfp@m>H`L`396IB!Ln4;RA{%3bVlrf#(io=XJ6E^X>10)Q*- zr}eZ-^qA3s8j?td?TG^US7!VBZjh%Frt2oBa@CuLpq)~>!WbJ?K_qXgE9!;Pf#*FO zVkx@|t7)8uz~&3x_-bI%X`*iwYsP;;e;Wx%Qw#tfmYyvjEm}@|0TR&u+=A1QT6bix7EbXj0r8pRxjkm4gFrG2xJuMB1x9^J+jfOFz&Pm6n!@;eiwQ$)UYXk&y1X zeEt(!;XIt{>9w^FyWav=7FHrc$-xG?jJLzMU+RBHi8eGyrR!vcz&Ca$>D)uMjiu;< z5DV4@gO%bLyr%tFF7KcPO(_)hgXm+%>Tm})x0=pQnX=<475agapS6tL`Sq|*X=$X) zYxPcJP1a|HL(0hDRX>8H)(jQYjh8e}*$O6(r6JW@AM19VrSJAlu?? zfWOKJG33kI07#FXo}O55*x$qQUap^Mz1K$7{U2qWL(W~rEh(KkBm<jG- z6QGvI5xFkQeCiP9Gc+5(&F@}Sb9dkROxX2$-pj?Ms-uJM&UGbH76~PWBnya@CnqQS z`V?8n|4%-O9ut@TGE2=xRbA6X%!kFFnC@*uLT5{Luw%{}v)ximrcX%%ObaV35zF~A zsMK;V;;JxHKDt`5tj={*(b(%?2(H8tVCQTX8vBT ze4lRr0kVm<#QE(Tu{M1mp*K!c}og@c#AD0)5;CFoK%a z4@B~IxIpF7G77+l{jU!V=z9b3MT-GM(?3E0Aa?%|Aa(O7&_99!Ai)0!5`b{}M?43J zh<^kMKr{dZKOKl)!5Vlo3fvTmuQI@s)q&~xQHF6Dx4W4mD4tnG5b$Dd08XK2k_BM* zOc)u3|ED6e|HoRi|Ld@4svp1C0;nOxttRz{8dpiDlh;Zz0aHGVfQY#-rY~L~)JO|W z4hHOz3f44UzM=w)i$U)OGZDRJZk&<5k3_QE>{EIcNP4E21I@AQe{|MpzKWzZ;(RCRk&ay5 zSae{t+D!1@ZpWbMEMu)8JknJ#u}&@iG%?~PqvT9uN z&=?tkTAxCjR5DAAnCJs3kQ)6v!LJZdmh0<5>4iIY1m}0R!x<()#0{oYZP+d{AXK84 z%!XpfCR{|p^rxofZWw+A|LTeCtJ^VlCSyr3lwV{o`$(>DMjZKL&ikR7msqD0&;pwR z)Zh^SVhT${0*=W4-^PZOy}kX5n6k36ADqmE{|?OQzeU;kU#~x545#H{XIHGS0~MG^ Ns*0Kl6>=X!{uilrjP?Kk literal 0 HcmV?d00001 diff --git a/docs/scripts/config-cross-recipe.rst b/docs/scripts/config-cross-recipe.rst new file mode 100644 index 00000000..6e31ffa9 --- /dev/null +++ b/docs/scripts/config-cross-recipe.rst @@ -0,0 +1,171 @@ +.. Copyright 2023 Intel Corporation + SPDX-License-Identifier: Apache 2.0 + +====================== +config-cross-recipe.sh +====================== + +Helper script to configure CMake to cross-compile P4 Control Plane +for the Arm Compute Complex (ACC). + +Build flow +========== + +The ``config-cross-recipe.sh`` script is run after ``make-cross-ovs.sh``, +to configure the remainder of the P4 Control Plane build. + +.. image:: config-cross-recipe-flow.png + +After running this script, you will need to issue a separate command +to build and install the software. For example: + +.. code-block:: bash + + cmake --build build -j8 --target install + +Syntax +====== + +.. code-block:: text + + ./scripts/es2k/config-cross-recipe.sh \ + [--help|-h] \ + [--dry-run|-n] \ + [--build=BLDDIR | -B BLDDIR] \ + [--deps=DEPS | -D DEPS] \ + [--host=HOSTDEPS | -H HOSTDEPS] \ + [--ovs=OVS | -O OVS] \ + [--prefix=PREFIX | -P PREFIX] \ + [--sde=SDE | -S SDE] \ + [--toolchain=TOOLFILE | -T TOOLFILE ] \ + [--no-krnlmon] \ + [--no-ovs] + +Command-line parameters +======================= + +General +------- + +``--dry-run``, ``-n`` + Displays the parameters that will be passed to CMake, and exits. + +``--help``, ``-h`` + Displays usage information and exits. + +Paths +----- + +``--build=BLDDIR``, ``-B BLDDIR`` + Directory that CMake will use to perform the build. + Will be created if it does not exist. + + Specifies the value of the ``-B`` CMake option. + Can be used to create separate build directories for native and + cross-compiled builds. + Defaults to ``build``. + +``--deps=DEPS``, ``-D DEPS`` *(see note)* + Directory in which the Stratum dependencies for the runtime system + are installed. + + P4 Control Plane will be linked with these libraries. + Supplies the value of the ``DEPEND_INSTALL_DIR`` listfile variable. + Defaults to the value of the ``DEPEND_INSTALL`` environment variable, + if defined. + Otherwise, defaults to ``//opt/deps``. + +``--host=HOST``, ``-H HOST`` + Directory in which the Stratum dependencies for the development + system are installed. + + Used to compile Protobufs to C++ during cross-compilation. + Supplies the value of the ``HOST_DEPEND_DIR`` listfile variable. + Defaults to the value of the ``HOST_INSTALL`` environment variable, + if defined. + Otherwise, defaults to ``setup/hostdeps``. + +``--ovs=OVS``, ``-O OVS`` *(see note)* + Directory in which Open vSwitch is installed. + + May be omitted if the ``--no-ovs`` option is specified. + Supplies the value of the ``OVS_INSTALL_DIR`` listfile variable for + the P4 Control Plane build. + May be the same as the ``prefix`` directory, in which case OVS and + P4 Control Plane will be installed to the same directory tree. + Defaults to the value of the ``OVS_INSTALL`` environment variable, + if defined. + Otherwise, defaults to ``//opt/ovs``. + +``--prefix=PREFIX``, ``-P PREFIX`` *(see note)* + Directory in which P4 Control Plane will be installed. + Will be created if it does not exist. + + May be the same as the ``--ovs`` option, in which case OVS and + P4 Control Plane will be installed to the same directory tree. + Specifies the value of the ``CMAKE_INSTALL_PREFIX`` variable when + building P4 Control Plane. + +``--sde=SDE``, ``-S SDE`` *(see note)* + Directory in which the SDK for the Intel® IPU E2100 is installed. + + Supplies the value of the ``SDE_INSTALL_DIR`` listfile variable. + Defaults to the value of the ``SDE_INSTALL`` environment variable, + if defined. + Otherwise, defaults to ``//opt/p4sde``. + +``--toolchain=FILE``, ``-T FILE`` + Path to the CMake toolchain file. + + Specifies the value of the ``CMAKE_TOOLCHAIN_FILE`` variable. + Defaults to the value of the ``CMAKE_TOOLCHAIN_FILE`` environment + variable. + +.. note:: + ``//`` at the beginning of the directory path will be replaced with + the *sysroot* directory path. + +Options +------- + +``--no-krnlmon`` + Excludes the Kernel Monitor from the build. + + Sets the ``WITH_KRNLMON`` listfile option to FALSE. + +``--no-ovs`` + Excludes OVS from the build. + + Sets the ``WITH_OVSP4RT`` listfile option to FALSE. + +Environment variables +===================== + +``CMAKE_TOOLCHAIN_FILE`` + Path to the CMake toolchain file to be used. + Specifies the value of the ``CMAKE_TOOLCHAIN_FILE`` variable. + May be overridden by ``--toolchain=TOOLFILE``. + Must be defined. + +``DEPEND_INSTALL`` + Directory in which the Stratum dependencies for the runtime system + are installed. + Supplies the default value of the ``--deps`` option. + +``HOST_INSTALL`` + Directory in which the Stratum dependencies for the development system + are installed. + Supplies the default value of the ``--host`` option. + +``OVS_INSTALL`` + Directory in which Open vSwitch is installed. + Supplies the default value of the ``--ovs`` option. + +``SDE_INSTALL`` + Directory in which the SDK for the IPU E2100 is installed. + Supplies the default value of the ``--sde`` option. + +``SDKTARGETSYSROOT`` + Path to the system root (sysroot) directory for the ARM Compute Complex + (ACC) of the IPU E2100. + Must be defined. diff --git a/docs/scripts/helper-scripts.rst b/docs/scripts/helper-scripts.rst index 9e73d933..c306e6fa 100644 --- a/docs/scripts/helper-scripts.rst +++ b/docs/scripts/helper-scripts.rst @@ -9,3 +9,4 @@ Helper Scripts :maxdepth: 1 make-all + config-cross-recipe