Doc: update description of qmake SUBDIRS variable

You can specify a relative path to a .pro file in any directory.

Fixed a capitalization issue and a grammar issue and changed the
visible text in a link target.

Task-number: QTBUG-14139
Change-Id: Ib476bd400c46645709950c582492edcaaba9d7ed
Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com>
This commit is contained in:
Leena Miettinen 2013-08-26 10:13:13 +02:00 committed by The Qt Project
parent 64a1448d87
commit 31e665c7cd
2 changed files with 14 additions and 9 deletions

View File

@ -2226,20 +2226,24 @@
\target SUBDIRS
\section1 SUBDIRS
This variable, when used with the \l{#TEMPLATE}{\c subdirs template}
Specifies the names of all subdirectories or project files that contain
parts of the project that need be built. Each subdirectory specified
This variable, when used with the \c subdirs \l{#TEMPLATE}{template}
specifies the names of all subdirectories or project files that contain
parts of the project that need to be built. Each subdirectory specified
using this variable must contain its own project file.
It is recommended that the project file in each subdirectory has the same
base name as the subdirectory itself, because that makes it possible to omit
the file name. For example, if the subdirectory is called \c myapp, the
project file in that directory should be called \c myapp.pro.
Alternatively, you can specify a relative path to a .pro file in any
directory. It is strongly recommended that you specify only paths in the
current project's parent directory or its subdirectories.
For example:
\snippet snippets/code/doc_src_qmake-manual.pro 50
It is essential that the project file in each subdirectory has the same
name as the subdirectory itself, so that qmake
can find it. For example, if the subdirectory is called \c myapp then the
project file in that directory should be called \c myapp.pro.
If you need to ensure that the subdirectories are built in the order in
which they are specified, update the \l{#CONFIG}{CONFIG} variable to
include the \c ordered option:

View File

@ -309,7 +309,8 @@ SOURCES = myclass.cpp \
#! [50]
SUBDIRS = kernel \
tools
tools \
myapp
#! [50]