Skip to content

Repo sync for protected CLA branch #8477

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 17 commits into from
Sep 19, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/ide/how-to-view-save-and-configure-build-log-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: 'How to: View, save, and configure build log files | Microsoft Docs'
description: Learn how you can view, save, and configure build log files. These files provide useful information for tasks like troubleshooting a build failure.
ms.custom: SEO-VS-2020
ms.date: 08/28/2019
ms.date: 09/12/2022
ms.technology: vs-ide-compile
ms.topic: how-to
ms.assetid: 75d38b76-26d6-4f43-bbe7-cbacd7cc81e7
Expand All @@ -18,7 +18,7 @@ ms.workload:

After you build a project in the Visual Studio IDE, you can view information about that build in the **Output** window. By using this information, you can, for example, troubleshoot a build failure.

- For C++ projects, you can also view the same information in a log file that's created and saved when you build a project.
- For C++ projects, you can also view the same information in a log file that's created and saved when you build a project.

- For managed code projects, you can click in the build output window and press **Ctrl**+**S**. Visual Studio prompts you for a location to save the information from the **Output** window into a log file.

Expand All @@ -28,7 +28,7 @@ If you build any kind of project by using MSBuild, you can create a log file to

## To view the build log file for a C++ project

1. In **Windows Explorer** or **File Explorer**, open the following file (relative to the project root folder): *Release*\\{ProjectName}.Log* or *Debug\\{ProjectName}.log*
1. In **Windows Explorer** or **File Explorer**, open the following file (relative to the project root folder): *Release\\{ProjectName}.Log* or *Debug\\{ProjectName}.log*

## To create a build log file for a managed-code project

Expand Down
46 changes: 33 additions & 13 deletions docs/msbuild/customize-your-build.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ The location of the solution file is irrelevant to *Directory.Build.props*.

Properties that are set in *Directory.Build.props* can be overridden elsewhere in the project file or in imported files, so you should think of the settings in *Directory.Build.props* as specifying the defaults for your projects.

*Directory.Build.targets* is imported from *Microsoft.Common.targets* after importing *.targets* files from NuGet packages. So, it can override properties and targets defined in most of the build logic, or set properties for all your projects regardless of what the individual projects set.
*Directory.Build.targets* is imported from *Microsoft.Common.targets* after importing `.targets` files from NuGet packages. So, it can override properties and targets defined in most of the build logic, or set properties for all your projects regardless of what the individual projects set.

When you need to set a property or define a target for an individual project that overrides any prior settings, put that logic in the project file after the final import. In order to do this in an SDK-style project, you first have to replace the SDK-style attribute with the equivalent imports. See [How to use MSBuild project SDKs](how-to-use-project-sdk.md).

Expand Down Expand Up @@ -114,29 +114,29 @@ Or more simply: the first *Directory.Build.props* that doesn't import anything i

MSBuild is import-order dependent, and the last definition of a property (or a `UsingTask` or target) is the definition used.

When using explicit imports, you can import from a *.props* or *.targets* file at any point. Here is the widely used convention:
When using explicit imports, you can import from a `.props` or `.targets` file at any point. Here is the widely used convention:

- *.props* files are imported early in the import order.
- `.props` files are imported early in the import order.

- *.targets* files are imported late in the build order.
- `.targets` files are imported late in the build order.

This convention is enforced by `<Project Sdk="SdkName">` imports (that is, the import of *Sdk.props* comes first, before all of the contents of the file, then *Sdk.targets* comes last, after all of the contents of the file).

When deciding where to put the properties, use the following general guidelines:

- For many properties, it doesn't matter where they're defined, because they're not overwritten and will be read only at execution time.

- For behavior that might be customized in an individual project, set defaults in *.props* files.
- For behavior that might be customized in an individual project, set defaults in `.props` files.

- Avoid setting dependent properties in *.props* files by reading the value of a possibly customized property, because the customization won't happen until MSBuild reads the user's project.
- Avoid setting dependent properties in `.props` files by reading the value of a possibly customized property, because the customization won't happen until MSBuild reads the user's project.

- Set dependent properties in *.targets* files, because they'll pick up customizations from individual projects.
- Set dependent properties in `.targets` files, because they'll pick up customizations from individual projects.

- If you need to override properties, do it in a *.targets* file, after all user-project customizations have had a chance to take effect. Be cautious when using derived properties; derived properties may need to be overridden as well.
- If you need to override properties, do it in a `.targets` file, after all user-project customizations have had a chance to take effect. Be cautious when using derived properties; derived properties may need to be overridden as well.

- Include items in *.props* files (conditioned on a property). All properties are considered before any item, so user-project property customizations get picked up, and this gives the user's project the opportunity to `Remove` or `Update` any item brought in by the import.
- Include items in `.props` files (conditioned on a property). All properties are considered before any item, so user-project property customizations get picked up, and this gives the user's project the opportunity to `Remove` or `Update` any item brought in by the import.

- Define targets in *.targets* files. However, if the *.targets* file is imported by an SDK, remember that this scenario makes overriding the target more difficult because the user's project doesn't have a place to override it by default.
- Define targets in `.targets` files. However, if the `.targets` file is imported by an SDK, remember that this scenario makes overriding the target more difficult because the user's project doesn't have a place to override it by default.

- If possible, prefer customizing properties at evaluation time over changing properties inside a target. This guideline makes it easier to load a project and understand what it's doing.

