Skip to content

Commit ace7448

Browse files
committed
fixed a few typos and changed all references to c++ project file to be MSVC (entity) project file
1 parent 1e8bf43 commit ace7448

File tree

10 files changed

+252
-182
lines changed

10 files changed

+252
-182
lines changed

SCons/Tool/msvc.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -409,7 +409,7 @@ Values that do not look like a valid compiler version
409409
To have the desired effect, &cv-MSVC_VERSION; must be set by the
410410
time compiler discovery takes place.
411411
If the default tools list
412-
or an excplicit tools list including &t-link-msvc; is used,
412+
or an explicit tools list including &t-link-msvc; is used,
413413
discovery takes place as the &consenv; is created,
414414
so passing it as an argument in the the &f-link-Environment; call
415415
is the effective solution.
@@ -427,7 +427,7 @@ Note that it is not necessary to install Visual Studio
427427
to build with &SCons; (for example, you can install only
428428
Build Tools), but if Visual Studio is installed,
429429
additional builders such as &b-link-MSVSSolution; and
430-
&b-link-MSVSProject; become avaialable and will
430+
&b-link-MSVSProject; become available and will
431431
correspond to the indicated versions.
432432
</para>
433433

SCons/Tool/msvs.xml

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ This file is processed by the bin/SConsDoc.py module
239239
The name of the file that Visual Studio 7 and
240240
later will run and debug. This appears as the
241241
value of the <parameter>Output</parameter> field in the
242-
resulting C++ project file. If this is not
242+
resulting &MSVC; project file. If this is not
243243
specified, the default is the same as the specified
244244
<parameter>buildtarget</parameter> value.
245245
</para>
@@ -651,7 +651,7 @@ env.MSVSSolution(
651651
<summary>
652652
<para>
653653
The string placed in a generated
654-
C++ project file as the value of the
654+
&MSVC; project file as the value of the
655655
<literal>ProjectGUID</literal> attribute. There is no default
656656
value. If not defined, a new GUID is generated.
657657
</para>
@@ -660,7 +660,7 @@ env.MSVSSolution(
660660
<summary>
661661
<para>
662662
The path name placed in a generated
663-
C++ project file as the value of the
663+
&MSVC; project file as the value of the
664664
<literal>SccAuxPath</literal> attribute if the
665665
<envar>MSVS_SCC_PROVIDER</envar> &consvar; is
666666
also set. There is no default value.
@@ -672,7 +672,7 @@ env.MSVSSolution(
672672
The root path of projects in your SCC workspace, i.e the
673673
path under which all project and solution files will be
674674
generated. It is used as a reference path from which the
675-
relative paths of the generated C++ project
675+
relative paths of the generated &MSVC; project
676676
and solution files are computed. The relative project file path
677677
is placed as the value of the <literal>SccLocalPath</literal>
678678
attribute of the project file and as the values of the
@@ -692,7 +692,7 @@ env.MSVSSolution(
692692
</cvar> <cvar name="MSVS_SCC_PROJECT_NAME">
693693
<summary>
694694
<para>
695-
The project name placed in a generated C++
695+
The project name placed in a generated &MSVC;
696696
project file as the value of the
697697
<literal>SccProjectName</literal> attribute if the
698698
<envar>MSVS_SCC_PROVIDER</envar> &consvar;
@@ -706,7 +706,7 @@ env.MSVSSolution(
706706
</cvar> <cvar name="MSVS_SCC_PROVIDER">
707707
<summary>
708708
<para>
709-
The string placed in a generated C++
709+
The string placed in a generated &MSVC;
710710
project file as the value of the
711711
<literal>SccProvider</literal> attribute. The string is
712712
also placed in the <literal>SccProvider0</literal> attribute
@@ -742,7 +742,7 @@ env.MSVSSolution(
742742
<cvar name="MSVSBUILDCOM">
743743
<summary>
744744
<para>
745-
The build command line placed in a generated C++
745+
The build command line placed in a generated &MSVC;
746746
project file. The default is to have Visual Studio
747747
invoke &SCons; with any specified build targets.
748748
</para>
@@ -751,7 +751,7 @@ env.MSVSSolution(
751751
<cvar name="MSVSCLEANCOM">
752752
<summary>
753753
<para>
754-
The clean command line placed in a generated C++
754+
The clean command line placed in a generated &MSVC;
755755
project file. The default is to have Visual Studio
756756
invoke &SCons; with the <option>-c</option> option to remove
757757
any specified targets.
@@ -760,21 +760,21 @@ env.MSVSSolution(
760760
</cvar> <cvar name="MSVSENCODING">
761761
<summary>
762762
<para>
763-
The encoding string placed in a generated C++
763+
The encoding string placed in a generated &MSVC;
764764
project file. The default is encoding
765765
<literal>Windows-1252</literal>.
766766
</para>
767767
</summary>
768768
</cvar>
769769
<cvar name="MSVSPROJECTCOM">
770770
<summary>
771-
<para>The action used to generate C++ project files.</para>
771+
<para>The action used to generate &MSVC; project files.</para>
772772
</summary>
773773
</cvar>
774774
<cvar name="MSVSPROJECTSUFFIX">
775775
<summary>
776776
<para>
777-
The suffix used for C++ project (DSP)
777+
The suffix used for &MSVC; project (DSP)
778778
files. The default value is
779779
<filename>.vcxproj</filename> when using Visual Studio 2010
780780
and later, <filename>.vcproj</filename>
@@ -786,7 +786,7 @@ env.MSVSSolution(
786786
<cvar name="MSVSREBUILDCOM">
787787
<summary>
788788
<para>
789-
The rebuild command line placed in a generated C++
789+
The rebuild command line placed in a generated &MSVC;
790790
project file. The default is to have Visual
791791
Studio invoke &SCons; with any specified rebuild targets.
792792

@@ -796,7 +796,7 @@ env.MSVSSolution(
796796
<cvar name="MSVSSCONS">
797797
<summary>
798798
<para>
799-
The &SCons; used in generated C++ project
799+
The &SCons; used in generated &MSVC; project
800800
files. The default is the version of &SCons; being used to
801801
generate the project file.
802802
</para>
@@ -805,22 +805,22 @@ env.MSVSSolution(
805805
<cvar name="MSVSSCONSFLAGS">
806806
<summary>
807807
<para>
808-
The &SCons; flags used in generated C++ project files.
808+
The &SCons; flags used in generated &MSVC; project files.
809809
</para>
810810
</summary>
811811
</cvar>
812812
<cvar name="MSVSSCONSCOM">
813813
<summary>
814814
<para>
815-
The default &SCons; command used in generated C++ project files.
815+
The default &SCons; command used in generated &MSVC; project files.
816816
</para>
817817
</summary>
818818
</cvar>
819819
<cvar name="MSVSSCONSCRIPT">
820820
<summary>
821821
<para>
822822
The sconscript file (that is, &SConstruct; or &SConscript;
823-
file) that will be invoked by C++ project files
823+
file) that will be invoked by &MSVC; project files
824824
(through the &cv-link-MSVSSCONSCOM; variable). The default
825825
is the same sconscript file that contains the call to
826826
&b-link-MSVSProject; to build the project file.

doc/generated/builders.gen

Lines changed: 25 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -836,11 +836,12 @@ Compile files for languages defined in <filename>LINGUAS</filename> file
836836
<term><function>MSVSProject</function>()</term>
837837
<term><replaceable>env</replaceable>.<methodname>MSVSProject</methodname>()</term>
838838
<listitem><para>
839-
Build a Microsoft Visual C++ project file and solution file.
839+
Build a &MSVC; project file and solution file.
840840
</para>
841841
<para>
842-
Builds a C++ project file based on the
843-
version of Visual Studio (or to be more precise, of MSBuild)
842+
Builds a &MSVC; project file based on the
843+
version of Visual Studio (or to be more precise, of
844+
<application>MSBuild</application>)
844845
that is configured: either the latest installed version,
845846
or the version specified by
846847
&cv-link-MSVC_VERSION; in the current &consenv;.
@@ -852,10 +853,10 @@ Compile files for languages defined in <filename>LINGUAS</filename> file
852853
Note there are multiple versioning schemes involved in
853854
the Microsoft compilation environment -
854855
see the description of &cv-link-MSVC_VERSION; for equivalences.
855-
&SCons; does not know how to construct project files for
856-
other languages (such as <filename>.csproj</filename> for C#,
857-
<filename>.vbproj</filename> for Visual Basic or
858-
<filename>.pyproject</filename> for Python)).
856+
Note &SCons; does not know how to construct project files for
857+
other languages (e.g. <filename>.csproj</filename> for C#,
858+
<filename>.vbproj</filename> for Visual Basic or
859+
<filename>.pyproject</filename> for Python).
859860
</para>
860861
<para>
861862
For the <filename>.vcxproj</filename> file, the underlying
@@ -864,15 +865,15 @@ Compile files for languages defined in <filename>LINGUAS</filename> file
864865
https://learn.microsoft.com/en-us/cpp/build/reference/vcxproj-file-structure</ulink>.
865866
The generated solution file enables Visual Studio to
866867
understand the project structure, and allows building it
867-
using MSBuild to call back to &SCons;.
868+
using <application>MSBuild</application> to call back to &SCons;.
868869
The project file encodes a toolset version that has been
869870
selected by &SCons; as described above. Since recent Visual
870871
Studio versions support multiple concurrent toolsets,
871872
use &cv-link-MSVC_VERSION; to select the desired one if
872873
it does not match the &SCons; default.
873874
The project file also includes entries which describe
874875
how to call &SCons; to build the project from within Visual Studio
875-
(or from an MSBuild command line).
876+
(or from an <application>MSBuild</application> command line).
876877
In some situations &SCons; may generate this incorrectly -
877878
notably when using the <emphasis>scons-local</emphasis>
878879
distribution, which is not installed in a way that that
@@ -907,7 +908,8 @@ Compile files for languages defined in <filename>LINGUAS</filename> file
907908
(for example if you generate files for inclusion by using the
908909
&f-link-Glob; function, the results should be converted to
909910
a list of strings before passing them to &b-MSVSProject;).
910-
This is because Visual Studio and MSBuild know nothing about &SCons;
911+
This is because Visual Studio and
912+
<application>MSBuild</application> know nothing about &SCons;
911913
Node types.
912914
Each of the filename lists are individually optional, but at
913915
least one list must be specified for the resulting project file to
@@ -1032,7 +1034,7 @@ Compile files for languages defined in <filename>LINGUAS</filename> file
10321034
The name of the file that Visual Studio 7 and
10331035
later will run and debug. This appears as the
10341036
value of the <parameter>Output</parameter> field in the
1035-
resulting Visual C++ project file. If this is not
1037+
resulting &MSVC; project file. If this is not
10361038
specified, the default is the same as the specified
10371039
<parameter>buildtarget</parameter> value.
10381040
</para>
@@ -1051,7 +1053,7 @@ Compile files for languages defined in <filename>LINGUAS</filename> file
10511053
than the directory of the &SConstruct; file, users will not be able to
10521054
double-click on the file name in compilation error messages
10531055
displayed in the Visual Studio console output window. This can
1054-
be remedied by adding the Visual C/C++ <option>/FC</option>
1056+
be remedied by adding the &MSVC; <option>/FC</option>
10551057
compiler option to the &cv-link-CCFLAGS; variable so that
10561058
the compiler will print the full path name of any files that
10571059
cause compilation errors.
@@ -1067,7 +1069,8 @@ Compile files for languages defined in <filename>LINGUAS</filename> file
10671069
of the build.
10681070
</para>
10691071
<para>
1070-
If the project file is used to drive MSBuild (such as selecting
1072+
If the project file is used to drive
1073+
<application>MSBuild</application> (such as selecting
10711074
"build" from the Visual Studio interface) you lose the direct
10721075
control of target selection and command-line options you would
10731076
have if launching the build directly from &SCons;,
@@ -1078,7 +1081,8 @@ Compile files for languages defined in <filename>LINGUAS</filename> file
10781081
targets, arguments, defines, flags and paths for different variants.
10791082
</para>
10801083
<para>
1081-
If the build is divided into a solution with multiple MSBuild
1084+
If the build is divided into a solution with multiple
1085+
<application>MSBuild</application>
10821086
projects the mapping is further strained. In this case,
10831087
it is important not to set Visual Studio to do parallel builds,
10841088
as it will then launch the separate project builds in parallel,
@@ -1325,7 +1329,8 @@ env.MSVSProject(
13251329
into the solution file.
13261330
Note that these filenames need to be specified as strings,
13271331
NOT as &SCons; File Nodes.
1328-
This is because the solution file will be interpreted by MSBuild
1332+
This is because the solution file will be interpreted by
1333+
<application>MSBuild</application>
13291334
and by Visual Studio, which know nothing about &SCons; Node types.
13301335
</para>
13311336
</listitem>
@@ -1537,7 +1542,7 @@ the top directory of the project.
15371542
<term><function>PCH</function>()</term>
15381543
<term><replaceable>env</replaceable>.<methodname>PCH</methodname>()</term>
15391544
<listitem><para>
1540-
Builds a Microsoft Visual C++ precompiled header.
1545+
Builds a &MSVC; precompiled header.
15411546
Calling this builder
15421547
returns a list of two target nodes: the PCH as the first element,
15431548
and the object file as the second element.
@@ -1553,13 +1558,12 @@ env['PCH'] = env.PCH('StdAfx.cpp')[0]
15531558

15541559
<note>
15551560
<para>
1556-
This builder is specific to the PCH implementation
1557-
in Microsoft Visual C++.
1561+
This builder is specific to the PCH implementation in &MSVC;.
15581562
Other compiler chains also implement precompiled header support,
15591563
but &b-PCH; does not work with them at this time.
15601564
As a result, the builder is only generated into the
15611565
construction environment when
1562-
Microsoft Visual C++ is being used as the compiler.
1566+
&MSVC; is being used as the compiler.
15631567
</para>
15641568
<para>
15651569
The builder only works correctly in a C++ project.
@@ -2074,9 +2078,9 @@ env.Program(target='foo', source=['foo.o', 'bar.c', 'baz.f'])
20742078
<term><function>RES</function>()</term>
20752079
<term><replaceable>env</replaceable>.<methodname>RES</methodname>()</term>
20762080
<listitem><para>
2077-
Builds a Microsoft Visual C++ resource file.
2081+
Builds a &MSVC; resource file.
20782082
This builder method is only provided
2079-
when Microsoft Visual C++ or MinGW is being used as the compiler. The
2083+
when &MSVC; or MinGW is being used as the compiler. The
20802084
<filename>.res</filename>
20812085
(or
20822086
<filename>.o</filename>
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<screen xmlns="http://www.scons.org/dbxsd/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q</userinput>
2-
cc -o f2.o -c f2.c
32
cc -o f3.o -c f3.c
43
cc -o f5.o -c f5.c
5-
cc -o f1.o -c f1.c
64
cc -o f4.o -c f4.c
5+
cc -o f2.o -c f2.c
6+
cc -o f1.o -c f1.c
77
cc -o prog f1.o f2.o f3.o f4.o f5.o
88
</screen>

doc/generated/examples/troubleshoot_explain1_3.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22
cp file.in file.oout
33

44
scons: warning: Cannot find target file.out after building
5-
File "/Users/bdbaddog/devel/scons/git/as_scons/scripts/scons.py", line 97, in &lt;module&gt;
5+
File "/Users/bdbaddog/devel/scons/git/mwichmann/scripts/scons.py", line 97, in &lt;module&gt;
66
</screen>
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
<screen xmlns="http://www.scons.org/dbxsd/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd">% <userinput>scons -Q --debug=stacktrace</userinput>
22
scons: *** [prog.o] Source `prog.c' not found, needed by target `prog.o'.
33
scons: internal stack trace:
4-
File "SCons/Taskmaster/Job.py", line 219, in start
4+
File "SCons/Taskmaster/Job.py", line 671, in _work
55
task.prepare()
66
File "SCons/Script/Main.py", line 201, in prepare
77
return SCons.Taskmaster.OutOfDateTask.prepare(self)
88
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
99
File "SCons/Taskmaster/__init__.py", line 195, in prepare
1010
executor.prepare()
11-
File "SCons/Executor.py", line 418, in prepare
11+
File "SCons/Executor.py", line 420, in prepare
1212
raise SCons.Errors.StopError(msg % (s, self.batches[0].targets[0]))
1313
</screen>

0 commit comments

Comments
 (0)