Skip to content

Commit 50da76a

Browse files
authored
Merge branch 'master' into mb-morelinks
2 parents f3fd08c + 6a7bfe5 commit 50da76a

File tree

321 files changed

+790
-766
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

321 files changed

+790
-766
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ In this topic, you'll see the basic process for adding or updating content in th
77
In this topic, we'll cover:
88

99
* [Process for contributing](#process-for-contributing)
10-
* [Guidance checklist](#guidance-checklist)
10+
* [DOs and DON'Ts](#dos-and-donts)
1111
* [Building the docs](#building-the-docs)
1212
* [Contributing to samples](#contributing-to-samples)
13-
* [Contributor License Agreement](#contributor-license-agreement)
13+
* [Contributor license agreement](#contributor-license-agreement)
1414

1515
## Process for contributing
1616

@@ -19,7 +19,7 @@ The content inside the **docs** folder is organized into sections that are organ
1919

2020
You can skip this first step for small changes.
2121

22-
**Step 2:** Fork the `MicrosoftDocs/cpp-docs` repo.
22+
**Step 2:** Fork the `MicrosoftDocs/cpp-docs` repository.
2323

2424
**Step 3:** Create a `branch` for your article.
2525

@@ -30,17 +30,17 @@ If it's a new topic, you can use this [template file](./styleguide/template.md)
3030
Navigate to the folder that corresponds to the TOC location determined for your article in step 1.
3131
That folder contains the Markdown files for all articles in that section. If necessary, create a new folder to place the files for your content.
3232

33-
For images and other static resources, add them to the subfolder called **media**. If you are creating a new folder for content, add a media folder to the new folder.
33+
For images and other static resources, add them to the subfolder called `media`. If you are creating a new folder for content, add a media folder to the new folder.
3434

3535
Be sure to follow the proper Markdown syntax. See the [style guide](./styleguide/template.md) for more information.
3636

3737
### Example structure
3838

3939
docs
40-
/standard-library
41-
wstring-convert-class.md
42-
/media
43-
wstring-conversion.png
40+
/standard-library
41+
wstring-convert-class.md
42+
/media
43+
wstring-conversion.png
4444

4545
**Step 5:** Submit a Pull Request (PR) from your branch to `MicrosoftDocs/cpp-docs/master`.
4646

@@ -70,30 +70,28 @@ Below is a short list of guiding rules that you should keep in mind when you are
7070
7171
## Building the docs
7272

73-
The documentation is written in [GitHub Flavored Markdown](https://help.github.com/categories/writing-on-github/) and built using [DocFX](http://dotnet.github.io/docfx/) and other internal publishing/building tools. It is hosted at [docs.microsoft.com](https://docs.microsoft.com/).
73+
The documentation is written in [GitHub Flavored Markdown](https://help.github.com/categories/writing-on-github/) and built using [DocFX](https://dotnet.github.io/docfx/) and other internal publishing/building tools. It is hosted at [docs.microsoft.com](https://docs.microsoft.com/).
7474

7575
If you want to build the docs locally, you need to install [DocFX](https://dotnet.github.io/docfx/); latest versions are the best.
7676

77-
There are several ways to use DocFX, and most of them are covered in the [DocFX getting started guide](https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html).
78-
The following instructions use the [command-line based](https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html#2-use-docfx-as-a-command-line-tool) version of the tool.
79-
If you are comfortable with other ways listed on the link above, feel free to use those.
77+
There are several ways to use DocFX, and most of them are covered in the [DocFX getting started guide](https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html). The following instructions use the [command-line based](https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html#2-use-docfx-as-a-command-line-tool) version of the tool. If you are comfortable with other ways listed on the link above, feel free to use those.
8078

8179
**Note:** Currently DocFX requires the .NET Framework on Windows or Mono (for Linux or macOS). We hope to port it to .NET Core in the future.
8280

8381
You can build and preview the resulting site locally using a built-in web server. Navigate to the `cpp-docs\docs` folder on your machine and type the following command:
8482

85-
`docfx -t default --serve`
83+
> docfx -t default --serve
8684
8785
This starts the local preview on [localhost:8080](http://localhost:8080). You can then view the changes by going to `http://localhost:8080/[path]`, such as `http://localhost:8080/cpp/visual-cpp-in-visual-studio.html`.
8886

8987
**Note:** the local preview currently doesn't contain any themes at the moment so the look and feel won't be the same as in the documentation site. We're working towards fixing that experience. We also use some custom extensions for embedded video, notes, and included documents, that won't be visible in the preview.
9088

9189
## Contributing to samples
9290

93-
For now, include required sample code as inline code blocks in your article. The repo has a codesnippets folder, but this is not ready for public contributions.
91+
For now, include required sample code as inline code blocks in your article. The repository has a `codesnippets` folder, but this is not ready for public contributions.
9492

9593
## Contributor license agreement
9694

97-
You must sign the [Contribution License Agreement (CLA)](LICENSE) before your PR is merged. This is a one-time requirement for projects in docs.microsoft.com. You can read more about [Contribution License Agreements (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) on Uncyclopedia.
95+
You must sign the [Contribution License Agreement (CLA)](LICENSE) before your PR is merged. This is a one-time requirement for projects in docs.microsoft.com. You can read more about [Contribution License Agreements (CLA)](https://en.wikipedia.org/wiki/Contributor_License_Agreement) on Uncyclopedia.
9896

99-
You don't have to sign the agreement up-front. You can clone, fork, and submit your PR as usual. When your PR is created, it is classified by a CLA bot. If the change is trivial (for example, you fixed a typo), then the PR is labeled with cla-not-required. Otherwise, it's classified as cla-required. Once you signed the CLA, the current and all future pull requests are labeled as cla-signed.
97+
You don't have to sign the agreement up-front. You can clone, fork, and submit your PR as usual. When your PR is created, it is classified by a CLA bot. If the change is trivial (for example, you fixed a typo), then the PR is labeled with CLA-not-required. Otherwise, it's classified as CLA-required. Once you signed the CLA, the current and all future pull requests are labeled as CLA-signed.

README.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,18 @@
1-
## Microsoft Open Source Code of Conduct
2-
3-
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
4-
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
5-
61
# Visual Studio 2017 documentation for Visual C++
72

8-
Welcome! This repo contains source files for the work-in-progress Visual C++ technical documentation. The topics are published on the [Visual C++ documentation site](https://docs.microsoft.com/cpp).
3+
Welcome! This repository contains source files for the work-in-progress Visual C++ technical documentation. The topics are published on the [Visual C++ documentation site](https://docs.microsoft.com/cpp).
94

10-
This repo was moved from Microsoft/vcppdocs to MicrosoftDocs/cpp-docs-pr on June 23, 2017.
5+
This repository was moved from Microsoft/vcppdocs to MicrosoftDocs/cpp-docs-pr on June 23, 2017.
116

12-
The documentation for Visual Basic and Visual C# are located in a separate repo at [http://github.com/dotnet/core-docs](http://github.com/dotnet/core-docs), and the Visual Studio 2017 documentation is located in the repo located at [http://github.com/Microsoft/visualstudio-docs](http://github.com/Microsoft/visualstudio-docs).
7+
The documentation for Visual Basic and Visual C# are located in a separate repository at [http://github.com/dotnet/core-docs](http://github.com/dotnet/core-docs), and the Visual Studio 2017 documentation is located in the repository located at [http://github.com/Microsoft/visualstudio-docs](http://github.com/Microsoft/visualstudio-docs).
138

149
## Contributing to the documentation
1510

1611
To contribute to this documentation, please see the [Contributing guide](CONTRIBUTING.md).
1712
We welcome your contributions to help us improve the Visual C++ docs. All the articles in this repository use GitHub flavored markdown.
1813

19-
Several feature areas of Visual Studio have their own folders in this repo, such as **standard-library** for topics on the C++ Standard Library, **ide** for topics on the Visual Studio interactive development environment (IDE), and so forth. The **/media** subfolder in each folder contains art files for the topics. The [Contributing guide](CONTRIBUTING.md) has more information.
14+
Several feature areas of Visual Studio have their own folders in this repository, such as `standard-library` for topics on the C++ Standard Library, `ide` for topics on the Visual Studio interactive development environment (IDE), and so forth. The `/media` subfolder in each folder contains art files for the topics. The [Contributing guide](CONTRIBUTING.md) has more information.
15+
16+
## Microsoft Open Source Code of Conduct
2017

2118
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.

docs/assembler/inline/inline-assembler.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ ms.workload: ["cplusplus"]
1919
> [!NOTE]
2020
> Programs with inline assembler code are not fully portable to other hardware platforms. If you are designing for portability, avoid using inline assembler.
2121
22-
Inline assembly is not supported on the ARM and [!INCLUDE[vcprx64](../../assembler/inline/includes/vcprx64_md.md)] processors. The following topics explain how to use the Visual C/C++ inline assembler with x86 processors:
22+
Inline assembly is not supported on the ARM and x64 processors. The following topics explain how to use the Visual C/C++ inline assembler with x86 processors:
2323

2424
- [Inline Assembler Overview](../../assembler/inline/inline-assembler-overview.md)
2525

docs/assembler/masm/microsoft-macro-assembler-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The Microsoft Macro Assembler (MASM) provides several advantages over inline ass
3434
Provides links to websites that may contain programming information about processors that are not manufactured, sold, or supported by Microsoft.
3535

3636
[MASM for x64 (ml64.exe)](../../assembler/masm/masm-for-x64-ml64-exe.md)
37-
Information about how to create output files for [!INCLUDE[vcprx64](../../assembler/inline/includes/vcprx64_md.md)].
37+
Information about how to create output files for x64.
3838

3939
## Related Sections
4040
[Visual C++](../../visual-cpp-in-visual-studio.md)

docs/atl-mfc-shared/reference/csimplestringt-class.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -426,7 +426,7 @@ PXSTR GetBufferSetLength(int nLength);
426426
427427
The buffer memory is automatically freed when the `CSimpleStringT` object is destroyed.
428428
429-
If you keep track of the string length yourself, do not not append the terminating null character. You must specify the final string length when you release the buffer by using `ReleaseBuffer`. If you do append a terminating null character when you call `ReleaseBuffer`, pass -1 (the default) for the length to `ReleaseBuffer`, and `ReleaseBuffer` will perform a `strlen` on the buffer to determine its length.
429+
If you keep track of the string length yourself, do not append the terminating null character. You must specify the final string length when you release the buffer by using `ReleaseBuffer`. If you do append a terminating null character when you call `ReleaseBuffer`, pass -1 (the default) for the length to `ReleaseBuffer`, and `ReleaseBuffer` will perform a `strlen` on the buffer to determine its length.
430430
431431
For more information about reference counting, see the following articles:
432432

docs/atl/atl-com-property-pages.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ COM property pages provide a user interface for setting the properties (or calli
1818

1919
Each property page can be built completely independently of the objects whose properties can be set. All that a property page needs is to understand a particular interface (or set of interfaces) and to provide a user interface for calling methods on that interface.
2020

21-
For more information, see [Property Sheets and Property Pages](http://msdn.microsoft.com/library/windows/desktop/ms686577) in the [!INCLUDE[winSDK](../atl/includes/winsdk_md.md)].
21+
For more information, see [Property Sheets and Property Pages](http://msdn.microsoft.com/library/windows/desktop/ms686577) in the Windows SDK.
2222

2323
## In This Section
2424
[Specifying Property Pages](../atl/specifying-property-pages.md)

docs/atl/introduction-to-com-and-atl.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ This section provides a brief introduction to COM and ATL.
2323

2424
## Related Sections
2525
[The Component Object Model](http://msdn.microsoft.com/library/windows/desktop/ms694363)
26-
The [!INCLUDE[winSDK](../atl/includes/winsdk_md.md)] material on COM.
26+
The Windows SDK material on COM.
2727

2828
[ATL](../atl/active-template-library-atl-concepts.md)
2929
Provides links to conceptual topics on how to program using the Active Template Library.

docs/atl/reference/cwindow-class.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -818,7 +818,7 @@ DWORD GetHotKey() const throw();
818818
```
819819

820820
### Return Value
821-
The virtual key code and modifiers for the hot key associated with the window. For a list of possible modifiers, see [WM_GETHOTKEY](http://msdn.microsoft.com/library/windows/desktop/ms646278) in the Windows SDK. For a list of of standard virtual key codes, see Winuser.h.
821+
The virtual key code and modifiers for the hot key associated with the window. For a list of possible modifiers, see [WM_GETHOTKEY](http://msdn.microsoft.com/library/windows/desktop/ms646278) in the Windows SDK. For a list of standard virtual key codes, see Winuser.h.
822822

823823
## <a name="geticon"></a> CWindow::GetIcon
824824
Retrieves the handle to the window's large or small icon.
@@ -1933,7 +1933,7 @@ int SetHotKey(WORD wVirtualKeyCode, WORD wModifiers) throw();
19331933

19341934
### Parameters
19351935
*wVirtualKeyCode*
1936-
[in] The virtual key code of the hot key. For a list of of standard virtual key codes, see Winuser.h.
1936+
[in] The virtual key code of the hot key. For a list of standard virtual key codes, see Winuser.h.
19371937

19381938
*wModifiers*
19391939
[in] The modifiers of the hot key. For a list of possible values, see WM_SETHOTKEY in the Windows SDK.

docs/build/building-c-cpp-programs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ ms.workload: ["cplusplus"]
1414
---
1515
# Building C/C++ Programs
1616

17-
You can build Visual C++ projects either in Visual Studio or on the command line. The Visual Studio IDE uses [MSBuild](../build/msbuild-visual-cpp.md) to build projects and solutions. On the command line, you can use the C/C++ compiler (cl.exe) and linker (link.exe) to build simple projects. To build more complex projects on the command line, you can use MSBuild or [NMAKE](../build/nmake-reference.md). For an overview about how to use [!INCLUDE[vsprvs](../assembler/masm/includes/vsprvs_md.md)] to build projects and solutions, see [Compiling and Building](/visualstudio/ide/compiling-and-building-in-visual-studio).
17+
You can build Visual C++ projects either in Visual Studio or on the command line. The Visual Studio IDE uses [MSBuild](../build/msbuild-visual-cpp.md) to build projects and solutions. On the command line, you can use the C/C++ compiler (cl.exe) and linker (link.exe) to build simple projects. To build more complex projects on the command line, you can use MSBuild or [NMAKE](../build/nmake-reference.md). For an overview about how to use Visual Studio to build projects and solutions, see [Compiling and Building](/visualstudio/ide/compiling-and-building-in-visual-studio).
1818

1919
## In This Section
2020

docs/build/common-visual-cpp-arm-migration-issues.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ On the ARM architecture, parameters from the variable arguments list that are pa
6464
printf("%d\n", 1LL);
6565
```
6666
67-
In this case, the bug can be fixed by making sure that the correct format specification is used so that that the alignment of the argument is considered. This code is correct:
67+
In this case, the bug can be fixed by making sure that the correct format specification is used so that the alignment of the argument is considered. This code is correct:
6868
6969
```C
7070
// CORRECT: use %I64d for 64-bit integers

docs/build/configuring-programs-for-windows-xp.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ To get the platform toolset and components to target [!INCLUDE[winxp](../build/i
1919

2020
## Windows XP targeting experience
2121

22-
The Windows XP platform toolset that's included in Visual Studio is a version of the [!INCLUDE[win7](../build/includes/win7_md.md)] SDK, but it uses the current C++ compiler. It also configures project properties to appropriate default values, for example, the specification of a compatible linker for down-level targeting. Only Windows desktop apps that are created by using a Windows XP platform toolset run on [!INCLUDE[winxp](../build/includes/winxp_md.md)] and [!INCLUDE[WinXPSvr](../build/includes/winxpsvr_md.md)], but those apps can also run on more recent Windows operating systems.
22+
The Windows XP platform toolset that's included in Visual Studio is a version of the Windows 7 SDK, but it uses the current C++ compiler. It also configures project properties to appropriate default values, for example, the specification of a compatible linker for down-level targeting. Only Windows desktop apps that are created by using a Windows XP platform toolset run on [!INCLUDE[winxp](../build/includes/winxp_md.md)] and [!INCLUDE[WinXPSvr](../build/includes/winxpsvr_md.md)], but those apps can also run on more recent Windows operating systems.
2323

2424
#### To target Windows XP
2525

@@ -59,7 +59,7 @@ Due to differences in platform and library support, the development experience f
5959

6060
- **Static analysis**
6161

62-
The Windows XP platform toolsets don't support static analysis because the SAL annotations for the [!INCLUDE[win7](../build/includes/win7_md.md)] SDK and the runtime libraries are incompatible. When you want to perform static analysis on an app that supports [!INCLUDE[winxp](../build/includes/winxp_md.md)] or [!INCLUDE[WinXPSvr](../build/includes/winxpsvr_md.md)], you can temporarily switch the solution to target the default platform toolset to perform the analysis, and then switch back to the Windows XP platform toolset to build the app.
62+
The Windows XP platform toolsets don't support static analysis because the SAL annotations for the Windows 7 SDK and the runtime libraries are incompatible. When you want to perform static analysis on an app that supports [!INCLUDE[winxp](../build/includes/winxp_md.md)] or [!INCLUDE[WinXPSvr](../build/includes/winxpsvr_md.md)], you can temporarily switch the solution to target the default platform toolset to perform the analysis, and then switch back to the Windows XP platform toolset to build the app.
6363

6464
- **Debugging of DirectX graphics**
6565

docs/build/dynamic-parameter-stack-area-construction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ms.author: "corob"
1111
ms.workload: ["cplusplus"]
1212
---
1313
# Dynamic Parameter Stack Area Construction
14-
If a frame pointer is used, the option exists to dynamically create the parameter stack area. This is not currently done in the [!INCLUDE[vcprx64](../assembler/inline/includes/vcprx64_md.md)] compiler.
14+
If a frame pointer is used, the option exists to dynamically create the parameter stack area. This is not currently done in the x64 compiler.
1515

1616
## See Also
1717
[Stack Usage](../build/stack-usage.md)

docs/build/exception-handling-x64.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ms.author: "corob"
1212
ms.workload: ["cplusplus"]
1313
---
1414
# Exception Handling (x64)
15-
This section discusses structured exception handling and C++ exception handling behavior on the [!INCLUDE[vcprx64](../assembler/inline/includes/vcprx64_md.md)].
15+
This section discusses structured exception handling and C++ exception handling behavior on the x64.
1616

1717
- [Unwind Data for Exception Handling, Debugger Support](../build/unwind-data-for-exception-handling-debugger-support.md)
1818

0 commit comments

Comments
 (0)