From bf778b2637ed12c6a7d456a4ffb7f9ad40bdcc97 Mon Sep 17 00:00:00 2001 From: Mats Wichmann Date: Sat, 5 Feb 2022 12:26:28 -0700 Subject: Docs: Fix a typo and use more entities [skip appveyor] Fixes #4096 (thanks to @Vishwajith-K for reporting) Changed references in this file to use &consvar; and &consenv; entities. + Use the entity for PATH as well. + Update the entity reference for DUMP. Also fix unrelated missing-entity referring to SConscriptChdir method. Signed-off-by: Mats Wichmann --- SCons/Environment.xml | 2 +- doc/user/troubleshoot.xml | 18 +++++++++--------- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/SCons/Environment.xml b/SCons/Environment.xml index e10aef3..f471866 100644 --- a/SCons/Environment.xml +++ b/SCons/Environment.xml @@ -2882,7 +2882,7 @@ when all the directories in which SConscript files may be found don't necessarily exist locally.) You may enable and disable this ability by calling -SConscriptChdir() +&f-SConscriptChdir; multiple times. diff --git a/doc/user/troubleshoot.xml b/doc/user/troubleshoot.xml index 3906af6..24020ab 100644 --- a/doc/user/troubleshoot.xml +++ b/doc/user/troubleshoot.xml @@ -261,13 +261,13 @@ file3.c
- What's in That Construction Environment? the &Dump; Method + What's in That Construction Environment? the &f-Dump; Method - When you create a construction environment, + When you create a &consenv;, &SCons; populates it - with construction variables that are set up + with &consvars; that are set up for various compilers, linkers and utilities that it finds on your system. Although this is usually helpful and what you want, @@ -276,10 +276,10 @@ file3.c expect to be set. In situations like this, it's sometimes helpful to use the - construction environment &Dump; method + &consenv; &f-link-Dump; method to print all or some of - the construction variables. - Note that the &Dump; method + the &consvars;. + Note that the &f-Dump; method returns the representation of the variables in the environment @@ -318,11 +318,11 @@ print(env.Dump()) - The construction environments in these examples have + The &consenvs; in these examples have actually been restricted to just gcc and Visual C++, respectively. In a real-life situation, - the construction environments will + the &consenvs; will likely contain a great many more variables. Also note that we've massaged the example output above to make the memory address of all objects a constant 0x700000. @@ -336,7 +336,7 @@ print(env.Dump()) To make it easier to see just what you're interested in, the &Dump; method allows you to - specify a specific constrcution variable + specify a specific &consvar; that you want to disply. For example, it's not unusual to want to verify -- cgit v0.12