Skip to content

Commit 4f0e521

Browse files
author
Colin Robertson
authored
Remove missing X-plat property page links, lint for md, remove f1 thieves (MicrosoftDocs#493)
* Remove missing link, lint for md, remove f1 thieves * reinstated some keywords that are unique to Linux
1 parent c90fd0e commit 4f0e521

11 files changed

+278
-259
lines changed

docs/ide/general-property-page-file.md

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -17,21 +17,23 @@ manager: "ghogen"
1717
ms.workload: ["cplusplus"]
1818
---
1919
# General Property Page (File)
20-
When a file is selected in **Solution Explorer**, the **General** property page under the **Configuration Properties** node contains the following properties:
21-
22-
**Exclude From Build**
23-
Specifies whether the file should be in the build for the current configuration.
24-
25-
To programmatically access this property, see <xref:Microsoft.VisualStudio.VCProjectEngine.VCFileConfiguration.ExcludedFromBuild%2A>.
26-
27-
**Tool**
28-
The tool that will be used to build this file. See [Specifying Custom Build Tools](../ide/specifying-custom-build-tools.md) for more information.
29-
30-
To programmatically access this property, see <xref:Microsoft.VisualStudio.VCProjectEngine.VCFileConfiguration.Tool%2A>.
31-
32-
For information on how to access the **General** property page under the **Configuration Properties** node, see [Working with Project Properties](../ide/working-with-project-properties.md).
33-
34-
For non-Windows projects, see [Linux C++ Property Page Reference](../linux/prop-pages-linux.md) or [C++ Cross Platform Property Page Reference](../linux/prop-pages-linux.md).
35-
36-
## See Also
37-
[Property Pages](../ide/property-pages-visual-cpp.md)
20+
21+
When a file is selected in **Solution Explorer**, the **General** property page under the **Configuration Properties** node contains the following properties:
22+
23+
**Exclude From Build**
24+
Specifies whether the file should be in the build for the current configuration.
25+
26+
To programmatically access this property, see <xref:Microsoft.VisualStudio.VCProjectEngine.VCFileConfiguration.ExcludedFromBuild%2A>.
27+
28+
**Tool**
29+
The tool that will be used to build this file. See [Specifying Custom Build Tools](../ide/specifying-custom-build-tools.md) for more information.
30+
31+
To programmatically access this property, see <xref:Microsoft.VisualStudio.VCProjectEngine.VCFileConfiguration.Tool%2A>.
32+
33+
For information on how to access the **General** property page under the **Configuration Properties** node, see [Working with Project Properties](../ide/working-with-project-properties.md).
34+
35+
For non-Windows projects, see [Linux C++ Property Page Reference](../linux/prop-pages-linux.md)<!-- or [C++ Cross Platform Property Page Reference](../linux/prop-pages-linux.md)-->.
36+
37+
## See also
38+
39+
[Property Pages](../ide/property-pages-visual-cpp.md)

docs/ide/general-property-page-project.md

Lines changed: 109 additions & 107 deletions
Large diffs are not rendered by default.

docs/ide/property-pages-visual-cpp.md

Lines changed: 111 additions & 107 deletions
Large diffs are not rendered by default.

docs/linux/prop-pages/build-events-linux.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,13 @@ ms.assetid: 165d3690-5bd8-4b0b-bc66-8b699d85a61b
1111
author: "mikeblome"
1212
ms.author: "mblome"
1313
manager: "ghogen"
14-
f1_keywords: [VC.Project.IVCEventTool.CommandLine, VC.Project.IVCEventTool.Description, VC.Project.IVCEventTool.ExcludedFromBuild, VC.Project.VCConfiguration.BuildLogFile]
14+
#f1_keywords: [VC.Project.IVCEventTool.CommandLine, VC.Project.IVCEventTool.Description, VC.Project.IVCEventTool.ExcludedFromBuild, VC.Project.VCConfiguration.BuildLogFile]
1515
ms.workload: ["cplusplus", "linux"]
1616
---
17-
1817
# Build Event Properties (Linux C++)
1918

20-
2119
## Pre-Build Event
20+
2221
Property | Description
2322
--- | ---
2423
Command Line | Specifies a command line for the pre-build event tool to run.
@@ -27,6 +26,7 @@ Use In Build | Specifies whether this build event is excluded from the build for
2726
Additional files to copy | Specifies additional files to copy to the remote system. Optionally the list can be provided as a local to remote mapping pairs using a syntax like this: fulllocalpath1:=fullremotepath1;fulllocalpath2:=fullremotepath2, where a local file can be copied to the specified remote location on the remote system.
2827

2928
## Pre-Link Event
29+
3030
Property | Description
3131
--- | ---
3232
Command Line | Specifies a command line for the pre-link event tool to run.
@@ -35,6 +35,7 @@ Use In Build | Specifies whether this build event is excluded from the build for
3535
Additional files to copy | Specifies additional files to copy to the remote system. Optionally the list can be provided as a local to remote mapping pairs using a syntax like this: fulllocalpath1:=fullremotepath1;fulllocalpath2:=fullremotepath2, where a local file can be copied to the specified remote location on the remote system.
3636

3737
## Post-Build Event
38+
3839
Property | Description
3940
--- | ---
4041
Command Line | Specifies a command line for the post-build event tool to run.
@@ -43,6 +44,7 @@ Use In Build | Specifies whether this build event is excluded from the build for
4344
Additional files to copy | Specifies additional files to copy to the remote system. Optionally the list can be provided as a local to remote mapping pairs using a syntax like this: fulllocalpath1:=fullremotepath1;fulllocalpath2:=fullremotepath2, where a local file can be copied to the specified remote location on the remote system.
4445

4546
## Remote Pre-Build Event
47+
4648
Property | Description
4749
--- | ---
4850
Command Line | Specifies a command line for the pre-build event tool to run on the remote system.
@@ -51,6 +53,7 @@ Use In Build | Specifies whether this build event is excluded from the build for
5153
Additional files to copy | Specifies additional files to copy from the remote system. Optionally the list can be provided as a remote to local mapping pairs using a syntax like this: fullremotepath1:=fulllocalpath1;fullremotepath2:=fulllocalpath2, where a remote file can be copied to the specified location on the local machine.
5254

5355
## Remote Pre-Link Event
56+
5457
Property | Description
5558
--- | ---
5659
Command Line | Specifies a command line for the pre-link event tool to run on the remote system.
@@ -59,6 +62,7 @@ Use In Build | Specifies whether this build event is excluded from the build for
5962
Additional files to copy | Specifies additional files to copy from the remote system. Optionally the list can be provided as a remote to local mapping pairs using a syntax like this: fullremotepath1:=fulllocalpath1;fullremotepath2:=fulllocalpath2, where a remote file can be copied to the specified location on the local machine.
6063

6164
## Remote Post-Build Event
65+
6266
Property | Description
6367
--- | ---
6468
Command Line | Specifies a command line for the post-build event tool to run on the remote system.

docs/linux/prop-pages/copy-sources-project.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ ms.assetid: 1a44230d-5dd8-4d33-93b4-e77e03e00150
1111
author: "mikeblome"
1212
ms.author: "mblome"
1313
manager: "ghogen"
14-
f1_keywords: [VC.Project.VCConfiguration.BuildLogFile]
14+
#f1_keywords: [VC.Project.VCConfiguration.BuildLogFile]
1515
ms.workload: ["cplusplus", "linux"]
1616
---
17-
1817
# Copy Sources Project Properties (Linux C++)
18+
1919
The properties set on this property page apply to all files in the project except whose file-level properties are set.
2020

2121
Property | Description

docs/linux/prop-pages/custom-build-step-linux.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,11 @@ ms.assetid: 77a9c1fb-7c41-4a9b-9418-18ac17ce4e74
1111
author: "mikeblome"
1212
ms.author: "mblome"
1313
manager: "ghogen"
14-
f1_keywords: [VC.Project.IVCEventTool.CommandLine, VC.Project.IVCEventTool.Description, VC.Project.IVCEventTool.ExcludedFromBuild, VC.Project.VCConfiguration.BuildLogFile]
14+
#f1_keywords: [VC.Project.IVCEventTool.CommandLine, VC.Project.IVCEventTool.Description, VC.Project.IVCEventTool.ExcludedFromBuild, VC.Project.VCConfiguration.BuildLogFile]
1515
ms.workload: ["cplusplus", "linux"]
1616
---
17-
1817
# Custom Build Step Properties (Linux C++)
1918

20-
2119
Property | Description
2220
--- | ---
2321
Command Line | The command to be executed by the custom build step.

docs/linux/prop-pages/debugging-linux.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,9 @@ ms.assetid: 0c1c0fcc-a49b-451c-a5cb-ce9711fac064
1111
author: "mikeblome"
1212
ms.author: "mblome"
1313
manager: "ghogen"
14-
f1_keywords: [VC.Project.RaspberryDebugger.DebuggerType, VC.Project.IVCLocalDebugPageObject.CommandArguments, VC.Project.IVCLocalDebugPageObject.WorkingDirectory, VC.Project.RaspberryDebugger.LaunchActivity, VC.Project.LinuxDebugger.DebugChildProcesses]
14+
#f1_keywords: [VC.Project.RaspberryDebugger.DebuggerType, VC.Project.RaspberryDebugger.LaunchActivity, VC.Project.LinuxDebugger.DebugChildProcesses]
1515
ms.workload: ["cplusplus", "linux"]
1616
---
17-
1817
# C++ Debugging Properties (Linux C++)
1918

2019
Property | Description | Choices
@@ -31,4 +30,4 @@ Additional Symbol Search Paths | Additional search path for debug symbols (solib
3130
Debug Child Processes | Specifies whether to enable debugging of child processes.
3231
Enable Python Pretty Printing | Enable pretty printing of expression values. Only supported in gdb debugging mode.
3332
Visualization File | Default native visualization file (.natvis) containing visualization directives for SLT types. Other .natvis files that belong to the current solution will be loaded automatically.
34-
Additional Sources File Path Map | Additional path equivalences for the debugger to use to map Windows source file names to Linux source file names. The format is "\<windows-path>=\<linux-path>;...". A source file name found under the Windows path will be referenced as if is has been found in the same relative position under the Linux path. Files found in the local project do not require additional mapping.
33+
Additional Sources File Path Map | Additional path equivalences for the debugger to use to map Windows source file names to Linux source file names. The format is "\<windows-path>=\<linux-path>;...". A source file name found under the Windows path will be referenced as if is has been found in the same relative position under the Linux path. Files found in the local project do not require additional mapping.

docs/linux/prop-pages/directories-linux.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,9 @@ ms.assetid: 12d45b93-0a5c-455e-b12a-9b9aad9a6d6c
1111
author: "mikeblome"
1212
ms.author: "mblome"
1313
manager: "ghogen"
14-
f1_keywords: [VC.Project.VCDirectories.IncludePath, VC.Project.VCDirectories.LibraryPath, VC.Project.VCDirectories.SourcePath, VC.Project.VCDirectories.ExcludePath]
14+
#f1_keywords: [VC.Project.VCDirectories.IncludePath, VC.Project.VCDirectories.LibraryPath, VC.Project.VCDirectories.SourcePath, VC.Project.VCDirectories.ExcludePath]
1515
ms.workload: ["cplusplus", "linux"]
1616
---
17-
1817
# VC++ Directories (Linux C++)
1918

2019
Property | Description

docs/linux/prop-pages/general-linux.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,9 @@ ms.assetid: 56c800a9-3df9-4196-87b2-81adb00e4767
1111
author: "mikeblome"
1212
ms.author: "mblome"
1313
manager: "ghogen"
14-
f1_keywords: [VC.Project.VCConfiguration.OutputDirectory, VC.Project.VCConfiguration.IntermediateDirectory, VC.Project.VCConfiguration.TargetName, VC.Project.VCConfiguration.TargetExt, VC.Project.VCConfiguration.DeleteExtensionsOnClean, VC.Project.VCConfiguration.PlatformToolset, VC.Project.VCConfiguration.BuildLogFile, VC.Project.VCConfiguration.ConfigurationType, VC.Project.VCConfiguration.UseOfSTL]
14+
#f1_keywords: [VC.Project.VCConfiguration.OutputDirectory, VC.Project.VCConfiguration.IntermediateDirectory, VC.Project.VCConfiguration.TargetName, VC.Project.VCConfiguration.TargetExt, VC.Project.VCConfiguration.DeleteExtensionsOnClean, VC.Project.VCConfiguration.PlatformToolset, VC.Project.VCConfiguration.BuildLogFile, VC.Project.VCConfiguration.ConfigurationType, VC.Project.VCConfiguration.UseOfSTL]
1515
ms.workload: ["cplusplus", "linux"]
1616
---
17-
1817
# General Properties (Linux C++)
1918

2019
Property | Description | Choices

docs/linux/prop-pages/linker-linux.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ ms.assetid: a0243a94-8164-425b-b2fe-b84ff363d546
1111
author: "mikeblome"
1212
ms.author: "mblome"
1313
manager: "ghogen"
14-
f1_keywords: [VC.Project.VCLinkerTool.OutputFile, VC.Project.VCLinkerTool.ShowProgress, VC.Project.VCLinkerTool.Version, VC.Project.VCLinkerTool.VerboseOutput, VC.Project.VCLinkerTool.UnresolvedReferences, VC.Project.VCLinkerTool.OptimizeForMemory, VC.Project.VCLinkerTool.SharedLibrarySearchPath, VC.Project.VCLinkerTool.AdditionalLibraryDirectories, VC.Project.VCConfiguration.BuildLogFile, VC.Project.VCLinkerTool.IgnoreDefaultLibraryNames, VC.Project.VCLinkerTool.ForceSymbolReferences, VC.Project.VCLinkerTool.LibraryDependencies, VC.Project.VCLinkerTool.ForceFileOutput, VC.Project.VCLinkerTool.GenerateMapFile, VC.Project.VCLinkerTool.Relocation, VC.Project.VCLinkerTool.FunctionBinding, VC.Project.VCLinkerTool.NoExecStackRequired, VC.Project.WholeArchive, VC.Project.AdditionalOptionsPage, VC.Project.VCLinkerTool.AdditionalDependencies]
14+
#f1_keywords: [VC.Project.VCLinkerTool.OutputFile, VC.Project.VCLinkerTool.ShowProgress, VC.Project.VCLinkerTool.Version, VC.Project.VCLinkerTool.VerboseOutput, VC.Project.VCLinkerTool.UnresolvedReferences, VC.Project.VCLinkerTool.OptimizeForMemory, VC.Project.VCLinkerTool.SharedLibrarySearchPath, VC.Project.VCLinkerTool.AdditionalLibraryDirectories, VC.Project.VCConfiguration.BuildLogFile, VC.Project.VCLinkerTool.IgnoreDefaultLibraryNames, VC.Project.VCLinkerTool.ForceSymbolReferences, VC.Project.VCLinkerTool.LibraryDependencies, VC.Project.VCLinkerTool.ForceFileOutput, VC.Project.VCLinkerTool.GenerateMapFile, VC.Project.VCLinkerTool.Relocation, VC.Project.VCLinkerTool.FunctionBinding, VC.Project.VCLinkerTool.NoExecStackRequired, VC.Project.WholeArchive, VC.Project.AdditionalOptionsPage, VC.Project.VCLinkerTool.AdditionalDependencies]
1515
ms.workload: ["cplusplus", "linux"]
1616
---
17-
1817
# Linker Properties (Linux C++)
1918

2019
## General
20+
2121
Property | Description | Choices
2222
--- | ---| ---
2323
Output File | The option overrides the default name and location of the program that the linker creates. (-o)
@@ -36,6 +36,7 @@ Link Timeout | Remote linking timeout, in milliseconds.
3636
Copy Output | Specifies whether to copy the build output file from the remote system to the local machine.
3737

3838
## Input
39+
3940
Property | Description | Choices
4041
--- | ---| ---
4142
Ignore Specific Default Libraries | Specifies one or more names of default libraries to ignore. (--exclude-libs lib,lib)
@@ -45,21 +46,17 @@ Library Dependencies | This option allows specifying additional libraries to be
4546
Additional Dependencies | Specifies additional items to add to the link command line.
4647

4748
## Debugging
49+
4850
Property | Description | Choices
4951
--- | ---| ---
5052
Debugger Symbol Information | Debugger symbol information from the output file. | **Include All**<br>**Omit Debugger Symbol Information Only**<br>**Omit All Symbol Information**<br>
5153
Map File Name | The Map option tells the linker to create a map file with the user specified name. (-Map=)
5254

5355
## Advanced
56+
5457
Property | Description | Choices
5558
--- | ---| ---
5659
Mark Variables ReadOnly After Relocation | This option marks variables read-only after relocation.
5760
Enable Immediate Function Binding | This option marks object for immediate function binding.
5861
Do Not Require Executable Stack | This option marks output as not requiring executable stack.
5962
Whole Archive | Whole Archive uses all code from Sources and Additional Dependencies.
60-
61-
62-
## Additional Options
63-
64-
65-

0 commit comments

Comments
 (0)