From 113275118eecd0be474ddfd95ccacb1a81cd4a77 Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Wed, 19 Jun 2024 17:04:16 +0200 Subject: [PATCH] Doc: Describe overriding values from Preferences > CMake > General Collect the settings to a table with links to where each setting is documented. Task-number: QTCREATORBUG-30604 Change-Id: Ia06076cdd7f51851f58307119716b4ed3cef630e Reviewed-by: Cristian Adam --- dist/changelog/changes-14.0.0.md | 2 +- .../qtcreator-project-settings-cmake.webp | Bin 0 -> 3508 bytes .../src/cmake/creator-projects-cmake.qdoc | 3 +- .../creator-projects-settings-cmake.qdoc | 72 ++++++++++++++++++ .../creator-projects-settings-overview.qdoc | 1 + 5 files changed, 75 insertions(+), 3 deletions(-) create mode 100644 doc/qtcreator/images/qtcreator-project-settings-cmake.webp create mode 100644 doc/qtcreator/src/cmake/creator-projects-settings-cmake.qdoc diff --git a/dist/changelog/changes-14.0.0.md b/dist/changelog/changes-14.0.0.md index c3d72f61d35..14040fa3ffc 100644 --- a/dist/changelog/changes-14.0.0.md +++ b/dist/changelog/changes-14.0.0.md @@ -148,7 +148,7 @@ Projects * Made CMake settings configurable per project * Implemented `Open Online Documentation` for CMake documentation -* Added `Clear CMake Configuration` to the context menu in the Projects view +* Added `Clear CMake Configuration` to the context menu in the `Projects` view ([QTCREATORBUG-24658](https://bugreports.qt.io/browse/QTCREATORBUG-24658)) * Fixed that the package manager auto-setup files were not removed with `Clear CMake Configuration` diff --git a/doc/qtcreator/images/qtcreator-project-settings-cmake.webp b/doc/qtcreator/images/qtcreator-project-settings-cmake.webp new file mode 100644 index 0000000000000000000000000000000000000000..f37c521a866470b734b8e2b88272408a2c59a115 GIT binary patch literal 3508 zcmWIYbaPw7%fJxs>J$(bVBxcXmw`e5praE5`;#5pa!oD$|M@q(@aawnlYR_=eEqVUu*AgbN=zOJ?Zwg$G5g!ePYvT{($oW<7W|X;VB1ZNX4|jJ5!(Y|9^5e z54Vg9hv1Drwf8gm(n9bWR9{fn`ldTOh2>Lkt%0VNkB#S^^@-)1lunKM)~C$OD3ct`Zh zO6zdFt4z!ijKvp@aql_kkjOHj+VE>yx8=Mww$HfF6tG`tl)5Y=Y;c5W!IQb-c^pB4 zyE<8}@nl(DWpjzXDkXYgaa9BR4#sI5ig_zu2r|h%6y$rKoc}fB&V_fAFTV9ImELLM zC{nh z{7_Gx+g4*^UElv@SO4DeU%BSS(h17H^tmU!*^%3}QzM?6BS}YcG5f2_HTJK=mYPZ1 z_#EGMx9D=j?(hcz8-I5@x+d!~9`nd-7xR`;Tbj(SWa8YdHFfclr)PHDU3=+syKHak z`lcy*O%_@_d|uxxRnE(_I~rwjlrcT{5fx?aQKxHpbCaxi?^)TTn7Qj^du`))zu!`1 z-uKDzv%8t>`@M7Kt#7=vD|day&Bpvb@9t&-Pw$T-gR zC+ZoWgskO;7Jdh#@}Bm&3qLi!smpj4G-v%&`D^buo*h@@tDb)FqhjA@(*&t&dfH~|rr+VW9rUg( zFJFHqEk7nx_-=9F{kdoJPCuBSJ4;ht$z|qF>CaPNKilgsqj&JO{Py`Tzp_854=?BZ zbWZl;$M<)p)jOQCem2*izXPOUW}mU5so$OZ>unXoy|nIxXUC(K?cQqWJ^Qe@!M{8EtM>X9{&#LPe1CSGv(Dv4vuKw0 zGmf1NVr5U58M<=zo%fqRM^>Bcduw;u`rT!LGu7K~+sp%5S~pW(e45g%pdHEgW?n4+ zd4#v^d-~?r?{+UcZ$Cl&eA;}uhP&3!q~gvA98`=xV!!Ae-o=O^sj*{I)KZDEo#6_h zK}Ssa|2>_*U%}_RoNiPTZ^KIq^R!<{Q{N;gzQ}m~@Z#jQ4QHlBIy^gGJn=n;NYlO< zE*AUiFU*kt|5x5#@l3zy<>z7rXTwjPUb$8H!p~xJi*xmynO$0znqG>2<=F>MKYwNR z`Lu5DR$-6nPES6UKKXR~qA>f}DFr9|4QdGMRr@;|Gk}I@~c@fL^I5Vr@5%m(Ei(%V(#yuWv{S&M{mDO zub*tnl;7ME{COTzs&mq}mnBGbY3kNU+$Krj=6%C=*%J~s-HHDqwbfIW>FDhBip%z|Wqow|dVs(sR;^r1zxU#v z%aVWR1PSmj_L?VkyXNH^-Y+ICryfqd^iyu@!3sO8j^?TT|1Pl#U7octGg9QIl$^D} zvy!dEp!|>ASO+!_q=ZTLNXGJ=eD_#tKrTgik zolfOsK07lPq{!hVQ{Pj|RpRjplP-0=@0=q0Ec1kbo#s@rpDz@SefV@yPhg^RU&QR= zOV=yrb?o)I`H;`I#%|HQH~LXc%ib_w+;MVu*Ynp8G^-C>`)?&4z4ld1i08xam+u<= z*x8pcG5+i9VlVYYRc%7O>YABMJcq0_#9qaeEb(eSUmjJPVm5j8JdE0BCMbBmiuMi z2Z1LBle!zYEu>x6wSu_~)x#rTxJ z-e)CO;obMh{mSgWuI9%VPd~Ea>&1&7BW$Dp*Y>^*-{&?}q%JZ_Guf28XVF*lLsxco zsK+OpuE}W(-1Eqc5UVL)snzF{gq^21DPO*4rKjkx9tHh`3rM5&Th%|5Y)$KBT z-m)rFe$L<3fLG{js zPDYoVZz?I(@G@x$&tr*7m~u(umRY38;{HvpCO@QhI8Wi+x!7BBp_s(d!<%$A+no}d zegAsGNf(2q_gb}5TVfKXIAqQa5^+A#@#d@J!N$rDwu|oZ>=FN;RJZ3l`|Y*=XWz_w zl6|7na^bumeLtj6*=U@sX?$6n+38R3)fj)VFiaIzE~W|3HAxs{O6{4jpb>uUDFMz8L|B35ytN&RENM z^J>Q?-z}^Xx`&rnrAKi@>-Eo?7`mO~g0S@I>j`QLcNbpP{JrD>OUo$tekefceI=f}6wdTLJ!CUrjCuC3mM8w zzjkc$U9@%$TbsrVN39HwpUvCC;ypqZ%P zo>*W(p+o#(iNk8|tv)V1DJtH4TJ%ljjg5?54$|8Agt{UUqPaM@QwR08z-|tjgG(f`ditDd~RViHpw)18-F z)UDitrVEOGaIKHJC>dE%;Oj5s{a@S${eU}dxjI6rEUl}brw3b!tk7T6A-bJZLzx`h8 z<<+6gb@$CAqt|zi6m63G_o2RXzv-kV-+k}(;tKqg?|_Uy&wNYi9#iAAt{dz>3Vqi- z$e;dVSx0^Pde%SjkKXH*2-HF*TC{@6q;RKLnN9qo{LU&N zksX&E_e@xrvB)92G3uyfBuDg--RuTarDl05c71sWGR|ZAxj5!~Nz14IkY1l%ZFq4@ zkKUu!1~snli|ku%mARMYSA1&_)awN4kcbC60Hh \uicontrol {Project Settings} > + \uicontrol CMake. + \image qtcreator-project-settings-cmake.webp {CMake settings for a project} + \li Clear \uicontrol {Use global settings}. + \li Configure CMake for the project. + \endlist + + Your choices override the values you set in \preferences > \uicontrol CMake > + \uicontrol General. + + \table + \header + \li Setting + \li Value + \li Read More + \row + \li Autorun CMake + \li Runs CMake to refresh project information when you edit + a \c CMakeLists.txt configuration file in a project. Also, + refreshes project information when you build the project. + \li \l{View CMake project contents} + \row + \li Package manager auto setup + \li Sets up the \l {Conan Package Manager}{Conan} or + \l {vcpkg Package Manager}{vcpkg} package manager for use with CMake. + \li \l{Using CMake with Package Managers} + \row + \li Ask before re-configuring with initial parameters + \li Asks before acting when you select + \uicontrol {Re-configure with Initial Variables}. + \li \l{Re-configuring with Initial Variables} + \row + \li Ask before reloading CMake presets + \li Asks before acting when you select \uicontrol Build > + \uicontrol {Reload CMake Presets}. + \li \l{CMake Presets} + \row + \li Show subfolders inside source group folders + \li Hides subfolder names and arranges the files according to their + source group in the \uicontrol Projects view. + \li \l{Hide subfolder names in Projects view} + \row + \li Show advanced options by default + \li Shows all CMake variables by default in + \uicontrol {Initial Configuration} and + \uicontrol {Current Configuration}. + \li \l{Viewing Advanced Variables} + \row + \li Use junctions for CMake configuration and build operations + \li On Windows, uses junction points for CMake configure, build, and + install operations. + \li \l{Using Junction Points on Windows} + \endtable + + \sa {Build with CMake}{How To: Build with CMake}, {CMake}, + {Configuring Projects} +*/ 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 0a7b13eb393..73723857773 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 @@ -84,6 +84,7 @@ \li \l{Link projects to Axivion dashboards}{Axivion} \li \l{Specify clangd settings}{Clangd} \li \l{Specify Clang tools settings}{Clang Tools} + \li \l{Override CMake settings for a project}{CMake} \li \l{Set Copilot preferences}{Copilot} \li \l{Configure C++ code model}{C++ Code Model} \li \l{Specify code style}{C++ Code Style}