Skip to content

Commit 695f298

Browse files
openpublishbuildColin Robertson
authored andcommitted
Confirm merge from FromPublicMasterBranch to master to sync with https://github.com/MicrosoftDocs/cpp-docs (branch master) (#335)
* Update random.md Fix broken fwlink to presentation on rand * Update arm-assembler-reference.md Point to search engine to pick up latest results for ARM references on the ARM Developer Center. * Update desktop-applications-visual-cpp.md Fix space issue * 📦 Enable PDF generation. * zc-conformance.md: rvalueCast is off by default rvalueCast is off by default according to the https://docs.microsoft.com/en-us/cpp/build/reference/zc-rvaluecast-enforce-type-conversion-rules * Fix bad merge in storage-classes-cpp Had merge conflict markers * Update .openpublishing.publish.config.json * Fix typographical error The fix is for the file docs/windows/desktop-applications-visual-cpp.md and adds the missing word "that" to a sentence. * Correct .ERRDIF[[I]] title * Fixed indentation * Replace nonsense with correct statement Replace nonsense with correct statement * Update read.md Fix some more formatting while we're at it. * Correct build working directory * Order link option alphabetically Orders link option CLRUNMANAGEDCODECHECK alphabetically in the table of contents for consistency. * Updating timestamp Worth getting this right, since otherwise it doesn't look like this page covers 15.3 (and it does!) * Update cl-environment-variables.md Line 65, fixed spelling of "setting". * Update CONTRIBUTING.md
1 parent 9d7d356 commit 695f298

12 files changed

Lines changed: 110 additions & 107 deletions

File tree

Lines changed: 56 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,56 @@
1-
{
2-
"build_entry_point": "docs",
3-
"need_generate_pdf": false,
4-
"need_generate_intellisense": false,
5-
"branch_target_mapping": {
6-
"live": [
7-
"Publish",
8-
"Pdf"
9-
],
10-
"master": [
11-
"Publish",
12-
"Pdf"
13-
]
14-
},
15-
"Targets": {
16-
"Pdf": {
17-
"template_folder": "_themes.pdf"
18-
}
19-
},
20-
"docsets_to_publish": [
21-
{
22-
"docset_name": "vcppdocs",
23-
"build_source_folder": "docs",
24-
"build_output_subfolder": "vcppdocs",
25-
"locale": "en-us",
26-
"version": 0,
27-
"open_to_public_contributors": true,
28-
"type_mapping": {
29-
"Conceptual": "Content",
30-
"ManagedReference": "Content",
31-
"RestApi": "Content"
32-
},
33-
"template_folder": "_themes"
34-
}
35-
],
36-
"notification_subscribers": [],
37-
"branches_to_filter": [],
38-
"skip_source_output_uploading": false,
39-
"git_repository_url_open_to_public_contributors": "https://github.com/Microsoft/cpp-docs",
40-
"git_repository_branch_open_to_public_contributors": "master",
41-
"dependent_repositories": [
42-
{
43-
"path_to_root": "_themes",
44-
"url": "https://github.com/Microsoft/templates.docs.msft",
45-
"branch": "master",
46-
"branch_mapping": {}
47-
},
48-
{
49-
"path_to_root": "_themes.pdf",
50-
"url": "https://github.com/Microsoft/templates.docs.msft.pdf",
51-
"branch": "master"
52-
}
53-
],
54-
"need_generate_pdf_url_template": true,
55-
"enable_incremental_build": true
56-
}
1+
{
2+
"build_entry_point": "docs",
3+
"need_generate_pdf": false,
4+
"need_generate_intellisense": false,
5+
"branch_target_mapping": {
6+
"live": [
7+
"Publish",
8+
"Pdf"
9+
],
10+
"master": [
11+
"Publish",
12+
"Pdf"
13+
]
14+
},
15+
"Targets": {
16+
"Pdf": {
17+
"template_folder": "_themes.pdf"
18+
}
19+
},
20+
"docsets_to_publish": [
21+
{
22+
"docset_name": "vcppdocs",
23+
"build_source_folder": "docs",
24+
"build_output_subfolder": "vcppdocs",
25+
"locale": "en-us",
26+
"version": 0,
27+
"open_to_public_contributors": true,
28+
"type_mapping": {
29+
"Conceptual": "Content",
30+
"ManagedReference": "Content",
31+
"RestApi": "Content"
32+
},
33+
"template_folder": "_themes"
34+
}
35+
],
36+
"notification_subscribers": [],
37+
"branches_to_filter": [],
38+
"skip_source_output_uploading": false,
39+
"git_repository_url_open_to_public_contributors": "https://github.com/Microsoft/cpp-docs",
40+
"git_repository_branch_open_to_public_contributors": "master",
41+
"dependent_repositories": [
42+
{
43+
"path_to_root": "_themes",
44+
"url": "https://github.com/Microsoft/templates.docs.msft",
45+
"branch": "master",
46+
"branch_mapping": {}
47+
},
48+
{
49+
"path_to_root": "_themes.pdf",
50+
"url": "https://github.com/Microsoft/templates.docs.msft.pdf",
51+
"branch": "master"
52+
}
53+
],
54+
"need_generate_pdf_url_template": true,
55+
"enable_incremental_build": true
56+
}

