Skip to content

Commit 1f3b310

Browse files
authored
Merge pull request #12601 from ghogen/cpp-note
Add note and adjust dev_langs metadata for C++ MSBuild tasks
2 parents 3900ec7 + 190b1b9 commit 1f3b310

20 files changed

+44
-50
lines changed

docs/msbuild/bscmake-task.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,6 @@ f1_keywords:
77
- vc.task.bscmake
88
- VC.Project.VCBscMakeTool.PreserveSBR
99
dev_langs:
10-
- VB
11-
- CSharp
12-
- C++
1310
- C++
1411
helpviewer_keywords:
1512
- MSBuild (C++), tasks
@@ -24,6 +21,8 @@ ms.subservice: msbuild
2421
> [!IMPORTANT]
2522
> BscMake is no longer used by the Visual Studio IDE. Since Visual Studio 2008, browse information is stored automatically in an *.sdf* file in the *Solution* folder.
2623
24+
[!INCLUDE [C++-specific task](./includes/cpp-task.md)]
25+
2726
Wraps the Microsoft Browse Information Maintenance Utility tool (*bscmake.exe*). The *bscmake.exe* tool builds a browse information file (*.bsc*) from source browser files (*.sbr*) that are created during compilation. Use the **Object Browser** to view a *.bsc* file. For more information, see [BSCMAKE reference](/cpp/build/reference/bscmake-reference).
2827

2928
## Parameters

docs/msbuild/cl-task.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@ f1_keywords:
99
- VC.Project.VCCLCompilerTool.TreatSpecificWarningsAsErrors
1010
- VC.Project.VCCLCompilerTool.CreateHotpatchableImage
1111
dev_langs:
12-
- VB
13-
- CSharp
1412
- C++
1513
helpviewer_keywords:
1614
- MSBuild (C++), CL task
@@ -22,6 +20,8 @@ ms.subservice: msbuild
2220
---
2321
# CL task
2422

23+
[!INCLUDE [C++-specific task](./includes/cpp-task.md)]
24+
2525
Wraps the Microsoft C++ compiler tool, *cl.exe*. The compiler produces executable (*.exe*) files, dynamic-link library (*.dll*) files, or code module (*.netmodule*) files. For more information, see [Compiler options](/cpp/build/reference/compiler-options) and [Use MSBuild from the command line](/cpp/build/msbuild-visual-cpp) and [Use the Microsoft C++ toolset from the command line](/cpp/build/building-on-the-command-line).
2626

2727
## Parameters

docs/msbuild/clangcompile-task.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,6 @@ ms.topic: "reference"
66
f1_keywords:
77
- "vc.task.clangcompile"
88
dev_langs:
9-
- "VB"
10-
- "CSharp"
11-
- "C++"
129
- "C++"
1310
helpviewer_keywords:
1411
- "MSBuild (C++), ClangCompile task"
@@ -18,6 +15,8 @@ ms.author: twhitney
1815
---
1916
# ClangCompile task
2017

18+
[!INCLUDE [C++-specific task](./includes/cpp-task.md)]
19+
2120
Wraps the Microsoft C++ compiler tool, clang.exe.
2221

2322
## Parameters

docs/msbuild/cppclean-task.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,6 @@ ms.topic: reference
66
f1_keywords:
77
- vc.task.cppclean
88
dev_langs:
9-
- VB
10-
- CSharp
11-
- C++
129
- C++
1310
helpviewer_keywords:
1411
- MSBuild (C++), CPPClean task
@@ -20,6 +17,8 @@ ms.subservice: msbuild
2017
---
2118
# CPPClean Task
2219

20+
[!INCLUDE [C++-specific task](./includes/cpp-task.md)]
21+
2322
Deletes the temporary files that MSBuild creates when a C++ project is built. The process of deleting build files is known as *cleaning*.
2423

2524
## Parameters

docs/msbuild/custombuild-task.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,6 @@ ms.topic: reference
66
f1_keywords:
77
- vc.task.custombuild
88
dev_langs:
9-
- VB
10-
- CSharp
11-
- C++
129
- C++
1310
helpviewer_keywords:
1411
- MSBuild (C++), CustomBuild task
@@ -18,6 +15,8 @@ ms.author: ghogen
1815
---
1916
# CustomBuild task
2017

18+
[!INCLUDE [C++-specific task](./includes/cpp-task.md)]
19+
2120
Wraps the Microsoft C++ compiler tool, cmd.exe. This class derives from [TrackedVCToolTask](../msbuild/trackedvctooltask-base-class.md), but does not use file tracking to discover file dependencies. All dependencies should be explicitly specified as AdditionalDependencies for incremental build working properly.
2221

2322
## Parameters

docs/msbuild/fxc-task.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,6 @@ ms.topic: "reference"
66
f1_keywords:
77
- "vc.task.fxc"
88
dev_langs:
9-
- "VB"
10-
- "CSharp"
11-
- "C++"
129
- "C++"
1310
helpviewer_keywords:
1411
- "MSBuild (C++), FXC task"
@@ -18,6 +15,8 @@ ms.author: twhitney
1815
---
1916
# FXC task
2017