Expand Down Expand Up @@ -190,6 +190,26 @@ If you need different behaviors depending on the .NET language (C#, Visual Basic
</PropertyGroup>
```

## Handle generated files

In any given build, files that get generated during the build behave differently from static files (such as source files). For this reason, it's important to understand [How MSBuild Builds Projects](build-process-overview.md). The two phases are the [evaluation phase](build-process-overview.md#evaluation-phase) and the [execution phase](build-process-overview.md#execution-phase). During the evaluation phase, MSBuild reads your project, imports everything, creates properties, expands globs for items, and sets up the build process. During the execution phase, MSBuild performs the build by running targets and tasks with the data it parsed during the evaluation phase.

Files generated during execution don't exist during the evaluation phase, therefore they aren't included in the build process. To solve this problem, you must manually add the generated files into the build process. The recommended way to do this is by adding the new file to the `Content` or `None` items before the `BeforeBuild` target, as in the following example:

```xml
<Target Name="MyTarget" BeforeTargets="BeforeBuild">

<!-- Some logic that generates your file goes here -->
<!-- Generated files should be placed in $(IntermediateOutputPath) -->

<ItemGroup>
<None Include="$(IntermediateOutputPath)my-generated-file.xyz" CopyToOutputDirectory="PreserveNewest"/>
</ItemGroup>
</Target>
```

Adding your generated file to `None` or `Content` is sufficient for the build process to see it. You also want to ensure it gets added at the right time. Ideally, your target runs before `BeforeBuild`. `AssignTargetPaths` is another possible target, as it is the final opportunity to modify `None` and `Content` items (among others) before they are transformed into new items. See [Common Item Types](common-msbuild-project-items.md).

## Customize the solution build

> [!IMPORTANT]
Expand Down Expand Up @@ -245,17 +265,17 @@ If you have a dedicated build server and want to ensure that certain targets alw

## Customize C++ builds

For C++ projects, the previously mentioned custom *.targets* and *.props* files cannot be used in the same way to override default settings. *Directory.Build.props* is imported by *Microsoft.Common.props*, which is imported in `Microsoft.Cpp.Default.props` while most of the defaults are defined in *Microsoft.Cpp.props* and for a number of properties a "if not yet defined" condition cannot be used, as the property is already defined, but the default needs to be different for particular project properties defined in `PropertyGroup` with `Label="Configuration"` (see [.vcxproj and .props file structure](/cpp/build/reference/vcxproj-file-structure)).
For C++ projects, the previously mentioned custom `.targets` and `.props` files cannot be used in the same way to override default settings. *Directory.Build.props* is imported by *Microsoft.Common.props*, which is imported in `Microsoft.Cpp.Default.props` while most of the defaults are defined in *Microsoft.Cpp.props* and for a number of properties a "if not yet defined" condition cannot be used, as the property is already defined, but the default needs to be different for particular project properties defined in `PropertyGroup` with `Label="Configuration"` (see [.vcxproj and .props file structure](/cpp/build/reference/vcxproj-file-structure)).

But, you can use the following properties to specify *.props* file(s) to be automatically imported before/after *Microsoft.Cpp.\** files:
But, you can use the following properties to specify `.props` file(s) to be automatically imported before/after *Microsoft.Cpp.\** files:

- ForceImportAfterCppDefaultProps
- ForceImportBeforeCppProps
- ForceImportAfterCppProps
- ForceImportBeforeCppTargets
- ForceImportAfterCppTargets

To customize the default values of properties for all C++ builds, create another *.props* file (say, *MyProps.props*), and define the `ForceImportAfterCppProps` property in `Directory.Build.props` pointing to it:
To customize the default values of properties for all C++ builds, create another `.props` file (say, *MyProps.props*), and define the `ForceImportAfterCppProps` property in `Directory.Build.props` pointing to it:

```xml
<PropertyGroup>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: MSBuild Target Framework and Target Platform | Microsoft Docs
description: Learn how to build an MSBuild project to run on a target .NET Framework version, and a target platform or software architecture.
ms.custom: SEO-VS-2020
ms.date: 11/04/2016
ms.date: 09/12/2022
ms.topic: conceptual
ms.assetid: df6517c5-edd6-4cc4-97ad-b3cdfc78e799
author: ghogen
Expand Down
6 changes: 3 additions & 3 deletions docs/msbuild/target-build-order.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Target Build Order | Microsoft Docs
description: Learn how to specify the order in which MSBuild targets are run, if the input to one target depends on the output of another target.
ms.custom: SEO-VS-2020
ms.date: 05/02/2019
ms.date: 09/12/2022
ms.topic: conceptual
helpviewer_keywords:
- msbuild, build order
Expand All @@ -25,7 +25,7 @@ Targets must be ordered if the input to one target depends on the output of anot

- `DependsOnTargets`. This `Target` attribute specifies targets that must run before this target can run.

- `BeforeTargets` and `AfterTargets`. These `Target` attributes specify that this target should run before or after the specified targets (MSBuild 4.0).
- `BeforeTargets` and `AfterTargets`. These `Target` attributes specify that this target should run before or after the specified targets.

A target is never run twice during a build, even if a subsequent target in the build depends on it. Once a target has been run, its contribution to the build is complete.

Expand Down Expand Up @@ -81,7 +81,7 @@ tells MSBuild that the `Serve` target depends on the `Chop` target and the `Cook

## BeforeTargets and AfterTargets

In MSBuild 4.0 and later, you can specify target order by using the `BeforeTargets` and `AfterTargets` attributes.
You can specify target order by using the `BeforeTargets` and `AfterTargets` attributes.

Consider the following script.

Expand Down
Loading