Fix documentation of nvdaHelperDebugFlags in source readme and add entry to What...

diff --git a/readme.txt b/readme.txt
index ddc6706..17a0fab 100644 (file)
--- a/readme.txt
+++ b/readme.txt
@@ -100,17 +100,17 @@ You do this by opening a command prompt, changing to the root of the NVDA source
 scons source\r
 You should do this again whenever the version of comtypes changes or language files are added or changed.\r
 \r
-=== Compiling NVDAHelper with debugging options ===\r
-A part from compiling language files and generating COM interfaces, this step also builds the NVDAHelper libraries.  \r
-If trying to debug nvdaHelper, You can control various  debugging options  with the nvdaHelperDebugFlag commandline variable. It takes one or more of the following flags:\r
-       * symbols: debugging symbols will be added to the DLLs and pdb files will be generated for use with a debugger. (symbols are produced by default, but if specifying nvdaHelperDebugFlags and you want symbols it is still necessary to  specify this keyword).\r
-       * debugCRT: the libraries will be linked against the debug C runtime and assertions will be enabled. (The normal CRT is used by default and assertions are disabled).\r
-       * noOptimize: All compiler optimizations will be disabled. (Optimization 2 [/O2] is used by default). \r
-       * RTC: runtime checks (stack corruption, uninitialized variables etc) will be enabled (default is no runtime checks).\r
-\r
-The special keywords of none and all can also be used in place of the individual flags.\r
-An example follows that enables only symbols and assertions:\r
-scons source nvdaHelperDebugflags=symbols,assertions\r
+=== Compiling NVDAHelper with Debugging Options ===\r
+Among other things, preparing the source tree builds the NVDAHelper libraries.  \r
+If trying to debug nvdaHelper, You can control various  debugging options  with the nvdaHelperDebugFlags command line variable. It takes one or more of the following flags:\r
+       * symbols: debugging symbols will be added to the DLLs and pdb files will be generated for use with a debugger. (symbols are produced by default, but if specifying nvdaHelperDebugFlags and you want symbols it is still necessary to  specify this keyword.)\r
+       * debugCRT: the libraries will be linked against the debug C runtime and assertions will be enabled. (By default, the normal CRT is used and assertions are disabled.)\r
+       * noOptimize: All compiler optimizations will be disabled. (Optimization 2 [/O2] is used by default.)\r
+       * RTC: runtime checks (stack corruption, uninitialized variables, etc.) will be enabled. (The default is no runtime checks.)\r
+The special keywords none and all can also be used in place of the individual flags.\r
+\r
+An example follows that enables symbols and disables optimizations:\r
+scons source nvdaHelperDebugflags=symbols,noOptimize\r
 \r
 == Running the Source Code ==\r
 To start NVDA from source code, run nvda.pyw located in the source directory.\r
@@ -140,7 +140,6 @@ To generate an archive of debug symbols for the various dll/exe binaries, type:
 scons symbolsArchive\r
 The archive will be placed in the output directory.\r
  \r
-\r
 Optionally, the build can  be customised by providing variables on the command line:\r
        * version: The version of this build.\r
        * release: Whether this is a release version.\r

diff --git a/user_docs/en/changes.t2t b/user_docs/en/changes.t2t
index ca8f136..28aef2f 100644 (file)
--- a/user_docs/en/changes.t2t
+++ b/user_docs/en/changes.t2t
@@ -113,6 +113,7 @@ Highlights of this release include major improvements concerning punctuation and
 - Developer documentation can now be generated using SCons. See readme.txt at the root of the source distribution for details, including associated dependencies.\r
 - Locales can now provide descriptions for characters. See the Character Descriptions section of the Developer Guide for details. (#55)\r
 - Locales can now provide information about the pronunciation of specific punctuation and other symbols. See the Symbol Pronunciation section of the Developer Guide for details. (#332)\r
+- You can now build NVDAHelper with several debugging options using the nvdaHelperDebugFlags SCons variable. See readme.txt at the root of the source distribution for details. (#1390)\r
 - Synth drivers are now passed a sequence of text and speech commands to speak, instead of just text and an index.\r
  - This allows for embedded indexes, parameter changes, etc.\r
  - Drivers should implement SynthDriver.speak() instead of SynthDriver.speakText() and SynthDriver.speakCharacter().\r