From 266f9bc63218fc5ed78161838032ca2dbff629c0 Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Tue, 7 Nov 2023 18:10:02 +0100 Subject: [PATCH] Doc: Turn "Specifying Environment Settings" into how-tos Add a line drawing that describes the environment settings hierarchy. Task-number: QTCREATORBUG-29361 Change-Id: I7869797154c0e70263528a8635ea7f2dcee30f30 Reviewed-by: Eike Ziller --- .../images/qtcreator-edit-environment.webp | Bin 0 -> 5658 bytes ...reator-environment-settings-hierarchy.webp | Bin 0 -> 3662 bytes .../qtcreator-projects-environment.webp | Bin 0 -> 4728 bytes .../creator-projects-cmake-building.qdoc | 3 +- .../src/editors/creator-code-completion.qdoc | 9 +- .../creator-only/creator-language-server.qdoc | 4 +- .../src/howto/creator-external-tools.qdoc | 23 ++- .../creator-build-settings-qmake.qdoc | 2 +- .../creator-only/creator-projects-kits.qdoc | 2 +- .../creator-projects-settings-build.qdoc | 6 +- ...creator-projects-settings-environment.qdoc | 155 ++++++++++++------ .../creator-projects-settings-overview.qdoc | 17 +- ...ator-projects-settings-run-desktop.qdocinc | 2 +- .../creator-projects-settings-run.qdoc | 25 --- .../qtcreator-how-to-use-qtc-variables.qdoc} | 25 ++- doc/qtcreator/src/qtcreator-toc.qdoc | 1 - 16 files changed, 155 insertions(+), 119 deletions(-) create mode 100644 doc/qtcreator/images/qtcreator-edit-environment.webp create mode 100644 doc/qtcreator/images/qtcreator-environment-settings-hierarchy.webp create mode 100644 doc/qtcreator/images/qtcreator-projects-environment.webp rename doc/qtcreator/src/projects/{qtcreator-variables.qdocinc => creator-only/qtcreator-how-to-use-qtc-variables.qdoc} (64%) diff --git a/doc/qtcreator/images/qtcreator-edit-environment.webp b/doc/qtcreator/images/qtcreator-edit-environment.webp new file mode 100644 index 0000000000000000000000000000000000000000..f68eb52540e979e80893ac4d632a0366dfc43bab GIT binary patch literal 5658 zcmWIYbaN9DV_*n(bqWXzu<&6MV_?wV?&!}T7k&NT>Z02(*4=M*d^yWt`I)pxqbVo5 zTv=-ydbs|v`Q?{p@9xn$k$NmREiG-w=TA5P|F3`VTzsx&iD?|8x$vwBA(^jCy(e?d zpVKr=G{82ocUsq{8`g7*Q+M`G>reE4=rM`GAy<0ohqgI0a#Lr_EZm!PG;vCbcB-$x z;!5K)rc-yPp42NoQJ{5s+Dv(+$lKeN=RQ9CmyeA{hpJzP(`e{aF^0T+)JN|FUxV`O`+3O=F0Z-QbX7J2eyktLr(VC5cwwt!r^?y=| zdmDJ~2hX`1@*<6I%XH$3-%a29sNvTtTkY=img(nDz52P}yJ5{o%VXK+Pc2LTaLn1! z@Ry&D;~93(h=>!nCBG^hpC!6&`jV^jM31)b+UV|Dc`A`e)5YU_>r^vqexJEmdXig|<@?0x=M@wClD=z0g9jIo9*$x zy`|}id$`l9f(uJ^mOf>kfBI=w$7B`lH|0~=rk@TKDmlu2-dNyX_TNbYwd!4WPjPWh zTk=%b^Zfr$ovrbY%IDAR$=>_Jy?p)uPfuU_Z`ga^uJVQX{r&ZIRllv)ve)n7UfX>^ zr&B41!FEGmsp_-6yP6ub*Hs0E6i>D8{P1&&ueL{C^S=8=hlMYdzK_4NKI8taqONcY zt$o{zUUMJk+hex>Q!Ve@_&d9vo5$~~JGc9*`**SWO(m}%&)v1}k&a#NWiFwzjmf(& zJ#ZJCZS+A#sjd3|qgvPRr{f$yzS`6_e}CQLw=?9Ws?4wdU!5Pn-^Tv)<|EDWcXsUQ zW0NZvWx4KjDfCxH-7SmCYQ1tH%gQL88K<{Scz@u5-sZ#&j}Ci23swGK% zDT|`Rbd6u!y3=-b7gK@#V(wpe4t?>oTIg~%^c~YP=QHy)n0OiYY0oWDUcoKJHYMiU z^<2gGwaU}YzyGTH`t`N@_IE!$|1h3?YiV|ByT0(=j8fKvn->SfU$9blots{=@#4M; z=E=KkwTKc!lwk{6pm-Zad z`0eNZJ~{b0eEPNetoT>c-`nrm$-Y(8yk?Df{T}X_op$F|f1X(QK*nLlHc3;KS-Gzs zK03C$!|2PaPsi3rrq};|ef|Ca|L^~N`1a(2_K8#L&LY0>Jl`*(2b#brDn4gRiR<8S6YX*}`4E&tnJg7OZ> z{FLTA^eXh|SNpmzPprR-$G=-4!Sr>dv*jz^B)eB<4#v8Dy{>9{#M6nL(M{?sQ^7gg z@+ot~udIpc4x3>2zgGG3Q9B2t9b)Dx<(HQEteey@Rf)f3W!uhAziXL!wr)L@pEGUR zlIP5Jr787K);JZXJk7U>BcjWPnYzs~w5jAFGXkN`)qcJ@s=C+NG(b5Yn$39D&9WOOz zb6CGoEidQYa`!6TPlsPE+MOS?GVN?mn3?comzI#2#la#Ceb?7EJ2A-LYBioL$Ms=m zuvE+J8G-9Js%@J2V&ehk$|tVwTn>NhCd{zhI!nQ8m4eTz$iw`(2htCHcF@1+^8UoJ zXaCL~Ug@1Dq%L~h$6{J-`TZr_O^^3g?`ta!lHPs&hy(9z@7nU?Qd$3aT9$u#+4>buc+pzB^=uoIko-k&jr^PTskhk_*Y*_QuC`t zpA06yvEGz#e7mjYi&#pVWb*9L`?Dk%e72P5`0_9qJg(|B4SXqlvHI2O2M7Pk{%6BuRy^wkr@8i4QJz1pvww1bir!dWU$ExC&6;1k zKI+|_{q^AW^V<$AH;-SPlXkhgX>UW;yX9|M1sg8ADB8R)owZNd_sdNyjyi7j`3FBG zMMSHeV=S9{OyO7QEawyJ(^vETw_KDfcQb1Kmcr8Z|0O^CQHk>p#XZ*j+izE)5`6We z#YU$^ipvt!Qf-;a5~?09+4jQcKIfY!a+xPMFP0lIe7ZFI^{pk&^IHC%-qM+{?4IIg zmzS>Ax|-s;U2kIUc6CZ!5Sw{rgJ`hhlswmSeUpNGoTg0_+rVIUf%n!CuA|%Lu2~aO zyYOn8dh&!N&JRur_FnpGt$u#WQ`ZX%=e+!;nIhA?AT;$%ljre}NqnM{8}`{Tn~ScV zu$Sq=b&I)=*3G`j;3E=x;Fuyyv&akQSI(=As<$a`WxC70Q*ri!6<1O$FU|b$bCIy} zO^07ojBhgRU9d5T%X_)Aj^U)#Z!afgXay-&vmSgcay@pz`*uDZ&F%~r_ARcfkEk(U zYVz_@G}l?JxLRcE!jn2%mbp&kJU;VFpqFE^sK?4gc5NY{GxPGaf)uM-n=Wgv8J=l3*6d&P$V7D20X|`}@}~7VF$FDRzEv%;XY}l$nQ4y%ez5 z^J+Kv>T`sf`Ecv8i~H7V=_+Vw6}+uhu$ObXoZ#N+ICH^k=M9R7PSreEovhEj3Eq_VVA?3*^)SK9oh`pxO#QOrx%(5Q zy!<#%scqg1hAX#>tP{MGA3EHAlp?0*w#iCn@*<&z^>54`?BJV!HenYVzq8h<&x!9J zi|9F6YKeZD8p@bv-{>!M;@Pok83*>F?a&ta@k&8hB;IKP3&)g{naj`I z`$lfvhTEf3W$@jbHP0DsE~fE{pqc)8&ZT3Qn7r zsf}J7R>x$+IyP$lICN8ftJCrli5*U=r2(goRP=whv5=c2+puio`8$o`Te-~yqZWuN zrtVcM?e+Y$!vDqY2E`!8>P3y2(mu~$Xz=^VYo0Fga-UzEuQJ&RjNU z{h>8WY`8^1|>oLvCHuk?&?^XLH29e*M zUB7-I^Zcdl6K76hXP?ub`#YC#qC3xDsmz;k ze$tNfrbYHv6CdAwbFBOOgUpQ`Ey6Bm!n1B?9t}zGyz^XYr@Z>a$9F)I6^A$#pB6KoyLyfyi zT|oe|{l>KV7g1*CRD4eU6EbHq6qx#B;qLcB@!!<9Is6w5-eh0i$ZFEk1JcNN{qI<^)&IIcW0>u+KBnN$CSe(QzQxVIK-yer=QM*m{cz1tPj&-{zwOi!twH|@#W zs&5a)C05+$6jBWN)4D!4iM_h5vh6FAkAFAM2Z zU4^HK!Z+9%ET@!YWC~@QFY4UHnz_;T(moB@NiH*AzIw9%wc<%5{(`qFOu81UGp*7* z$XBrP+F#Fhu>^~^n_C*^y(|cdXLP)(vFnC5-|cr92V(f#b|riY>p#J=XTq`5KhE%e zcBnhfz;uCkThl>Kp{a|Mj%lkc`I5NL<7nTF>1S9v=LNXD4_LUkGV{L5t`paHc`W+! zWo}EU$s68^ZILZ%g3QyWKVU6T?w+_Nx$$H8l$}b!izb<0aGcX~{)qwq4Q*GOrxVr& zcojCeJa`x^zonB$L;Q(%ZBNXD#j9V=`6l4LzcMp^!Ru|hR{OMmY}nr6|A|F*Bl92Y zG`{8XNlu%j+&?LFwj6Am9L^N!c2b)0kKc<3L(4PF-@Fz+Zc$$)qVC}$XAml4ejrmg zXkmZc9XX>C6YaN`pGJqK+kRHQyYY&{YrpK{qBAEMB{wdb?Q`;`z{%MXYVDN=PYu`s9SC!*3@i% zBakUqv}FUU^0PB%i!Ls*e6`t!S3Q4ng1FzY^r9K;ZweQmdT`j#bA`gh2*;I+HZabz z%@B`lu|3$#A?xe)d&BJmst&VCO^(O^da*>hp?qe|i4z+PCY6ea#q8Lz=gGe7nLcxv z&Q;AYl}~@UFZ4#B5qo>=@{Nxk>-6t+(`m;$}Y{ek5{&>uzlrW zyzAo3@A;Ak@;rqmEs9E)K4Xw9QEap_Q|*Lo5!1fXzF);pou+IQ)QmrQ==Q4&=_#8u zTX_rIIzCwk?T?v|V$-qPP2sulpV#vxc)oc!NA`KBpPJVp7HIv!w~?)iv3y1I``w2b zrKg@=c>2n#o~zgp0%;Ns@-T3Fy8(}TDL3v6~CoVWBr;e&f3 z87#-|l^>6s`JlCI+P$#$oCD`)_i!)ZdQ?AYuF~Ja>k0+>0Ri*wB>2l*5pX;)l~aB( z*S^L$h3MydVvjjr5x%0gsl(Y?JAbwEB)gjOxwBLr?em->7*yco^v3`H$8wH4+#)jm z3lsbqu3TR-IpBup(*6a_JYSgd<}ME4+p$*9tDRHvZ?WHvms~D0gOt*XR9?Tj?kda~ z)-t!9``q6iw#+~)m-X2>Ga1>6o}_7+IIj|8ufF(yd!FV?yY2}RTa}n(V=^3hR!ry= zm6&S!GR^uA->t3&j~1uO2YLS9R$DY1Q%o;CHISL}`{5C8_Si#(^S(+dd{5i0VOzVL z$OnXqePUy<(R^eCt6e-iq4Tw)44wT_!_ z7t3Rt-6;(kLBeepwkq5>9IC;-ujsI-Sy8tiQLS6pTYwJVYelMPMJ2&Jt|B02yZI&d|E}gu;{8*6m)oF9*ytd_3_ty=} zI^KN#^RfBM)pCNPk1rED$$vJ}A^vyB)a$37eKtFu8&du*HgsF?!7BYji;ZrH^~@}t z{N$w5^xjuH{>O5zEcw8_MJ<$E|k|7=*>l~lL?e%RB%jG#rIE%&eWN}Ofp_UwCd^i|$_EpC=Z{YSU0iZ<+( zR{DIWZEaS!`9jCOGpW4MS9xc&z5H;;ZvNV=)$WOU$r9_t4b@H0EUC#fxpv=vy5#jk z=ChdG{>P|ovpF#BVd3JwV>54y$I2xI=^fv>Q@WOI#%=Ruu6ZV{HF8~5nl|mb$g%Q_sz|VFK#V=JquSrzES}dpS#mRxX@)aMeQP`izYe{_SA1TJGw9?aX4Ss+=7M`}w}z ziRe1sXB_i)hE@Iww+pSS+&J|4H%;r9XB=UA=*70S1$xUC@8RTL?qS->6UIE%JN&%j z-@>aQOYYV`j=y^4#)qW;C(Gun4!ba)=X&Uj)_D`NU9_&+glg z7hjGBGTDCmd%Q}UZ;s4N-h~HOwMXV&ooCB#Jo8MB$E{lPSG5IZOJp2-_E#ZxofSajj8 zyR!qV1=kd1vaLSldaG6^FZ0*qS1~g;uTI;lC4N#8o^t?UstYvvtY)pzzz=+*`6viNtDGH&hiohLA7Y5sN9644(P%alUOtAw+TH-|bH zM-?W>N1HAdUCnUSXIsTok)>(7O5L|UN;;W)e5RJCv6f}pgw2oEtW7N2Y-jq2u{64V zYWUqHuCZrUofda@ezP%Z#@&}YBMkD+F|B%N#c?C(RI|_5Etk_8m!$3D?q9Wh?zWV+ zujeO)H22jX*O}0sZrGKen__f0=-c^E8k=WKJe_K7cTuiPoNY>^&!?8f=NNCZFSXHF z!?0M@;-pDSR-?@u-v|RUo6X@HLu1<`6?o4sNsYcLmVc<&tv&6_2{!LXzZP4TGC#8n zb~e`VT%odx+h@Js`liTKyS7uxpVmw~`10 z({T%{Z|7G!+h5-l?Rn5<`}>)~wdZHO*zViAq+Ivx`jSuco;?5m?fj~0m#Wi+W~<(u b<+|ED_s_Q}y;;AfJ$d^)*ZR-#$AzW<_agOS literal 0 HcmV?d00001 diff --git a/doc/qtcreator/images/qtcreator-environment-settings-hierarchy.webp b/doc/qtcreator/images/qtcreator-environment-settings-hierarchy.webp new file mode 100644 index 0000000000000000000000000000000000000000..574b2a7547009417503ca5eb57719f2810c1b850 GIT binary patch literal 3662 zcmWIYbaQj#V_*n(bqWXzu<)_uV_?v?Zko%m|ImVoOFUTlKD?jWR&68Uaa(PA;eWeu z=FHnET<`9`vHqWR*(~9k$lb=Nd)0*|noRN66LJ2wh(&cvhYRO4CBaU|E(ezYm!Jtw z0**}{Ci=cR&&>a@)nJc;M?uCB22Q1p%FX`@B(~(LXg=ew{%_4BXvo-`_svx!XHWX! zE%k>IHr%e)6n^fTdHKn{-JA$`3vQuZ2stQG0 z87_DHySylOw^xep?uTkpcij8fwfUopUVAUfz3mmvtMHC(P!4zK<5f4fb^ z&W*+A*1CO>7g9NyJ3G=cefA;29ju&jKfhkSxHI;DrL1~H2H!o&6IJpi-Hw+Qt1LUe zo~K~%t12%=>sLn-9=xtwBQ%$P?m`7+|DrxQ387i>L4PVu|KxnaS9ewRedP?7uW+1*i}rYGrM^%%MV4Q^@v8lt zx!-=jw!dBk|a;Ggfy%$tj)GgBTM9}URzc%MFo!!+1Jei}b^K6Q(ht@Q`?kiVkTe_z8T75bYpi(XKT`z@6l;_Vz zjRfBdPtG`oW>g3TRPt{0cQ>$PxA4}Q!u9{5e@}kXg}x`*&WonAF4&#WAj-%$Z-JHP zH}+Qw_Pvb$t6JDpCU`ul-6G*^{PWG0)|mf0lRxj=yzbEXxnE=Irmj=o+Hw9@Y4?&i z^UZy{RRN2(d~j4UU0I!SjdQ-zx38Q%6C>63IK6$n$Y8=wJ+3Tmd-o@$tey9EUAb7X zW0Go<_Wzb6(cGI{iZT~lGOeGRIp6B~?Qb)S=hh!u^>)MOKR?gUR{Q63%th_7y}^yO zX&!g$lEUnz>SSg<$^Xy%T6uHU_2+3{|F8eLF!Ji_8@@xC@ke2lyVlyAyTC&pQpiwd3k6G^uPprDs^CCZ;z4`v{dGYz(E~Sk6 zeWxo5PaHS8)H!ec!+;kP{d7+%zM8sQ;s2H8)0$#eb~^`X&pvT7)oEE*5Kmdc(TPC< zDvb3@d{q1X2xgk76gnTQxN5~3==~`|J#*{!PWu_13ZZPG+)XOQw~pM*g{CJA%i_=mS9xpt$gk@xX=8*hdUN*u1U~tbF%e9Lp^18W3?GW`)-r5)8 zvR2F|H@P@B)Tra+brYk=UAGFlSsc4A^*pdV&CeHmD|YKDj;(UC6BA`*l8BI6nBb)}DXom!32&)bl-e z&h`BM&&7Y|U+I&6w4`j0`T5M_U+ev>?^Qh8@^~NfPpe*cwxa8Wj5S+ND?4kRsJ#9D ze`P=h|169D3v@J=t4h~JtQTfqek0J6L$!~q!Z>&1=F4J5f1m$4|5bj9!t-+qUW?eL zOJ3+ou{mv&6h{yTN-{h z^gGN@xXym-Q^&uPo_7Vry`IM?rk^% zj`w{ZO}DN)^!optvY7wRw>+M&|IgBTy3POC#@GM1q%5h7GFtb4|7R)vbNfF_UH@Ns zvf}Z~={>LQuZNt_-_o|=*xHaQlMA!zi<|fFQN4Jz&iMG`hDiQ1pZe-*qu&Z2czr!+ zUr6y{pMUeKW~H35`FSFI;^$*e)xRtDW*0ta)fBw$yin)SJ|1`@ovA9y_+WE=tm*y4xdVNleJ97K+i<>Xk)q^6%TdwxE z?&O8m`}SR4wT)x;CFdg*oeMwCoUJc1zw5)CiH4^YE>u3OxcI7YUgDBBe`EsWt}*hT z+_;?Ol;jHyHo4_bXKPmNk$U{unDx~1^xrQ(M6Yekc^L6QvvJe0#T*K&K3#V6Q+@dT zdyVRbf%wv6QZ zz9&h&nX|tZFX=M$d$_sM{`k$z{rmrYesw7P(k`y`|36PE{5yX-&-!V*<)T*1Ua|4p z$Hw?+cIHc1zMbwBKel#yRbXkY--8adbGLh(*B-s^v40xJt!v#Aj=AOO_fP+PJ9BDz z?R@Et8*3+aSn8C$3Eo%p+t(~j{M!u)@0cw+zb}`1`nTazz4rbmLEWYMa(7o(NlZ8@ zH9u^R+{b!*Ly**I~&>!%~$yv_O7_wITw{^~}==~eSWePW;7*=uj}_S4%X zcb|o{|2TH++Q-BjckH7%?`%50$-L&<a|@4e-`AV=)&1Cq_o26$rtF_u{515)v2(6Q z&+fE1A6fJ7oQUVOf2z-psMfz;wfR@k#*a%QEjebIPv}k1Ey`ZHOHt$J?H4l)o9)fw z#7$49Z8Ti7(U(tVPFag`z4mj7a;L{Og2w$EdCJ~AcCN!J%-0N85QKZUC?Q62)7lm zoRe*w*4%oP->y~Ibl;bgy|R1E4%?qra0uf+vh_Wi%o>V>hZ;6jDM(B`eD+<-*0T}6behiuXtYaz$USx`UGj-#hm+-< z3z^1T>#wYk^GMq~pXq*@&foZ@nTrDW%u81my(|3S9BXvbRH zv;%eD{AEr(-1cn-qqW79!?|yN%c?dM-+jWkLAKbFA@6t$AHyBP=}ZdcXHpq1$QE-l zlpVkGk9kjW-fzZxhTH!uJe~2{$Y0Daa?w0qhN|mlHD2gNyjEOvEC2l-PKWoqX3khB z{IM{q*3)aIVx05)U6S2q`){62xqd9J^03d9b<2&N_q5$BHP+LKGx=?$SD$o-Nm7Mz z@9VTR?G`cot(#W-Ugl&dyVuS5NcM~BYt8ywnkPKp*C)s_Ig7YtAiZdU5 z{Z~b=KI&N4_1&yDrt7GDnJv<-DX9}zUzfJ0@vUyxjz6-?r+5bH1+o0dcqz5M{rKfC zOK!*nthc(Fo!(xsz+gdyyf9*M-TyijK zLNb5s`d!oiwmmyMoxdq*f7R6|O^>e4__``GZbs{l_&EU+P8io+uP$M+u)IDsVum!E z(DeB+S>+|7%#N#*_hyB0uIVnRo)?_8uJgb4D88ss1^-?-y@duJYE`!76{Y)wgzwm;k*H>kU z-e-t4shrT$Fz2S0Gn`M<=C<3hE& z=9#0r+WI|T$}KSGbH2O#q+ZEfW{r2r-pX|`w-%?bH@U3qxw*G?)j0<%JyRC+ShmXb@{-pLL7_KqCcayy-fR#p?DpEgse)<4VM~z1 zuU0T^x?;k3XNBf-kb@mpG43l?*~Fex<(0Eh^lFZa*O7#?Zd2HswVx%mhq41*I9?Tmi8{JWc);>wbMSh(53BnP{1r>W{xJS#=jHiv)qRHMf%V4{zdFR% zwy5*|`gfFP0oPkW#(lpyJ~RFJ+s!GqgE2>MiMQ;5RZ0!__ea<+2$z4jQla_&{s_B< zaQQ^L%K|Urb>wfXKg{0v@2ES&yU;65_xI0OcKz&yqYmOf{&v5t%6ZH7;Jdz={EOe> zyZPVz?f%RD<=@fe4NrcF9eGrJX5###-)AV>cfU7uuMNAO-1p6o000<5EusJb literal 0 HcmV?d00001 diff --git a/doc/qtcreator/images/qtcreator-projects-environment.webp b/doc/qtcreator/images/qtcreator-projects-environment.webp new file mode 100644 index 0000000000000000000000000000000000000000..36011d22263463bf752ae30442bff0589d7ffe12 GIT binary patch literal 4728 zcmWIYbaN{ZVqge&bqWXzu<%J1Vqnle?HI!FHDdbz`<1s|#C@_7-u8W7+yOS0ck?7} zH~2;t(?1#J3FBB>WA37nTWqm(}}w;+`+!TK^xbVnyU7lkp)c*H zzMF95=2idfSzD@JWnZ#+b);WDMpeOg^OVE(y^}tDTy{-xbBgk$9m{Pm`+u*UR@G!* zdu8)g{m<`X)F;J1ldq9B(G`8HaxwaL#|z!MqGj6;r1g4!{_f^^dHa&b4&DzAZ0POK zSeQQf_Z1Uw%QM+WWcuDWtZOL!_3>Xn+qbrkx!+VJmu%lLlVyX+4)M>AHQy!}h&%jd zN}4S*@xuq^X5SqDKF9Ss%)HZCs%=abWtNFF?wPA1#dAndZ40LdOLk|5zzin#j>Tu3 z9;~=9FTt@-Q078Bb8^Ca4QnQa2eXY5m}ItpXXUxkvTlLkwpgYLDUsWgUtWC_F1>@% z+2KIKglZ&tsPXEFkt@Cp2~fNWy5TtPfodupH1qC5c^pB z#d_sZnFwLMYhO;!atnVazI;~4F_y=xRshj^{K&MO}}nhcC_c|{xcreb?@Ic zIrg^a_X69DRqOB8U-6$9ztZQ*g6G@x9S?999F}FCZgtM7+%8{G&{T1Ecu{C}*NTI| zlN>8!qaw17Z|$8WoatrsXhWAq)NZ3(0oR@K$37f)xq4{6{ZuC1YnM%%*VXqFo}O%G zx?%d(&WmQ34(xAQy>fNG( zxftGpEj?R%H}D>-WhimW|DGKDwk|+(O2?6}ca(OpZVB*B{_vn-PGRyInN8L{CeJJ* zr>|PKvAJVWL!gqcwoCHy;79X66kfahPMxvox~+-?@5JasUHcVN7*DKaoaLgDu_j7B z#XRKf>56k#3#8f1CpuPg1V-=H`S{Vv&Z$3(vnIvx!4yr4HfHU|`!4AEYZdzJuJ0A; zZR!leHUCbZhz9a3d8Y!OxHZ-!d{@wwiX25fXI2BzoR!Bqw)(K_ z&d{sUd$3V8f$P|`No8CYL^dql7IlUtQT(i6xYzrNoWxIwMmK_@b!<;rJ| zYI^f5S+RKO#~%%hwihSwH8?(1=R(d$S;ZTSjp_cHXKGHcTt21p>Dle2Cm25^#vRvH zcQq{!ijm-F7rSmH=H@fdWuLgcFZ|SN zHrbG%!_nc7&u(6-HBH>)ed+eEDdkG$lc#j9+O7J{N;uQ&;%hw|{w*TlLMViJi}{t1WH)$nfih>1v%HW-s116v$WE&Ni@|z_)CwpLh21 z&x=_F&%S5N^S$i6gL#L`v#HG2E?4I(Us+PUxbXcU@rSoQT2waa)=H!#E!a4{x53x; zP9v+t4Mwv+RsC}w%(GPyzkFcJrHrfRyTvv}iBzs`#jLKAJ%MDBW>mOde z^|53vbF(jxkZuqA-aDtK1(wyAbx)MFaN2T*t9lxTURJK|#>Ekym+cdy*G$RuIVD`A zkrTCY%hqijFY2s0_1Cexe2;!r{P<|V--rs=)5}G--e~&&M)ma>SK))xUTv9?k|LhE zFn@7DUo@Y1KH0nF=_X~tpTf^JifmXaw^`!&;oRRE zFE+OBknwGMc_G`GckfNz=QV7#W$u$N>bx|){qp{Dd*!VsEEjU$6_j4JTUF)ujX(Dz zrpxoM`CcddRkD1}j(-RCF&aNew~)K1zk8+8%H6;F?%uZ+PBs7CxALuDta_^X^K(C! z9%u>Nv~K^&I|7f}*6VN5n=-R;yQHU$j@{PpU(5eLe0-qnd6&Pe$aB`rt~d&123W8LtEX`Ri=6WF}NGQD>nD3^q1**kLSd{(~|ur zd(-UC(vnU0k6$Q!^#00E)r}X|JM-G-&DV{o{%d#tLC(Wl{|Df|H2-=IuK^@hh>g_oGpWL^HtW<7a6x5y721J zRQB`-8IyzM^e@ZID=t4Od$V=j-#-iIS|6NlYjuNrZpk~X-xlI}3}4@C2G?spJNanp z-sXnS7ndY9UwvG^`+x4@)ju5{?=_Zd;`Q9;W5f4r_q!XVTJKJ5J1G759YaO-*3I*j z%P#F-9?DSCb1Z&&LBa+r^F0-EvJCI1nC~rTn>+L7f=B8FM{Zu^>;E`s+xh8{`#Tdn z-n?1&{CQfzDY4w9xe~vY?$6%;PA#YB!%^Rv(p=X>=J8B!YX~-zGWE}sdoaJZMfp_l z2FH`rOSz7^bNnf}z4J0Z+sSj6PVQ6Q{a@h*XZm0ZV-5AOL?eb8#{HOsvkU9%#m7+CAwj+mi;d$-QV>7kFG&lhz)tK&7p zHAR}+*ppA|ompw+-2-cn2sSaNt(f%FXVRtv*EWdSi5N6box;rhIaO76{}M6b()DYO zStPV+%{)K-q}9y?yGciqb(Uy)Ml-OU2~hn!QzbOf)3zXdnf%eD%#gd8g)FRR5>%fa z*j010Yg+yOxh*r_<(q|HNfI$|o_gl_=@jYRAmX)=XG=<{n&-BScJa&1ZrH|e+o!bl z=ccbBnP;c3UG9;+FUQt3>~pGU;V0dfvoB3okzVz8w$mlcI^G+`@nu_oh)pWq*ZF3a zzO~BpnxyMBH`OQg`F>8l)EE0XbrYQMI;66Pb!VhP@w+=~4rq#~eNLTO!Chmfd%`O3 z+dZb3v<5@_G?4m}HIZ!Js_o`WrPS<&3HeN7etqh*rrPJTU$!mSQ#j>=ujZQUlo%tu zTp2d@D@82G8ZZ=iqKGT1*X6Bk?qsdd+N}v5ynS6B9p0h@J zW-B+GyQp@SA&18@HEo9JW`@5r&Z?~Bs`*=e?#>>OX8X7#u@JV&KR1P}xtu<^>2N{C zwCz8amS)ZL{BN7yD4bQ)^!3Y`Yga4^SGE~!5IA>o&#YiIkT1bObJ8bhB2P$V%A^$8 z>`$q$T4Fz^PC9p8b@#K=tDels_qgx$?acJ8^~|2X_CKxJ^-5TJ)vL^{f6T9mE>(2? z+>vWBaY^M7vk4xTZIYx9{V$*Gb5?oVJf)SNJJxPL@yaIYwRZoWS?)dti4kXZN6wwW z|18?|&8K}C8#-NomSQ`=Up$j@AS^IgYB_le^FmrCW&%{r^hrpDtOtJGw9#7a+aFN0oDVewzVr?cF3 zdRJM8O1~BfEcU#`l=H~IqB6qs^7SREWk+%j9AmzkEw@p$^Sqj1b(*VgA7{tj$e`IV zS8ho)t+;NJv@+zr!mYVdLTRx|pT1gmn)n8bb389w%(v+5p3Ecdd!Gqz&f(kGHRYM$ z>M!>3VIMR1ow@V0;qMZwx9{Dc$=%+$FO?c;`nYofA_xu9&%d(yqD3+FpgP@YrG@_3?n@nVBmK_xYq6dGZH8Kdtrm zz4*pU|LX)l@0l)cp*^EzyTbY9?2@k(3mZSFe|@9jw!h;t*ZPh%D;UZeGImwFeA%({ zp0?J`GeSz*$Mxz~Nc>eg_p!|H!KY{iT_T$_|#z#|vxuO^J zE@sJAC`hY3ZEB=9GrU0chU%ln+|66BcKMt!OS@fmBUK?{{_N;$bqX&W1#Vq=Z5Z$> zG5ZGB{l>$rPkq0dYqFmk8?`qoR70U|u-MqJJO7gva*GA?Cy|+`&U0E1^ zLc{@ahy#8cjzPsQh+oG8>uits2^qXbp zqiItX#vd_RV{GmxskYp#{^?rgWgDly-<~$Zbd5?D@5J@?Gxev3wUvu$ywabrGwa;< zXC_5U@0TQ)ov<-BnjK%3nVPiVp1s5T{zYDorU`yOzG+XX)^UgR>T?&z^dxwG`|Wz> zDM+AL}l=$C!u+-~0aB7ePU6-3KD z-ba7(7VP}evBLC-xXJV-`VDV#*4Zb0xp!{0_x_Fz(k_YF9gDgdc1PS#d%1V+dA866 zKVO>NkW!KfP~F \uicontrol Nim > \uicontrol Tools, and enter the path to the tool executable in the \uicontrol Path field. - \sa {Document code} - \else - \include qtcreator-variables.qdocinc qtcreator variables + \sa {Document code}, {Use Qt Creator variables} \endif */ diff --git a/doc/qtcreator/src/editors/creator-only/creator-language-server.qdoc b/doc/qtcreator/src/editors/creator-only/creator-language-server.qdoc index 8ebbaa74d4b..0a89789d4a7 100644 --- a/doc/qtcreator/src/editors/creator-only/creator-language-server.qdoc +++ b/doc/qtcreator/src/editors/creator-only/creator-language-server.qdoc @@ -81,7 +81,7 @@ \li In the \uicontrol Name field, enter a name for the language server. Select the \inlineimage icons/replace.png (\uicontrol {Variables}) button to use a variable for the server - name. For more information, see \l{Using Qt Creator Variables}. + name. For more information, see \l{Use Qt Creator variables}. \li In the \uicontrol {Language} field, select \uicontrol {Set MIME Types} to select the MIME types of the files to send to the language server. In the field below, you can enter file @@ -113,7 +113,7 @@ \li In the \uicontrol Name field, enter a name for the language server. Select the \inlineimage icons/replace.png (\uicontrol {Variables}) button to use a variable for the server - name. For more information, see \l{Using Qt Creator Variables}. + name. For more information, see \l{Use Qt Creator variables}. \li In the \uicontrol Java field, enter the path to the Java executable. \li In the \uicontrol {Java Language Server} field, enter the path to the Java language server \c .jar file. You can download the Java diff --git a/doc/qtcreator/src/howto/creator-external-tools.qdoc b/doc/qtcreator/src/howto/creator-external-tools.qdoc index 53ba24a3f4b..3f29dfc57bf 100644 --- a/doc/qtcreator/src/howto/creator-external-tools.qdoc +++ b/doc/qtcreator/src/howto/creator-external-tools.qdoc @@ -35,10 +35,12 @@ \image qtcreator-external-tools.png + \if defined(qtcreator) Select the \inlineimage icons/replace.png (\uicontrol {Variables}) button in a field to select from a list of - \l{Using Qt Creator Variables}{variables} that are available in a + \l{Use Qt Creator variables}{variables} that are available in a particular context. + \endif To configure external tools: @@ -71,8 +73,8 @@ \if defined(qtcreator) \li In the \uicontrol {Base environment} field, select whether to run - the tool in the system environment or the \l{Build Environment} - {build environment} or \l {Selecting the Run Environment} + the tool in the system environment or the \l{Specify the environment for projects} + {build environment} or \l {Specify the run environment} {run environment} of the active project. Select the build or run environment if the system environment does not have the necessary PATH settings to find the tool chain, for example. @@ -82,20 +84,12 @@ \li In the \uicontrol Environment field, select \uicontrol Change to modify environment variable values for build and run environments in - the \uicontrol {Edit Environment Changes} dialog. - \if defined(qtcreator) - For more information about how to add and remove variable values, - see \l{Batch Editing}. - \endif - + the \uicontrol {Edit Environment} dialog. To globally change the system environment from the one in which \QC is started, select \preferences > \uicontrol Environment > \uicontrol System, and then select \uicontrol Change in the \uicontrol Environment field. - \if defined(qtcreator) - For more information, see \l{Specifying Environment Settings}. - \endif \li Select the \uicontrol {Modifies current document} check box to make sure that if the current document is modified by the tool, it is saved @@ -121,6 +115,11 @@ configuration file to the folder. \sa {Run QML files}, {Use external text editors}, {Use Qt Linguist} + + \if defined(qtcreator) + \sa {Batch edit environment settings}, {Specify the environment for projects}, + {Use Qt Creator variables} + \endif */ /*! diff --git a/doc/qtcreator/src/projects/creator-only/creator-build-settings-qmake.qdoc b/doc/qtcreator/src/projects/creator-only/creator-build-settings-qmake.qdoc index 2d427ee15aa..ea95ce05924 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-build-settings-qmake.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-build-settings-qmake.qdoc @@ -21,7 +21,7 @@ checkbox. Select the build directory in the \uicontrol {Build Directory} field. You - can use the \l{Using Qt Creator Variables}{variables} that are listed when + can use the \l{Use Qt Creator variables}{variables} that are listed when you select the \inlineimage icons/replace.png (\uicontrol {Variables}) button. diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-kits.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-kits.qdoc index 3e1f9fcd62e..dc0fe3abc42 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-kits.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-kits.qdoc @@ -151,7 +151,7 @@ \li Select \uicontrol Change to modify environment variable values for build environments in the \uicontrol {Edit Environment Changes} dialog. For more information about how to add and remove variable - values, see \l{Batch Editing}. + values, see \l{Batch edit environment settings}. \row \li \uicontrol {Force UTF-8 MSVC compiler output} \li Either switches the language of MSVC to English or keeps the diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-build.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-build.qdoc index 3a54e8e4e7e..222c7e5d48f 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-build.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-build.qdoc @@ -110,10 +110,8 @@ tested or grouping commands, are not supported because the value of the \uicontrol Executable field is always placed first when constructing the command. - You can use \l {Using Environment Variables}{environment variables} as - values in the fields. In addition, you can \l {Using Qt Creator Variables} - {use \QC variables} in arguments, executable paths, and working - directories. + You can \l {Use Qt Creator variables}{use \QC variables} in arguments, + executable paths, and working directories. \section1 Build Steps diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-environment.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-environment.qdoc index 4459d0b9063..504f9d02732 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-environment.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-environment.qdoc @@ -1,16 +1,17 @@ -// Copyright (C) 2021 The Qt Company Ltd. +// Copyright (C) 2023 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! - \previouspage creator-build-dependencies.html - \page creator-project-settings-environment.html - \nextpage creator-custom-output-parsers.html + \page creator-how-set-project-environment.html + \previouspage creator-how-tos.html - \title Specifying Environment Settings + \ingroup creator-how-to-projects - You can specify the environment you want to use for building - a project in the \uicontrol {Build Environment} section of - the \uicontrol {Build Settings}. + \title Specify the environment for projects + + The environment for a project is determined according to a settings hierarchy: + + \image qtcreator-environment-settings-hierarchy.webp {Environment settings hierarchy} By default, the environment in which \QC was started is used and modified to include the Qt version. Depending on the selected Qt version, \QC @@ -18,36 +19,109 @@ existing environment variables or add, reset and unset new variables based on your project requirements. - To globally change the system environment from the one in which - \QC is started, select \preferences > - \uicontrol Environment > \uicontrol System, and then select - \uicontrol Change in the \uicontrol Environment field. + The final environment is specified separately for each kit. With + project-specific environment settings you can change the environment for + all kits that you use to build, deploy, and run the project simultaneously, + rather than having to change it separately for each kit. + + The changes are stored in the local project-specific \c{CMakeLists.txt.user} + or \c{.pro.user} file, depending on the build system you use, such as CMake + or qmake. Therefore, they are not suitable for sharing between developers or + development PCs. To share settings, incorporate them into the build system. + For example, if you use CMake, make the changes in the \c {CMakeLists.txt} + file, and if you use qmake, make the changes in the \c{.pro} file. + + \section1 Globally change the environment + + To globally change the environment from the one in which \QC is started, + select \preferences > \uicontrol Environment > \uicontrol System, and then + select \uicontrol Change in the \uicontrol Environment field. \image qtcreator-preferences-environment-system.webp "Environment preferences System tab" - In addition, you can specify custom environment variables in the - \uicontrol {Project Settings} > \uicontrol Environment settings. - They are added to all build environments. The final build environment - is specified separately for each kit. The project-specific environment - settings enable you to amend the build environment for all kits that - you use to build the project simultaneously, rather than having to edit - it separately for each kit. + \section1 Change the environment for a project - \image qtcreator-build-environment.png "Build Environment" + To change the system environment for a project from the one in which + \QC is started, select \uicontrol Projects > \uicontrol {Project Settings} + > \uicontrol Environment. - The changes are stored in the local project specific \c{CMakeLists.txt.user} - or \c{.pro.user} file, depending on the build system you use. Therefore, - they are not suitable for sharing between developers or development PCs. To - share settings, incorporate them into the build system. For example, if you - use CMake, make the changes in the \c {CMakeLists.txt} file, and if you use - qmake, make the changes in the \c{.pro} file. + \image qtcreator-projects-environment.webp {Environment tab in Project Settings} - \section1 Batch Editing + \section1 Specify the build environment - To modify environment variable values for build or run environments, - select \uicontrol {Batch Edit} in the \uicontrol {Build Environment} - or \uicontrol {Environment} pane and enter environment variables in - the \uicontrol {Edit Environment} dialog. + Specify the build environment to use for a kit in \uicontrol Projects > + \uicontrol {Build Settings} > \uicontrol {Build Environment}. + + \image qtcreator-build-environment.png {Build Environment section in Build Settings} + + \section2 Clear the build environment + + To build with a clean system environment, select the \uicontrol {Clear + system environment} check box. \QC discards the current environment, and + populates a clean system environment with the environment variables that + the compilers and tools need. Therefore, the environment is never totally + empty, even after you clear it. + + \section1 Specify the run environment + + \QC automatically selects the environment used for running the application + based on the \l{glossary-device}{device} type. You can edit the environment + or select another environment in \uicontrol Projects > + \uicontrol {Run Settings} > \uicontrol {Environment}. + + You can edit existing environment variables or add, reset and unset new + variables. + + \image qtcreator-run-environment.png {Environment section in Run Settings} + + When running on the desktop, the \uicontrol {Build Environment} is used by + default, but you can also use the \uicontrol {System Environment} without the + additions made to the build environment. + + To modify the environment variable values for the run environment, + double-click environment variables or their values and change them inline, + or select \uicontrol {Batch Edit} to change several variable values at a + time. + + \section2 Clean the run environment + + To run in a clean system environment, select \uicontrol {Clean Environment}. + + \section2 Run on devices + + When running on a mobile device connected to the development host, \QC + fetches information about the \uicontrol {Device Environment} from the device. + Usually, it does not make sense to edit the device environment. + + \sa {Batch edit environment settings}, {Specifying Build Settings}, + {Specifying Run Settings}, {Use Qt Creator variables} +*/ + +/*! + \page creator-how-to-batch-edit-environment-settings.html + \previouspage creator-how-tos.html + + \ingroup creator-how-to-projects + + \title Batch edit environment settings + + You can change the environment variable values for build or run environments + either for a particular project or globally for all projects in the + \uicontrol {Edit Environment} dialog: + + \list + \li To change values globally, select \uicontrol Change in the + \l {Globally change the environment}{global environment preferences}. + \li To change values for a project, select \uicontrol {Batch Edit} in the + \l {Change the environment for a project}{project}, + \l {Specify the build environment}{build}, or + \l {Specify the run environment}{run} environment settings. + \endlist + + \image qtcreator-edit-environment.webp {Edit Environment dialog} + + Use the following syntax to enter environment variable names and values: + \c {=}. To remove a variable value from the environment, enter the variable name. For example, \c TEST sets the value of the \c TEST variable empty when @@ -70,21 +144,6 @@ To temporarily disable a variable, add a hash character (#) to the beginning of the line. - \section1 Clearing the System Environment - - To build with a clean system environment, select the \uicontrol {Clear - system environment} check box. \QC discards the current environment, and - populates a clean system environment with the environment variables that - the compilers and tools need. Therefore, the environment is never totally - empty, even after you clear it. - - \section1 Using Environment Variables - - You can use any environment variables in build, deploy, and run - configurations. For a list of variable names, select \uicontrol {Build - Settings} > \uicontrol {Build Environment} > \uicontrol Details. - Environment variables are referenced using the native syntax: $VARNAME - or ${VARNAME} on Unix and %VARNAME% on Windows. - - \include qtcreator-variables.qdocinc qtcreator variables + \sa {Specify the environment for projects}, {Specifying Build Settings}, + {Use Qt Creator variables} */ diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-overview.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-overview.qdoc index 6a15f763200..ab8a2f164ba 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-overview.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-overview.qdoc @@ -14,13 +14,12 @@ \title Configuring Projects - When you install Qt for a target platform, such as Android or QNX, - \l{https://www.qt.io/download-qt-installer}{\QOI} - creates \l{glossary-buildandrun-kit}{kits} for the development - targets. + When you install Qt for a development or target platform, such as Linux, + \macos, Windows, Android or QNX, \l{https://www.qt.io/download-qt-installer} + {\QOI} creates \l{glossary-buildandrun-kit}{kits} for the development targets. - Select the kits to use in the \uicontrol {Configure Projects} - view when you open a project for the first time. At least one kit must be + Select the kits to use for a project in the \uicontrol {Configure Projects} + view when you open the project for the first time. At least one kit must be active. To maintain the list of active kits for a currently open project, switch to @@ -29,7 +28,7 @@ \image qtcreator-projects-kits.webp {Sidebar in the Projects mode} To specify build or run settings for a kit, select \uicontrol Build or - \uicontrol Run below the kit. + \uicontrol Run below the kit name. \section1 Overriding Global Preferences @@ -45,7 +44,7 @@ \li \l{Specify dependencies}{Dependencies} \li \l{Document code}{Documentation Comments} \li \l{Specify editor settings}{Editor} - \li \l{Specifying Environment Settings}{Environment} + \li \l{Specify the environment for projects}{Environment} \li \l{Applying Refactoring Actions}{Quick Fixes} \li \l{To-Do Entries}{To-Do} (experimental) \endlist @@ -69,7 +68,7 @@ lists the kits that are compatible with your project. To activate one or more kits, click them. - \image qtcreator-project-kits.png + \image qtcreator-project-kits.png {List of kits in Projects mode sidebar} The list displays kits from \preferences > \uicontrol Kits. Warning and error icons indicate that the kit configuration diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run-desktop.qdocinc b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run-desktop.qdocinc index caadbe3b463..74e6357ee7b 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run-desktop.qdocinc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run-desktop.qdocinc @@ -27,7 +27,7 @@ To run with special environment variables set up, select them in the \uicontrol {Run Environment} section. For more information, see - \l {Selecting the Run Environment}. + \l {Specify the run environment}. When building an application, \QC creates a list of directories where the linker will look for libraries that the application links to. By diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run.qdoc index e574c00a4c3..14205f59db2 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-run.qdoc @@ -95,31 +95,6 @@ \include creator-projects-settings-run-qnx.qdocinc run settings qnx \include linux-mobile/creator-projects-settings-run-b2qt.qdocinc run settings boot2qt - \section1 Selecting the Run Environment - - \QC automatically selects the environment used for running the application - based on the \l{glossary-device}{device} type. You can edit the environment - or select another environment in the \uicontrol {Run Environment} section. - - You can edit existing environment variables or add, reset and unset new - variables. - - \image qtcreator-run-environment.png {Run Environment section} - - When running on the desktop, the \uicontrol {Build Environment} is used by - default, but you can also use the \uicontrol {System Environment} without the - additions made to the build environment. For more information, see - \l {Build Environment} and \l{Specifying Environment Settings}. - - To run in a clean system environment, select \uicontrol {Clean Environment}. - - When running on a mobile device connected to the development host, \QC - fetches information about the \uicontrol {Device Environment} from the device. - Usually, it does not make sense to edit the device environment. - - To modify the environment variable values for the run environment, select - \uicontrol {Batch Edit}. For more information, see \l{Batch Editing}. - \section1 Specifying a Custom Executable to Run If you use CMake, Meson or the generic project type in \QC, or want diff --git a/doc/qtcreator/src/projects/qtcreator-variables.qdocinc b/doc/qtcreator/src/projects/creator-only/qtcreator-how-to-use-qtc-variables.qdoc similarity index 64% rename from doc/qtcreator/src/projects/qtcreator-variables.qdocinc rename to doc/qtcreator/src/projects/creator-only/qtcreator-how-to-use-qtc-variables.qdoc index eef38706981..cf8100a68ae 100644 --- a/doc/qtcreator/src/projects/qtcreator-variables.qdocinc +++ b/doc/qtcreator/src/projects/creator-only/qtcreator-how-to-use-qtc-variables.qdoc @@ -1,13 +1,19 @@ -// Copyright (C) 2021 The Qt Company Ltd. +// Copyright (C) 2023 The Qt Company Ltd. // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! -//! [qtcreator variables] - \section1 Using Qt Creator Variables + \page creator-how-to-use-qtc-variables.html + \previouspage creator-how-tos.html - You can use \QC variables in arguments, executable paths, and working - directories. The variables take care of quoting their expansions, so you do - not need to put them in quotes. + \ingroup creator-how-to-projects + + \title Use Qt Creator variables + + You can use \QC variables in \uicontrol Preferences, + \uicontrol {Build Settings}, and \uicontrol {Run Settings}, in fields that + set arguments, executable paths, and working directories, for example. The + variables take care of quoting their expansions, so you do not need to put + them in quotes. Select the \inlineimage icons/replace.png (\uicontrol {Variables}) button in a field to select from a list of @@ -15,7 +21,7 @@ For more information about each variable, move the cursor over it in the list. - \image qtcreator-variables.png "Qt Creator Variables dialog displaying a tooltip" + \image qtcreator-variables.png {Qt Creator Variables dialog showing a tooltip} The following syntax enables you to use environment variables as \QC variables: %{Env:VARNAME}. @@ -38,7 +44,7 @@ backreferences. For example, if \c %{variable} is \c my123var, then \c %{variable/(..)(\d+)/\2\1} is expanded to \c {123myvar}. - Instead of the forward slash, you can also use the pound sign (\c #) as + Instead of the forward slash, you can also use the number sign (\c #) as the substitution character. This can be helpful if the value is supposed to be a file path, in which case forward slashes might get translated to backslashes on Windows hosts. @@ -48,5 +54,6 @@ \badcode %{variable:-default} \endcode -//! [qtcreator variables] + + \sa {Specify the environment for projects}, {Specifying Build Settings}, */ diff --git a/doc/qtcreator/src/qtcreator-toc.qdoc b/doc/qtcreator/src/qtcreator-toc.qdoc index 0e3f3883d51..ad60462b0f4 100644 --- a/doc/qtcreator/src/qtcreator-toc.qdoc +++ b/doc/qtcreator/src/qtcreator-toc.qdoc @@ -39,7 +39,6 @@ \li \l{Conan Build Configuration} \endlist \li \l{Specifying Run Settings} - \li \l{Specifying Environment Settings} \li \l{Using Custom Output Parsers} \li \l{Sharing Project Settings} \endlist