18+
[!INCLUDE [C++-specific task](./includes/cpp-task.md)]
19+
2120
Use HLSL shader compilers in the build process.
2221

2322
## Parameters

docs/msbuild/getoutofdateitems-task.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,6 @@ ms.topic: "reference"
66
f1_keywords:
77
- "vc.task.getoutofdateitems"
88
dev_langs:
9-
- "VB"
10-
- "CSharp"
11-
- "C++"
129
- "C++"
1310
helpviewer_keywords:
1411
- "MSBuild (C++), GetOutOfDateItems task"
@@ -18,6 +15,8 @@ ms.author: twhitney
1815
---
1916
# GetOutOfDateItems task
2017

18+
[!INCLUDE [C++-specific task](./includes/cpp-task.md)]
19+
2120
Helper task that reads old tlogs, writes new tlogs, and returns set of items that are not up-to-date.
2221

2322
## Parameters

docs/msbuild/getoutputfilename-task.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,6 @@ ms.topic: reference
66
f1_keywords:
77
- vc.task.getoutputfilename
88
dev_langs:
9-
- VB
10-
- CSharp
11-
- C++
129
- C++
1310
helpviewer_keywords:
1411
- MSBuild (C++), GetOutputFileName task
@@ -18,6 +15,8 @@ ms.author: ghogen
1815
---
1916
# GetOutputFileName task
2017

18+
[!INCLUDE [C++-specific task](./includes/cpp-task.md)]
19+
2120
Helper task to get output file name for cl and other tools, which allow specifying only output directory or full file name or nothing.
2221

2322
## Parameters

docs/msbuild/includes/cpp-task.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
author: ghogen
3+
ms.author: ghogen
4+
ms.topic: include
5+
ms.date: 5/17/2024
6+
---
7+
> [!NOTE]
8+
> This task is only available when using the C++ build system.

docs/msbuild/lib-task.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,6 @@ f1_keywords:
1212
- "VC.Project.VCLibrarianTool.LinkLibraryDependencies"
1313
- "VC.Project.VCLibrarianTool.LinkTimeCodeGeneration"
1414
dev_langs:
15-
- "VB"
16-
- "CSharp"
17-
- "C++"
1815
- "C++"
1916
helpviewer_keywords:
2017
- "MSBuild (C++), LIB task"
@@ -26,6 +23,8 @@ ms.subservice: msbuild
2623
---
2724
# LIB task
2825

26+
[!INCLUDE [C++-specific task](./includes/cpp-task.md)]
27+
2928
Wraps the Microsoft 32-Bit Library Manager tool, *lib.exe*. The Library Manager creates and manages a library of Common Object File Format (COFF) object files. The Library Manager can also create export files and import libraries to reference exported definitions. For more information, see [LIB reference](/cpp/build/reference/lib-reference) and [Running LIB](/cpp/build/reference/running-lib).
3029

3130
## Parameters

docs/msbuild/link-task.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,6 @@ f1_keywords:
1818
- VC.Project.VCLinkerTool.ImageHasSafeExceptionHandlers
1919
- VC.Project.VCLinkerTool.CLRSupportLastError
2020
dev_langs:
21-
- VB
22-
- CSharp
2321
- C++
2422
helpviewer_keywords:
2523
- MSBuild (C++), Link task
@@ -31,6 +29,8 @@ ms.subservice: msbuild
3129
---
3230
# Link task
3331

32+
[!INCLUDE [C++-specific task](./includes/cpp-task.md)]
33+
3434
Wraps the Microsoft C++ linker tool, *link.exe*. The linker tool links Common Object File Format (COFF) object files and libraries to create an executable (*.exe*) file or a dynamic-link library (DLL). For more information, see [Linker options](/cpp/build/reference/linker-options) and [Use MSBuild from the command line](/cpp/build/msbuild-visual-cpp) and [Use the Microsoft C++ toolset from the command line](/cpp/build/building-on-the-command-line).
3535

3636
## Parameters

docs/msbuild/mt-task.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ ms.subservice: msbuild
2222
---
2323
# MT task
2424

25+
[!INCLUDE [C++-specific task](./includes/cpp-task.md)]
26+
2527
Wraps the Microsoft Manifest Tool, *mt.exe*. For more information, see [Mt.exe](/windows/desktop/SbsCs/mt-exe).
2628

2729
## Parameters

docs/msbuild/multitooltask-task.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,6 @@ ms.topic: reference
66
f1_keywords:
77
- vc.task.multitooltask
88
dev_langs:
9-
- VB
10-
- CSharp
11-
- C++
129
- C++
1310
helpviewer_keywords:
1411
- MSBuild (C++), MultiToolTask task
@@ -18,6 +15,8 @@ ms.author: ghogen
1815
---
1916
# MultiToolTask task
2017

