diff options
Diffstat (limited to 'doc/qbs.qdoc')
| -rw-r--r-- | doc/qbs.qdoc | 60 |
1 files changed, 56 insertions, 4 deletions
diff --git a/doc/qbs.qdoc b/doc/qbs.qdoc index d2c703491..08a901365 100644 --- a/doc/qbs.qdoc +++ b/doc/qbs.qdoc @@ -87,7 +87,8 @@ \li \l{Appendix A: Building Qbs} \li \l{Appendix B: Migrating from Other Build Systems} - \li \l{Appendix C: Licenses and Code Attributions} + \li \l{Appendix C: The JSON API} + \li \l{Appendix D: Licenses and Code Attributions} \endlist */ @@ -1721,7 +1722,7 @@ integrate \QBS with popular IDEs, such as Microsoft Visual Studio, and to generate Clang compilation databases. - \section1 Generating Projects + \section1 Generating Microsoft Visual Studio Projects To generate a project for another build system, such as Microsoft Visual Studio, use the \l{generate}{qbs generate} command and specify a generator @@ -1744,6 +1745,57 @@ \l{generate}{qbs generate} in order for the changes to be reflected in your IDE. + \section1 Generating IAR Embedded Workbench Projects + + To generate a project for \l{https://www.iar.com/iar-embedded-workbench/} + {IAR Embedded Workbench}, use the \l{generate}{qbs generate} command and specify + a generator using the \l{generate-generator}{-g} option. For example: + + \code + # For IAREW v8xxxx + qbs generate -g iarew8 profile:<your/qbs/profile> + qbs generate -g iarew8 -d <path/to/build/directory> -f <path/to/qbs/project> profile:<your/qbs/profile> + \endcode + + \note You need to specify a specific QBS profile, which is required for a generator + to fetch a target architecture to generate the project. + + \note IAR EW generator creates a native target project. + + Supported IAR EW generators are listed in a table below: + + \table + \header \li Generator \li IAR EW Version \li Target Architecture + \row \li iarew8 \li All 8.x.y versions \li ARM + \row \li iarew7 \li All 7.x.y versions \li AVR, MSP430 + \row \li iarew10 \li All 10.x.y versions \li 8051 (aka MCS51) + \row \li iarew3 \li All 3.x.y versions \li STM8 + \endtable + + \section1 KEIL uVision Projects + + To generate a project for \l{https://www2.keil.com/mdk5/uvision/} + {KEIL uVision}, use the \l{generate}{qbs generate} command and specify + a generator using the \l{generate-generator}{-g} option. For example: + + \code + # For KEIL UV5 + qbs generate -g keiluv5 profile:<your/qbs/profile> + qbs generate -g keiluv5 -d <path/to/build/directory> -f <path/to/qbs/project> profile:<your/qbs/profile> + \endcode + + \note You need to specify a specific QBS profile, which is required for a generator + to fetch a target architecture to generate the project. + + \note KEIL UV generator creates a native target project. + + Supported KEIL UV generators are listed in a table below: + + \table + \header \li Generator \li KEIL UV Version \li Target Architecture + \row \li keiluv5 \li All 5.x.y versions \li 8051 (aka MCS51), ARM + \endtable + \section1 Generating Clang Compilation Databases To generate a \l{JSON Compilation Database Format Specification} @@ -1915,10 +1967,10 @@ /*! \contentspage index.html - \previouspage porting-to-qbs.html + \previouspage json-api.html \page attributions.html - \title Appendix C: Licenses and Code Attributions + \title Appendix D: Licenses and Code Attributions \section1 Licenses |