From 3beaa29e29219ecf4e3a76c3ccc50bd56d66c0e0 Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Fri, 1 Sep 2023 13:40:11 +0200 Subject: [PATCH] Doc: Mark "Integrating Wizards into Builds" as developer info - Users should place their custom wizards in the local user's settings directory, whereas developers should add them to the sources to include them in builds. - Remove information about qmake because building Qt Creator with qmake is no longer supported. Change-Id: I5e65ce8128dea0d35a21eee08a1548a3060c5e9c Reviewed-by: Eike Ziller --- ...eator-projects-custom-wizards-json.qdocinc | 21 ++++++++++--------- .../creator-projects-custom-wizards.qdoc | 7 ++++--- 2 files changed, 15 insertions(+), 13 deletions(-) diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-custom-wizards-json.qdocinc b/doc/qtcreator/src/projects/creator-only/creator-projects-custom-wizards-json.qdocinc index 8ffcff60f28..852bfeb2461 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-custom-wizards-json.qdocinc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-custom-wizards-json.qdocinc @@ -5,21 +5,22 @@ //! [json wizards] \section1 Integrating Wizards into Builds - To integrate the wizard into \QC and to deliver it as part of the \QC build, - place the wizard files in the \QC sources. Then select \uicontrol Build > - \uicontrol {Run CMake} or \uicontrol {Run qmake}, depending on the build - system you use. This ensures that the new files you added for your wizard are - actually copied from the \QC source directory into the \QC build directory + If you are a \QC developer or build your own \QC version for delivery to + others, you can integrate the wizard into \QC. To deliver the wizard as + part of the \QC build, place the wizard files in the shared directory in + the \QC sources. Then select \uicontrol Build > \uicontrol {Run CMake}. + This ensures that the new files you added for your wizard are actually + copied from the \QC source directory into the \QC build directory as part of the next \QC build. - If you do not run CMake or qmake, your new wizard will not show up because + If you do not run CMake, your new wizard will not show up because it does not exist in the build directory you run your newly built \QC from. - It never got copied there because CMake or qmake did not inform the - build tool, such as make or ninja, about the new files in the source tree. + It never got copied there because CMake did not inform the + build tool, such as make or Ninja, about the new files in the source tree. - Basically, CMake and qmake generate a fixed list of files to copy from the + Basically, CMake generates a fixed list of files to copy from the source directory to the subdirectory of the build directory that is checked - for wizards at runtime. Therefore, you need to run CMake or qmake or execute + for wizards at runtime. Therefore, you need to run CMake or execute the \uicontrol {Factory.Reset} function each time the names or locations of the files change. diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-custom-wizards.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-custom-wizards.qdoc index 67c0c3d91a1..6e1b2c6861d 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-custom-wizards.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-custom-wizards.qdoc @@ -27,9 +27,10 @@ has sections that specify information about the wizard, variables that you can use, wizard pages, and generators for creating files. - To create a customized wizard, copy a template directory to the shared - directory or the local user's settings directory under a new name. Then - change the wizard id in the \c {wizard.json} file. + To create a customized wizard, copy a template directory to the + \c {templates/wizards/} directory in the local user's settings + directory under a new name. Then change the wizard id in the + \c {wizard.json} file. You can create a subdirectory for the templates in the settings directory. \QC organizes the standard wizards into subdirectories by type, but you can