aboutsummaryrefslogtreecommitdiff
path: root/docs/markdown/IDE-integration.md
diff options
context:
space:
mode:
authorJussi Pakkanen <jpakkane@gmail.com>2017-05-03 18:27:29 +0300
committerGitHub <noreply@github.com>2017-05-03 18:27:29 +0300
commit2bb03f19fd9842d8c7966336ee967786f8edfbda (patch)
tree707f00e4b355d30c6d4d0de23e3364bf82b6c35d /docs/markdown/IDE-integration.md
parent33b79dcf2502420c0db806fece1b35c724366f40 (diff)
parent276d342ebaf859dd53e145ead3e98e2cebb360ab (diff)
downloadmeson-2bb03f19fd9842d8c7966336ee967786f8edfbda.zip
meson-2bb03f19fd9842d8c7966336ee967786f8edfbda.tar.gz
meson-2bb03f19fd9842d8c7966336ee967786f8edfbda.tar.bz2
Merge pull request #1725 from whot/master
documentation fixes
Diffstat (limited to 'docs/markdown/IDE-integration.md')
-rw-r--r--docs/markdown/IDE-integration.md8
1 files changed, 6 insertions, 2 deletions
diff --git a/docs/markdown/IDE-integration.md b/docs/markdown/IDE-integration.md
index 7e046c6..7258f56 100644
--- a/docs/markdown/IDE-integration.md
+++ b/docs/markdown/IDE-integration.md
@@ -1,3 +1,7 @@
+---
+short-description: Meson's API to integrate Meson support into an IDE
+...
+
# IDE integration
Meson has exporters for Visual Studio and XCode, but writing a custom backend for every IDE out there is not a scalable approach. To solve this problem, Meson provides an API that makes it easy for any IDE or build tool to integrate Meson builds and provide an experience comparable to a solution native to the IDE.
@@ -6,7 +10,7 @@ The basic tool for this is a script called `mesonintrospect.py`. Some distro pac
The first thing to do when setting up a Meson project in an IDE is to select the source and build directories. For this example we assume that the source resides in an Eclipse-like directory called `workspace/project` and the build tree is nested inside it as `workspace/project/build`. First we initialise Meson by running the following command in the source directory.
- meson build
+ meson builddir
For the remainder of the document we assume that all commands are executed inside the build directory unless otherwise specified.
@@ -32,7 +36,7 @@ The next thing to display is the list of options that can be set. These include
To set the options, use the `mesonconf.py` binary.
-Compilation and unit tests are done as usual by running the `ninja` and `ninja test` commands. A JSON formatted result log can be found in `workspace/project/build/meson-logs/testlog.json`.
+Compilation and unit tests are done as usual by running the `ninja` and `ninja test` commands. A JSON formatted result log can be found in `workspace/project/builddir/meson-logs/testlog.json`.
When these tests fail, the user probably wants to run the failing test in a debugger. To make this as integrated as possible, extract the test test setups with this command.