CONTRIBUTING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -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 `Microsoft/cpp-docs` repo.
22+
**Step 2:** Fork the `MicrosoftDocs/cpp-docs` repo.
2323

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

@@ -42,7 +42,7 @@ Be sure to follow the proper Markdown syntax. See the [style guide](./styleguide
4242
/media
4343
wstring-conversion.png
4444

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

4747
If your PR is addressing an existing issue, add the `Fixes #Issue_Number` keyword to the commit message or PR description, so the issue can be automatically closed when the PR is merged. For more information, see [Closing issues via commit messages](https://help.github.com/articles/closing-issues-via-commit-messages/).
4848

@@ -52,7 +52,7 @@ The Visual Studio team will review your PR and let you know if the change looks
5252

5353
The maintainers will merge your PR into the master branch once feedback has been applied and your change looks good.
5454

55-
On a certain cadence, we push all commits from master branch into the live branch and then you'll be able to see your contribution live at https://docs.microsoft.com/cpp-docs/.
55+
On a certain cadence, we push all commits from master branch into the live branch and then you'll be able to see your contribution live at https://docs.microsoft.com/en-us/cpp/.
5656

5757
## DOs and DON'Ts
5858

@@ -70,7 +70,7 @@ 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/dotnet).
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/).
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

@@ -80,16 +80,16 @@ If you are comfortable with other ways listed on the link above, feel free to us
8080

8181
**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.
8282

83-
You can build and preview the resulting site locally using a built-in web server. Navigate to the core-docs folder on your machine and type the following command:
83+
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:
8484

8585
```
8686
docfx -t default --serve
8787
```
8888

89-
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/articles/welcome.html.
89+
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.
9090

9191
**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.
9292

9393
# Contributing to samples
9494

95-
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.
95+
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.

docs/assembler/masm/TOC.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@
5454
### [.ERR2](dot-err2.md)
5555
### [.ERRB](dot-errb.md)
5656
### [.ERRDEF](dot-errdef.md)
57-
### [.ERRDIF]]](dot-errdif.md)
57+
### [.ERRDIF[[I]]](dot-errdif.md)
5858
### [.ERRE](dot-erre.md)
5959
### [.ERRIDN]](dot-erridn.md)
6060
### [.ERRNB](dot-errnb.md)

docs/assembler/masm/dot-errdif.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: ".ERRDIF]] | Microsoft Docs"
2+
title: ".ERRDIF[[I]] | Microsoft Docs"
33
ms.custom: ""
44
ms.date: "11/04/2016"
55
ms.reviewer: ""
@@ -9,11 +9,11 @@ ms.technology:
99
ms.tgt_pltfrm: ""
1010
ms.topic: "article"
1111
f1_keywords:
12-
- ".ERRDIF[[I]]]"
12+
- ".ERRDIF[[I]]"
1313
dev_langs:
1414
- "C++"
1515
helpviewer_keywords:
16-
- ".ERRDIF[[I]]] directive"
16+
- ".ERRDIF[[I]] directive"
1717
ms.assetid: af7cb441-0373-4c7e-af9c-06bcb9ed2b0a
1818
caps.latest.revision: 7
1919
author: "corob-msft"
@@ -34,7 +34,7 @@ translation.priority.ht:
3434
- "zh-cn"
3535
- "zh-tw"
3636
---
37-
# .ERRDIF]]
37+
# .ERRDIF[[I]]
3838
Generates an error if the text items are different.
3939

4040
## Syntax

docs/build/reference/TOC.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,9 +181,9 @@
181181
### [-BASE (Base Address)](base-base-address.md)
182182
### [-CGTHREADS (Compiler Threads)](cgthreads-compiler-threads.md)
183183
### [-CLRIMAGETYPE (Specify Type of CLR Image)](clrimagetype-specify-type-of-clr-image.md)
184-
### [-CLRUNMANAGEDCODECHECK (Add SupressUnmanagedCodeSecurityAttribute)](clrunmanagedcodecheck-add-supressunmanagedcodesecurityattribute.md)
185184
### [-CLRSUPPORTLASTERROR (Preserve Last Error Code for PInvoke Calls)](clrsupportlasterror-preserve-last-error-code-for-pinvoke-calls.md)
186185
### [-CLRTHREADATTRIBUTE (Set CLR Thread Attribute)](clrthreadattribute-set-clr-thread-attribute.md)
186+
### [-CLRUNMANAGEDCODECHECK (Add SupressUnmanagedCodeSecurityAttribute)](clrunmanagedcodecheck-add-supressunmanagedcodesecurityattribute.md)
187187
### [-DEBUG (Generate Debug Info)](debug-generate-debug-info.md)
188188
### [-DEBUGTYPE (Debug Info Options)](debugtype-debug-info-options.md)
189189
### [-DEF (Specify Module-Definition File)](def-specify-module-definition-file.md)

