Skip to content

Commit bcc0003

Browse files
ktoliverktoliver
authored
Merge pull request #1523 from DennisLee-DennisLee/v-dele-1361728-cleanup
1361728: Final fixes (capitalization in section titles and link text; URL adjustments)
2 parents 47b7aaf + ed704aa commit bcc0003

7 files changed

Lines changed: 126 additions & 126 deletions

File tree

‎docs/parallel/openmp/reference/TOC.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# [OpenMP Directives](openmp-directives.md)
2-
# [OpenMP Clauses](openmp-clauses.md)
3-
# [OpenMP Library Reference](openmp-library-reference.md)
4-
## [OpenMP Libraries](openmp-libraries.md)
5-
## [OpenMP Data Types](openmp-data-types.md)
6-
## [OpenMP Environment Variables](openmp-environment-variables.md)
7-
## [OpenMP Functions](openmp-functions.md)
1+
# [OpenMP directives](openmp-directives.md)
2+
# [OpenMP clauses](openmp-clauses.md)
3+
# [OpenMP library reference](openmp-library-reference.md)
4+
## [OpenMP libraries](openmp-libraries.md)
5+
## [OpenMP data types](openmp-data-types.md)
6+
## [OpenMP environment variables](openmp-environment-variables.md)
7+
## [OpenMP functions](openmp-functions.md)

‎docs/parallel/openmp/reference/openmp-clauses.md‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "OpenMP Clauses | Microsoft Docs"
2+
title: "OpenMP clauses | Microsoft Docs"
33
ms.custom: ""
44
ms.date: "10/22/2018"
55
ms.technology: ["cpp-parallel"]
@@ -18,21 +18,21 @@ Provides links to clauses used in the OpenMP API.
1818

1919
Visual C++ supports the following OpenMP clauses:
2020

