aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDenis Shienkov <denis.shienkov@gmail.com>2020-12-04 17:02:37 +0300
committerDenis Shienkov <denis.shienkov@gmail.com>2020-12-08 10:21:47 +0000
commit8095f33419c13192df9e5acd06cc73b2cde8ca2b (patch)
tree96053321b79e7d3f83c0fd982fe6dd7bd57db8d9
parent1224e3ce400691c58ea21758a186451841a12b57 (diff)
doc: Cleanup and update information about QBS and IDEs integration
Change-Id: Ieb36a6ba96666f07cd1c22383964f8ecd5acdd33 Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
-rw-r--r--doc/qbs.qdoc38
1 files changed, 26 insertions, 12 deletions
diff --git a/doc/qbs.qdoc b/doc/qbs.qdoc
index 217e41e7c..656a1245d 100644
--- a/doc/qbs.qdoc
+++ b/doc/qbs.qdoc
@@ -299,25 +299,39 @@
\section2 IDE Integration
\QBS can be used not only from the command line, but also in combination
- with an IDE, such as Qt Creator, Microsoft Visual Studio, or Xcode.
- Qt Creator directly supports \QBS projects. Visual Studio and Xcode users
- can use \QBS to generate Microsoft Visual Studio and Xcode projects.
- For more information, see \l {Generators}.
+ with an IDE, such as Qt Creator or Visual Studio Code. These IDEs directly
+ support \QBS projects using the new \QBS
+ {https://doc.qt.io/qbs/cli-session.html}{session} feature. Thus, these IDEs
+ can retrieve all the information required to build a single file or project
+ through a session's JSON protocol {https://doc.qt.io/qbs/json-api.html}{API}.
+
+ In addition, \QBS can generate projects for Visual Studio, IAR EW, and
+ Keil uVision, but it still is an experimental option. For more information,
+ see \l {Generators}.
\section3 Qt Creator
- \l{http://doc.qt.io/qtcreator/index.html}{Qt Creator} uses the same \QBS
- library as the \QBS command line tools. Therefore, it can retrieve all the
- information required to build a single file or project through a defined
- public API. Qt Creator provides accurate information about the build
- progress and displays a project tree that reflects the logical structure of
- the project, instead of presenting low-level information, such as the file
- system structure. Adding or removing source files keeps the existing project
- file structure intact.
+ \l{http://doc.qt.io/qtcreator/index.html}{Qt Creator} provides accurate
+ information about the build progress and displays a project tree that
+ reflects the logical structure of the project, instead of presenting low-level
+ information, such as the file system structure. Adding or removing source
+ files keeps the existing project file structure intact.
For more information about using \QBS to build projects from Qt Creator, see
\l{http://doc.qt.io/qtcreator/creator-project-qbs.html}{Setting Up Qbs}.
+ \section3 Visual Studio Code
+
+ \l{https://code.visualstudio.com/}{Visual Studio Code} provides the
+ {https://marketplace.visualstudio.com/items?itemName=qbs-community.qbs-tools}
+ {qbs-community} plugin that provides accurate information about the build progress
+ and displays a project tree that reflects the logical structure of the project.
+ Also, it can provide low-level information, such as the file system structure.
+
+ For more information about using \QBS to build projects from Visual Studio Code,
+ see \l{https://github.com/denis-shienkov/vscode-qbs/blob/master/docs/how-to.md}
+ {How To}.
+
\section1 Build Process
\image qbs-build-process.png