From 23ad05aba1ff6aadbdf3ed424e1146532030257b Mon Sep 17 00:00:00 2001
From: Robbert van der Helm <mail@robbertvanderhelm.nl>
Date: Mon, 16 Mar 2020 13:45:00 +0100
Subject: [PATCH] Better document the use-winedbg option

---
 README.md         | 2 +-
 meson_options.txt | 7 ++++++-
 2 files changed, 7 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 2b3e7ed3..647a88ea 100644
--- a/README.md
+++ b/README.md
@@ -131,7 +131,7 @@ window managers will require some slight modifications in
 `src/plugin/host-bridge.cpp`. To enable this, simply run:
 
 ```shell
-meson configure build -Duse-winedbg=true
+meson configure build --buildtype=debug -Duse-winedbg=true
 ```
 
 ## Rationale
diff --git a/meson_options.txt b/meson_options.txt
index 93e61071..0cf248c6 100644
--- a/meson_options.txt
+++ b/meson_options.txt
@@ -1 +1,6 @@
-option('use-winedbg', type : 'boolean', value : false)
+option(
+  'use-winedbg',
+  type : 'boolean',
+  value : false,
+  description: 'Whether to run the Wien VST host with GDB attached. Might not always be reliable.'
+)