21-
Clause | Description
22-
---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
23-
[copyin](#copyin) | Allows threads to access the master thread's value, for a [threadprivate](openmp-directives.md#threadprivate) variable.
24-
[copyprivate](#copyprivate) | Specifies that one or more variables should be shared among all threads.
25-
[default](#default-openmp) | Specifies the behavior of unscoped variables in a parallel region.
26-
[firstprivate](#firstprivate) | Specifies that each thread should have its own instance of a variable, and that the variable should be initialized with the value of the variable, because it exists before the parallel construct.
27-
[if](#if-openmp) | Specifies whether a loop should be executed in parallel or in serial.
28-
[lastprivate](#lastprivate) | Specifies that the enclosing context's version of the variable is set equal to the private version of whichever thread executes the final iteration (for-loop construct) or last section (#pragma sections).
29-
[nowait](#nowait) | Overrides the barrier implicit in a directive.
30-
[num_threads](#num-threads) | Sets the number of threads in a thread team.
31-
[ordered](#ordered-openmp-clauses) | Required on a parallel [for](openmp-directives.md#for-openmp) statement if an [ordered](openmp-directives.md#ordered-openmp-directives) directive is to be used in the loop.
32-
[private](#private-openmp) | Specifies that each thread should have its own instance of a variable.
33-
[reduction](#reduction) | Specifies that one or more variables that are private to each thread are the subject of a reduction operation at the end of the parallel region.
34-
[schedule](#schedule) | Applies to the [for](openmp-directives.md#for-openmp) directive.
35-
[shared](#shared-openmp) | Specifies that one or more variables should be shared among all threads.
21+
|Clause|Description|
22+
|------|-----------|
23+
|[copyin](#copyin)|Allows threads to access the master thread's value, for a [threadprivate](openmp-directives.md#threadprivate) variable.|
24+
|[copyprivate](#copyprivate)|Specifies that one or more variables should be shared among all threads.|
25+
|[default](#default-openmp)|Specifies the behavior of unscoped variables in a parallel region.|
26+
|[firstprivate](#firstprivate)|Specifies that each thread should have its own instance of a variable, and that the variable should be initialized with the value of the variable, because it exists before the parallel construct.|
27+
|[if](#if-openmp)|Specifies whether a loop should be executed in parallel or in serial.|
28+
|[lastprivate](#lastprivate)|Specifies that the enclosing context's version of the variable is set equal to the private version of whichever thread executes the final iteration (for-loop construct) or last section (#pragma sections).|
29+
|[nowait](#nowait)|Overrides the barrier implicit in a directive.|
30+
|[num_threads](#num-threads)|Sets the number of threads in a thread team.|
31+
|[ordered](#ordered-openmp-clauses)|Required on a parallel [for](openmp-directives.md#for-openmp) statement if an [ordered](openmp-directives.md#ordered-openmp-directives) directive is to be used in the loop.|
32+
|[private](#private-openmp)|Specifies that each thread should have its own instance of a variable.|
33+
|[reduction](#reduction)|Specifies that one or more variables that are private to each thread are the subject of a reduction operation at the end of the parallel region.|
34+
|[schedule](#schedule)|Applies to the [for](openmp-directives.md#for-openmp) directive.|
35+
|[shared](#shared-openmp)|Specifies that one or more variables should be shared among all threads.|
3636

3737
## <a name="copyin"></a>copyin
3838

@@ -219,7 +219,7 @@ An integral expression that, if it evaluates to true (nonzero), causes the code
219219
- [for](openmp-directives.md#for-openmp)
220220
- [sections](openmp-directives.md#sections-openmp)
221221

222-
For more information, see [2.3 parallel Construct](../../../parallel/openmp/2-3-parallel-construct.md).
222+
For more information, see [2.3 parallel construct](../../../parallel/openmp/2-3-parallel-construct.md).
223223

224224
### Example
225225

@@ -299,7 +299,7 @@ nowait
299299
- [sections](openmp-directives.md#sections-openmp)
300300
- [single](openmp-directives.md#single)
301301

302-
For more information, see [2.4.1 for Construct](../../../parallel/openmp/2-4-1-for-construct.md), [2.4.2 sections Construct](../../../parallel/openmp/2-4-2-sections-construct.md), and [2.4.3 single Construct](../../../parallel/openmp/2-4-3-single-construct.md).
302+
For more information, see [2.4.1 for construct](../../../parallel/openmp/2-4-1-for-construct.md), [2.4.2 sections construct](../../../parallel/openmp/2-4-2-sections-construct.md), and [2.4.3 single construct](../../../parallel/openmp/2-4-3-single-construct.md).
303303

304304
### Example
305305

@@ -363,15 +363,15 @@ The number of threads
363363

364364
### Remarks
365365

366-
The `num_threads` clause has the same functionality as the [omp_set_num_threads](../../../parallel/openmp/reference/omp-set-num-threads.md) function.
366+
The `num_threads` clause has the same functionality as the [omp_set_num_threads](openmp-functions.md#omp-set-num-threads) function.
367367

368368
`num_threads` applies to the following directives:
369369

370370
- [parallel](openmp-directives.md#parallel)
371371
- [for](openmp-directives.md#for-openmp)
372372
- [sections](openmp-directives.md#sections-openmp)
373373

374-
For more information, see [2.3 parallel Construct](../../../parallel/openmp/2-3-parallel-construct.md).
374+
For more information, see [2.3 parallel construct](../../../parallel/openmp/2-3-parallel-construct.md).
375375

376376
### Example
377377

@@ -389,7 +389,7 @@ ordered
389389

390390
`ordered` applies to the [for](openmp-directives.md#for-openmp) directive.
391391

392-
For more information, see [2.4.1 for Construct](../../../parallel/openmp/2-4-1-for-construct.md).
392+
For more information, see [2.4.1 for construct](../../../parallel/openmp/2-4-1-for-construct.md).
393393

394394
### Example
395395

@@ -759,7 +759,7 @@ The kind of scheduling:
759759

760760
### Remarks
761761

762-
For more information, see [2.4.1 for Construct](../../../parallel/openmp/2-4-1-for-construct.md).
762+
For more information, see [2.4.1 for construct](../../../parallel/openmp/2-4-1-for-construct.md).
763763

764764
### Example
765765

‎docs/parallel/openmp/reference/openmp-data-types.md‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "OpenMP Data Types | Microsoft Docs"
2+
title: "OpenMP data types | Microsoft Docs"
33
ms.custom: ""
44
ms.date: "10/23/2018"
55
ms.technology: ["cpp-parallel"]
@@ -12,49 +12,49 @@ author: "mikeblome"
1212
ms.author: "mblome"
1313
ms.workload: ["cplusplus"]
1414
---
15-
# OpenMP Data Types
15+
# OpenMP data types
1616

1717
Provides links to data types used in the OpenMP API.
1818

1919
The Visual C++ implementation of the OpenMP standard includes the following data types.
2020

21-
Data type | Description
22-
----------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
23-
[omp_lock_t](#omp-lock-t) | A type that holds the status of a lock, whether the lock is available or if a thread owns a lock.
24-
[omp_nest_lock_t](#omp-nest-lock-t) | A type that holds one of the following pieces of information about a lock: whether the lock is available, and the identity of the thread that owns the lock and a nesting count.
21+
|Data type|Description|
22+
|---------|-----------|
23+
|[omp_lock_t](#omp-lock-t)|A type that holds the status of a lock, whether the lock is available or if a thread owns a lock.|
24+
|[omp_nest_lock_t](#omp-nest-lock-t)|A type that holds one of the following pieces of information about a lock: whether the lock is available, and the identity of the thread that owns the lock and a nesting count.|
2525

2626
## <a name="omp-lock-t"></a>omp_lock_t
2727

2828
A type that holds the status of a lock, whether the lock is available or if a thread owns a lock.
2929

3030
The following functions use `omp_lock_t`:
3131

32-
- [omp_init_lock](../../../parallel/openmp/reference/omp-init-lock.md)
33-
- [omp_destroy_lock](../../../parallel/openmp/reference/omp-destroy-lock.md)
34-
- [omp_set_lock](../../../parallel/openmp/reference/omp-set-lock.md)
35-
- [omp_unset_lock](../../../parallel/openmp/reference/omp-unset-lock.md)
36-
- [omp_test_lock](../../../parallel/openmp/reference/omp-test-lock.md)
32+
- [omp_init_lock](openmp-functions.md#omp-init-lock)
33+
- [omp_destroy_lock](openmp-functions.md#omp-destroy-lock)
34+
- [omp_set_lock](openmp-functions.md#omp-set-lock)
35+
- [omp_unset_lock](openmp-functions.md#omp-unset-lock)
36+
- [omp_test_lock](openmp-functions.md#omp-test-lock)
3737

38-
For more information, see [3.2 Lock Functions](../../../parallel/openmp/3-2-lock-functions.md).
38+
For more information, see [3.2 Lock functions](../../../parallel/openmp/3-2-lock-functions.md).
3939

4040
### Example
4141

42-
See [omp_init_lock](../../../parallel/openmp/reference/omp-init-lock.md) for an example of using `omp_lock_t`.
42+
See [omp_init_lock](openmp-functions.md#omp-init-lock) for an example of using `omp_lock_t`.
4343

4444
## <a name="omp-nest-lock-t"></a>omp_nest_lock_t
4545

4646
A type that holds the following pieces of information about a lock: whether the lock is available, and the identity of the thread that owns the lock and a nesting count.
4747

4848
The following functions use `omp_nest_lock_t`:
4949

50-
- [omp_init_nest_lock](../../../parallel/openmp/reference/omp-init-nest-lock.md)
51-
- [omp_destroy_nest_lock](../../../parallel/openmp/reference/omp-destroy-nest-lock.md)
52-
- [omp_set_nest_lock](../../../parallel/openmp/reference/omp-set-nest-lock.md)
53-
- [omp_unset_nest_lock](../../../parallel/openmp/reference/omp-unset-nest-lock.md)
54-
- [omp_test_nest_lock](../../../parallel/openmp/reference/omp-test-nest-lock.md)
50+
- [omp_init_nest_lock](openmp-functions.md#omp-init-nest-lock)
51+
- [omp_destroy_nest_lock](openmp-functions.md#omp-destroy-nest-lock)
52+
- [omp_set_nest_lock](openmp-functions.md#omp-set-nest-lock)
53+
- [omp_unset_nest_lock](openmp-functions.md#omp-unset-nest-lock)
54+
- [omp_test_nest_lock](openmp-functions.md#omp-test-nest-lock)
5555

56-
For more information, see [3.2 Lock Functions](../../../parallel/openmp/3-2-lock-functions.md).
56+
For more information, see [3.2 Lock functions](../../../parallel/openmp/3-2-lock-functions.md).
5757

5858
### Example
5959

60-
See [omp_init_nest_lock](../../../parallel/openmp/reference/omp-init-nest-lock.md) for an example of using `omp_nest_lock_t`.
60+
See [omp_init_nest_lock](openmp-functions.md#omp-init-nest-lock) for an example of using `omp_nest_lock_t`.

0 commit comments

Comments
 (0)