From 7ec6e6df2013aa65f99e0183c9d36b3ef3b7ab0e Mon Sep 17 00:00:00 2001 From: Peter Hutterer Date: Wed, 3 May 2017 19:38:41 +1000 Subject: docs: add a short description for all top pages in the Manual --- docs/markdown/IDE-integration.md | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'docs/markdown/IDE-integration.md') diff --git a/docs/markdown/IDE-integration.md b/docs/markdown/IDE-integration.md index 7e046c6..46e96c0 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. -- cgit v1.1 From 276d342ebaf859dd53e145ead3e98e2cebb360ab Mon Sep 17 00:00:00 2001 From: Peter Hutterer Date: Wed, 3 May 2017 13:34:48 +1000 Subject: docs: replace 'meson build' with 'meson builddir' Clarifies that this is really just a directory, not a command. https://github.com/mesonbuild/meson/issues/1560 --- docs/markdown/IDE-integration.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/markdown/IDE-integration.md') diff --git a/docs/markdown/IDE-integration.md b/docs/markdown/IDE-integration.md index 46e96c0..7258f56 100644 --- a/docs/markdown/IDE-integration.md +++ b/docs/markdown/IDE-integration.md @@ -10,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. @@ -36,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. -- cgit v1.1