feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: Mark "Integrating Wizards into Builds" as developer info

Browse Source 
- 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 <eike.ziller@qt.io>
This commit is contained in:
Leena Miettinen
2023-09-01 13:40:11 +02:00
parent 0a058bb657
commit 3beaa29e29
2 changed files with 15 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
doc/qtcreator/src/projects/creator-only/creator-projects-custom-wizards-json.qdocinc
View File

@@ -5,21 +5,22 @@
//! [json wizards] //! [json wizards]
\section1 Integrating Wizards into Builds \section1 Integrating Wizards into Builds
To integrate the wizard into \QC and to deliver it as part of the \QC build, If you are a \QC developer or build your own \QC version for delivery to
place the wizard files in the \QC sources. Then select \uicontrol Build > others, you can integrate the wizard into \QC. To deliver the wizard as
\uicontrol {Run CMake} or \uicontrol {Run qmake}, depending on the build part of the \QC build, place the wizard files in the shared directory in
system you use. This ensures that the new files you added for your wizard are the \QC sources. Then select \uicontrol Build > \uicontrol {Run CMake}.
actually copied from the \QC source directory into the \QC build directory 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. 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 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 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. 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 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 \uicontrol {Factory.Reset} function each time the names or locations of
the files change. the files change.

7
doc/qtcreator/src/projects/creator-only/creator-projects-custom-wizards.qdoc
View File

@@ -27,9 +27,10 @@
has sections that specify information about the wizard, variables has sections that specify information about the wizard, variables
that you can use, wizard pages, and generators for creating files. that you can use, wizard pages, and generators for creating files.
To create a customized wizard, copy a template directory to the shared To create a customized wizard, copy a template directory to the
directory or the local user's settings directory under a new name. Then \c {templates/wizards/} directory in the local user's settings
change the wizard id in the \c {wizard.json} file. 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. You can create a subdirectory for the templates in the settings directory.
\QC organizes the standard wizards into subdirectories by type, but you can \QC organizes the standard wizards into subdirectories by type, but you can