docs/build/reference/cl-environment-variables.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ SET _CL_=[ [option] ... [file] ...] [/link link-opt ...]
6262
For related information, see [Set Environment Variables](../../build/setting-the-path-and-environment-variables-for-command-line-builds.md).
6363

6464
## Examples
65-
The following is an example of settting the CL environment variable:
65+
The following is an example of setting the CL environment variable:
6666

6767
```
6868
SET CL=/Zp2 /Ox /I\INCLUDE\MYINCLS \LIB\BINMODE.OBJ
@@ -90,4 +90,4 @@ CL FILE1.C FILE2.C FILE3.OBJ
9090

9191
## See Also
9292
[Setting Compiler Options](../../build/reference/setting-compiler-options.md)
93-
[Compiler Options](../../build/reference/compiler-options.md)
93+
[Compiler Options](../../build/reference/compiler-options.md)

docs/build/reference/zc-conformance.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ These are the `/Zc` compiler options:
5757
|[implicitNoexcept\[-\]](zc-implicitnoexcept-implicit-exception-specifiers.md)|Enable implicit `noexcept` on required functions (on by default).|
5858
|[inline\[-\]](zc-inline-remove-unreferenced-comdat.md)|Remove unreferenced function or data if it is COMDAT or has internal linkage only (off by default).|
5959
|[referenceBinding\[-\]](zc-referencebinding-enforce-reference-binding-rules.md)|A UDT temporary will not bind to an non-const lvalue reference (off by default).|
60-
|[rvalueCast\[-\]](zc-rvaluecast-enforce-type-conversion-rules.md)|Enforce Standard C++ explicit type conversion rules (on by default).|
60+
|[rvalueCast\[-\]](zc-rvaluecast-enforce-type-conversion-rules.md)|Enforce Standard C++ explicit type conversion rules (off by default).|
6161
|[sizedDealloc\[-\]](zc-sizeddealloc-enable-global-sized-dealloc-functions.md)|Enable C++14 global sized deallocation functions (on by default).|
6262
|[strictStrings\[-\]](zc-strictstrings-disable-string-literal-type-conversion.md)|Disable string-literal to `char*` or `wchar_t*` conversion (off by default).|
6363
|[threadSafeInit\[-\]](zc-threadsafeinit-thread-safe-local-static-initialization.md)|Enable thread-safe local static initialization (on by default).|
@@ -69,4 +69,4 @@ For more information about conformance issues in Visual C++, see [Nonstandard Be
6969

7070
## See Also
7171
[Compiler Options](compiler-options.md)
72-
[Setting Compiler Options](setting-compiler-options.md)
72+
[Setting Compiler Options](setting-compiler-options.md)

docs/c-runtime-library/reference/read.md

Lines changed: 30 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -55,57 +55,61 @@ translation.priority.ht:
5555
- "zh-tw"
5656
---
5757
# _read
58+
5859
Reads data from a file.
5960

6061
## Syntax
6162

6263
```
63-
64-
int _read(
64+
int _read(
6565
int fd,
6666
void *buffer,
6767
unsigned int count
6868
);
6969
```
7070

71-
#### Parameters
72-
`fd`
73-
File descriptor referring to the open file.
71+
### Parameters
72+
73+
*fd*
74+
File descriptor referring to the open file.
7475

75-
*buffer*
76-
Storage location for data.
76+
*buffer*
77+
Storage location for data.
7778

78-
*count*
79-
Maximum number of bytes.
79+
*count*
80+
Maximum number of bytes.
8081

8182
## Return Value
82-
_**read** returns the number of bytes read, which might be less than *count* if there are fewer than *count* bytes left in the file or if the file was opened in text mode, in which case each carriage return-line feed (CR-LF) pair is replaced with a single linefeed character. Only the single linefeed character is counted in the return value. The replacement does not affect the file pointer.
83+
84+
`_read` returns the number of bytes read, which might be less than *count* if there are fewer than *count* bytes left in the file or if the file was opened in text mode, in which case each carriage return-line feed pair `\r\n` is replaced with a single linefeed character `\n`. Only the single linefeed character is counted in the return value. The replacement does not affect the file pointer.
8385

84-
If the function tries to read at end of file, it returns 0. If `fd` is invalid, the file is not open for reading, or the file is locked, the invalid parameter handler is invoked, as described in [Parameter Validation](../../c-runtime-library/parameter-validation.md). If execution is allowed to continue, the function returns -1 and sets `errno` to `EBADF`.
86+
If the function tries to read at end of file, it returns 0. If *fd* is not valid, the file is not open for reading, or the file is locked, the invalid parameter handler is invoked, as described in [Parameter Validation](../../c-runtime-library/parameter-validation.md). If execution is allowed to continue, the function returns -1 and sets `errno` to `EBADF`.
8587

86-
If *buffer* is **NULL**, the invalid parameter handler is invoked. If execution is allowed to continue, the function returns -1 and `errno` is set to `EINVAL`.
88+
If *buffer* is **NULL**, the invalid parameter handler is invoked. If execution is allowed to continue, the function returns -1 and `errno` is set to `EINVAL`.
8789

88-
For more information about this and other return codes, see [_doserrno, errno, _sys_errlist, and _sys_nerr](../../c-runtime-library/errno-doserrno-sys-errlist-and-sys-nerr.md).
90+
For more information about this and other return codes, see [_doserrno, errno, _sys_errlist, and _sys_nerr](../../c-runtime-library/errno-doserrno-sys-errlist-and-sys-nerr.md).
8991

9092
## Remarks
91-
The `_read` function reads a maximum of *count* bytes into *buffer* from the file associated with `fd`. The read operation begins at the current position of the file pointer associated with the given file. After the read operation, the file pointer points to the next unread character.
93+
94+
The `_read` function reads a maximum of *count* bytes into *buffer* from the file associated with *fd*. The read operation begins at the current position of the file pointer associated with the given file. After the read operation, the file pointer points to the next unread character.
9295

93-
If the file was opened in text mode, the read terminates when `_read` encounters a CTRL+Z character, which is treated as an end-of-file indicator. Use [_lseek](../../c-runtime-library/reference/lseek-lseeki64.md) to clear the end-of-file indicator.
96+
If the file was opened in text mode, the read terminates when `_read` encounters a CTRL+Z character, which is treated as an end-of-file indicator. Use [_lseek](../../c-runtime-library/reference/lseek-lseeki64.md) to clear the end-of-file indicator.
9497

9598
## Requirements
9699

97100
|Routine|Required header|
98101
|-------------|---------------------|
99102
|`_read`|\<io.h>|
100103

101-
For more compatibility information, see [Compatibility](../../c-runtime-library/compatibility.md) in the Introduction.
104+
For more compatibility information, see [Compatibility](../../c-runtime-library/compatibility.md).
102105

103106
## Libraries
104-
All versions of the [C run-time libraries](../../c-runtime-library/crt-library-features.md).
107+
108+
All versions of the [C run-time libraries](../../c-runtime-library/crt-library-features.md).
105109

106110
## Example
107111

108-
```
112+
```C
109113
// crt_read.c
110114
/* This program opens a file named crt_read.txt
111115
* and tries to read 60,000 bytes from
@@ -143,22 +147,23 @@ int main( void )
143147
}
144148
```
145149
146-
## Input: crt_read.txt
150+
### Input: crt_read.txt
147151
148152
```
149153
Line one.
150154
Line two.
151155
```
152156
153-
## Output
157+
### Output
154158
155159
```
156160
Read 19 bytes from file
157161
```
158162
159163
## See Also
160-
[Low-Level I/O](../../c-runtime-library/low-level-i-o.md)
161-
[_creat, _wcreat](../../c-runtime-library/reference/creat-wcreat.md)
162-
[fread](../../c-runtime-library/reference/fread.md)
163-
[_open, _wopen](../../c-runtime-library/reference/open-wopen.md)
164-
[_write](../../c-runtime-library/reference/write.md)
164+
165+
[Low-Level I/O](../../c-runtime-library/low-level-i-o.md)
166+
[_creat, _wcreat](../../c-runtime-library/reference/creat-wcreat.md)
167+
[fread](../../c-runtime-library/reference/fread.md)
168+
[_open, _wopen](../../c-runtime-library/reference/open-wopen.md)
169+
[_write](../../c-runtime-library/reference/write.md)

docs/cpp-conformance-improvements-2017.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "C++ compiler conformance improvements | Microsoft Docs"
33
ms.custom: ""
4-
ms.date: "06/05/2017"
4+
ms.date: "08/13/2017"
55
ms.reviewer: ""
66
ms.suite: ""
77
ms.technology:

0 commit comments

Comments
 (0)