18+
[!INCLUDE [C++-specific task](./includes/cpp-task.md)]
19+
2120
Experimental task that enables parallel execution of MIDL, CL, Clang, and FXC (hlsl). See [Improve parallelism in MSBuild](https://devblogs.microsoft.com/cppblog/improved-parallelism-in-msbuild/).
2221

2322
## Parameters

docs/msbuild/parallelcustombuild-task.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,6 @@ ms.topic: "reference"
66
f1_keywords:
77
- "vc.task.parallelcustombuild"
88
dev_langs:
9-
- "VB"
10-
- "CSharp"
11-
- "C++"
129
- "C++"
1310
helpviewer_keywords:
1411
- "MSBuild (C++), ParallelCustomBuild task"
@@ -18,6 +15,8 @@ ms.author: twhitney
1815
---
1916
# ParallelCustomBuild task
2017

18+
[!INCLUDE [C++-specific task](./includes/cpp-task.md)]
19+
2120
Run parallel instances of the [CustomBuild task](../msbuild/custombuild-task.md).
2221

2322
## Parameters

docs/msbuild/rc-task.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,6 @@ f1_keywords:
99
- "VC.Project.VCResourceCompilerTool.SuppressStartupBanner"
1010
- "VC.Project.VCResourceCompilerTool.NullTerminateStrings"
1111
dev_langs:
12-
- "VB"
13-
- "CSharp"
14-
- "C++"
1512
- "C++"
1613
helpviewer_keywords:
1714
- "RC task (MSBuild (C++))"
@@ -23,6 +20,8 @@ ms.subservice: msbuild
2320
---
2421
# RC task
2522

23+
[!INCLUDE [C++-specific task](./includes/cpp-task.md)]
24+
2625
Wraps the Microsoft Windows Resource Compiler tool, *rc.exe*. The **RC** task compiles resources, such as cursors, icons, bitmaps, dialog boxes, and fonts, into a resource (*.res*) file. For more information, see [Resource Compiler](/windows/desktop/menurc/resource-compiler).
2726

2827
## Parameters

docs/msbuild/setenv-task.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,6 @@ ms.topic: reference
66
f1_keywords:
77
- vc.task.setenv
88
dev_langs:
9-
- VB
10-
- CSharp
11-
- C++
129
- C++
1310
helpviewer_keywords:
1411
- MSBuild (C++), tasks
@@ -20,6 +17,8 @@ ms.subservice: msbuild
2017
---
2118
# SetEnv task
2219

20+
[!INCLUDE [C++-specific task](./includes/cpp-task.md)]
21+
2322
Sets or deletes the value of a specified environment variable.
2423

2524
## Parameters

docs/msbuild/trackedvctooltask-base-class.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ description: Learn about the parameters that the TrackedVCToolTask base class ad
44
ms.date: 03/10/2019
55
ms.topic: reference
66
dev_langs:
7-
- VB
8-
- CSharp
97
- C++
108
author: ghogen
119
ms.author: ghogen

docs/msbuild/vcmessage-task.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,6 @@ ms.topic: reference
66
f1_keywords:
77
- vc.task.vcmessage
88
dev_langs:
9-
- VB
10-
- CSharp
11-
- C++
129
- C++
1310
helpviewer_keywords:
1411
- VCMessage task (MSBuild (C++))
@@ -20,6 +17,8 @@ ms.subservice: msbuild
2017
---
2118
# VCMessage task
2219

20+
[!INCLUDE [C++-specific task](./includes/cpp-task.md)]
21+
2322
Logs warning and error messages during a build.
2423

2524
## Remarks

docs/msbuild/xdcmake-task.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,6 @@ ms.topic: "reference"
66
f1_keywords:
77
- "vc.task.xdcmake"
88
dev_langs:
9-
- "VB"
10-
- "CSharp"
11-
- "C++"
129
- "C++"
1310
helpviewer_keywords:
1411
- "XDCMake task (MSBuild (C++))"
@@ -20,6 +17,8 @@ ms.subservice: msbuild
2017
---
2118
# XDCMake task
2219

20+
[!INCLUDE [C++-specific task](./includes/cpp-task.md)]
21+
2322
Wraps the XML Documentation tool (*xdcmake.exe*), which merges XML document comment (*.xdc*) files into an *.xml* file.
2423

2524
An *.xdc* file is created when you provide documentation comments in your C++ source code and compile by using the [/doc](/cpp/build/reference/doc-process-documentation-comments-c-cpp) compiler option. For more information, see [XDCMake reference](/cpp/build/reference/xdcmake-reference), [XML Document Generator Tool property pages](/cpp/build/reference/xml-document-generator-tool-property-pages), and command-line help option (**/?**) for *xdcmake.exe*.

docs/msbuild/xsd-task.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@ f1_keywords:
88
- VC.Project.VCXMLDataGeneratorTool.Namespace
99
- VC.Project.VCXMLDataGeneratorTool.GenerateFromSchema
1010
dev_langs:
11-
- VB
12-
- CSharp
1311
- C++
1412
helpviewer_keywords:
1513
- XSD task (MSBuild (C++))
@@ -21,6 +19,8 @@ ms.subservice: msbuild
2119
---
2220
# XSD task
2321

22+
[!INCLUDE [C++-specific task](./includes/cpp-task.md)]
23+
2424
Wraps the XML Schema Definition tool (*xsd.exe*), which generates schema or class files from a source.
2525

2626
> [!NOTE]

0 commit comments

Comments
 (0)