Skip to content

Commit 1e8bf43

Browse files
committed
Markup more MSVC C++ refs [skip appveyor]
Also style MSBuild (did not create an entity for it) Signed-off-by: Mats Wichmann <[email protected]>
1 parent 9e73146 commit 1e8bf43

File tree

2 files changed

+18
-15
lines changed

2 files changed

+18
-15
lines changed

SCons/Tool/msvc.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1126,7 +1126,7 @@ when setting the script error policy to raise an exception (e.g., <literal>'Erro
11261126
<cvar name="MSVC_SCRIPT_ARGS">
11271127
<summary>
11281128
<para>
1129-
Pass user-defined arguments to the &MSVC; file determined via autodetection.
1129+
Pass user-defined arguments to the &MSVC; batch file determined via autodetection.
11301130
</para>
11311131

11321132
<para>

SCons/Tool/msvs.xml

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,12 @@ This file is processed by the bin/SConsDoc.py module
4141
<builder name="MSVSProject">
4242
<summary>
4343
<para>
44-
Build a C++ project file and solution file.
44+
Build a &MSVC; project file and solution file.
4545
</para>
4646
<para>
47-
Builds a C++ project file based on the
48-
version of Visual Studio (or to be more precise, of MSBuild)
47+
Builds a &MSVC; project file based on the
48+
version of Visual Studio (or to be more precise, of
49+
<application>MSBuild</application>)
4950
that is configured: either the latest installed version,
5051
or the version specified by
5152
&cv-link-MSVC_VERSION; in the current &consenv;.
@@ -57,10 +58,10 @@ This file is processed by the bin/SConsDoc.py module
5758
Note there are multiple versioning schemes involved in
5859
the Microsoft compilation environment -
5960
see the description of &cv-link-MSVC_VERSION; for equivalences.
60-
&SCons; does not know how to construct project files for
61-
other languages (such as <filename>.csproj</filename> for C#,
61+
Note &SCons; does not know how to construct project files for
62+
other languages (e.g. <filename>.csproj</filename> for C#,
6263
<filename>.vbproj</filename> for Visual Basic or
63-
<filename>.pyproject</filename> for Python)).
64+
<filename>.pyproject</filename> for Python).
6465
</para>
6566
<para>
6667
For the <filename>.vcxproj</filename> file, the underlying
@@ -69,15 +70,15 @@ This file is processed by the bin/SConsDoc.py module
6970
https://learn.microsoft.com/en-us/cpp/build/reference/vcxproj-file-structure</ulink>.
7071
The generated solution file enables Visual Studio to
7172
understand the project structure, and allows building it
72-
using MSBuild to call back to &SCons;.
73+
using <application>MSBuild</application> to call back to &SCons;.
7374
The project file encodes a toolset version that has been
7475
selected by &SCons; as described above. Since recent Visual
7576
Studio versions support multiple concurrent toolsets,
7677
use &cv-link-MSVC_VERSION; to select the desired one if
7778
it does not match the &SCons; default.
7879
The project file also includes entries which describe
7980
how to call &SCons; to build the project from within Visual Studio
80-
(or from an MSBuild command line).
81+
(or from an <application>MSBuild</application> command line).
8182
In some situations &SCons; may generate this incorrectly -
8283
notably when using the <emphasis>scons-local</emphasis>
8384
distribution, which is not installed in a way that that
@@ -112,7 +113,8 @@ This file is processed by the bin/SConsDoc.py module
112113
(for example if you generate files for inclusion by using the
113114
&f-link-Glob; function, the results should be converted to
114115
a list of strings before passing them to &b-MSVSProject;).
115-
This is because Visual Studio and MSBuild know nothing about &SCons;
116+
This is because Visual Studio and
117+
<application>MSBuild</application> know nothing about &SCons;
116118
Node types.
117119
Each of the filename lists are individually optional, but at
118120
least one list must be specified for the resulting project file to
@@ -272,7 +274,8 @@ This file is processed by the bin/SConsDoc.py module
272274
of the build.
273275
</para>
274276
<para>
275-
If the project file is used to drive MSBuild (such as selecting
277+
If the project file is used to drive
278+
<application>MSBuild</application> (such as selecting
276279
"build" from the Visual Studio interface) you lose the direct
277280
control of target selection and command-line options you would
278281
have if launching the build directly from &SCons;,
@@ -283,7 +286,8 @@ This file is processed by the bin/SConsDoc.py module
283286
targets, arguments, defines, flags and paths for different variants.
284287
</para>
285288
<para>
286-
If the build is divided into a solution with multiple MSBuild
289+
If the build is divided into a solution with multiple
290+
<application>MSBuild</application>
287291
projects the mapping is further strained. In this case,
288292
it is important not to set Visual Studio to do parallel builds,
289293
as it will then launch the separate project builds in parallel,
@@ -529,7 +533,8 @@ env.MSVSProject(
529533
into the solution file.
530534
Note that these filenames need to be specified as strings,
531535
NOT as &SCons; File Nodes.
532-
This is because the solution file will be interpreted by MSBuild
536+
This is because the solution file will be interpreted by
537+
<application>MSBuild</application>
533538
and by Visual Studio, which know nothing about &SCons; Node types.
534539
</para>
535540
</listitem>
@@ -649,7 +654,6 @@ env.MSVSSolution(
649654
C++ project file as the value of the
650655
<literal>ProjectGUID</literal> attribute. There is no default
651656
value. If not defined, a new GUID is generated.
652-
653657
</para>
654658
</summary>
655659
</cvar> <cvar name="MSVS_SCC_AUX_PATH">
@@ -660,7 +664,6 @@ env.MSVSSolution(
660664
<literal>SccAuxPath</literal> attribute if the
661665
<envar>MSVS_SCC_PROVIDER</envar> &consvar; is
662666
also set. There is no default value.
663-
664667
</para>
665668
</summary>
666669
</cvar> <cvar name="MSVS_SCC_CONNECTION_ROOT">

0 commit comments

Comments
 (0)