Skip to content

Commit c16420b

Browse files
Fixing section, link text capitalization, and link relative URLs on the parent topics.
1 parent b19579b commit c16420b

4 files changed

Lines changed: 66 additions & 66 deletions

File tree

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

Lines changed: 7 additions & 7 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"]
@@ -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

Lines changed: 14 additions & 14 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,7 +12,7 @@ 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

@@ -29,32 +29,32 @@ A type that holds the status of a lock, whether the lock is available or if a th
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

3838
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

5656
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`.

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

Lines changed: 38 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "OpenMP Directives | Microsoft Docs"
2+
title: "OpenMP directives | Microsoft Docs"
33
ms.custom: ""
44
ms.date: "10/22/2018"
55
ms.technology: ["cpp-parallel"]
@@ -50,7 +50,7 @@ The statement that has the lvalue, whose memory location you want to protect aga
5050

5151
The `atomic` directive supports no OpenMP clauses.
5252

53-
For more information, see [2.6.4 atomic Construct](../../../parallel/openmp/2-6-4-atomic-construct.md).
53+
For more information, see [2.6.4 atomic construct](../../../parallel/openmp/2-6-4-atomic-construct.md).
5454

5555
### Example
5656

@@ -89,7 +89,7 @@ Synchronizes all threads in a team; all threads pause at the barrier, until all
8989

9090
The `barrier` directive supports no OpenMP clauses.
9191

92-
For more information, see [2.6.3 barrier Directive](../../../parallel/openmp/2-6-3-barrier-directive.md).
92+
For more information, see [2.6.3 barrier directive](../../../parallel/openmp/2-6-3-barrier-directive.md).
9393

9494
### Example
9595

@@ -115,7 +115,7 @@ Specifies that code is only be executed on one thread at a time.
115115

116116
The `critical` directive supports no OpenMP clauses.
117117

118-
For more information, see [2.6.2 critical Construct](../../../parallel/openmp/2-6-2-critical-construct.md).
118+
For more information, see [2.6.2 critical construct](../../../parallel/openmp/2-6-2-critical-construct.md).
119119

120120
### Example
121121

@@ -192,7 +192,7 @@ Specifies that all threads have the same view of memory for all shared objects.
192192

193193
The `flush` directive supports no OpenMP clauses.
194194

195-
For more information, see [2.6.5 flush Directive](../../../parallel/openmp/2-6-5-flush-directive.md).
195+
For more information, see [2.6.5 flush directive](../../../parallel/openmp/2-6-5-flush-directive.md).
196196

197197
### Example
198198

@@ -272,17 +272,17 @@ A `for` loop. Undefined behavior will result if user code in the `for` loop chan
272272

273273
The `for` directive supports the following OpenMP clauses:
274274

275-
- [firstprivate](../../../parallel/openmp/reference/firstprivate.md)
276-
- [lastprivate](../../../parallel/openmp/reference/lastprivate.md)
277-
- [nowait](../../../parallel/openmp/reference/nowait.md)
278-
- [ordered](../../../parallel/openmp/reference/ordered-openmp-directives.md)
279-
- [private](../../../parallel/openmp/reference/private-openmp.md)
280-
- [reduction](../../../parallel/openmp/reference/reduction.md)
281-
- [schedule](../../../parallel/openmp/reference/schedule.md)
275+
- [firstprivate](openmp-clauses.md#firstprivate)
276+
- [lastprivate](openmp-clauses.md#lastprivate)
277+
- [nowait](openmp-clauses.md#nowait)
278+
- [ordered](openmp-clauses.md#ordered-openmp-clauses)
279+
- [private](openmp-clauses.md#private-openmp)
280+
- [reduction](openmp-clauses.md#reduction)
281+
- [schedule](openmp-clauses.md#schedule)
282282

283283
If `parallel` is also specified, `clauses` can be any clause accepted by the `parallel` or `for` directives, except `nowait`.
284284

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

287287
### Example
288288

@@ -365,7 +365,7 @@ The `master` directive supports no OpenMP clauses.
365365

366366
The [single](#single) directive lets you specify that a section of code should be executed on a single thread, not necessarily the master thread.
367367

368-
For more information, see [2.6.1 master Construct](../../../parallel/openmp/2-6-1-master-construct.md).
368+
For more information, see [2.6.1 master construct](../../../parallel/openmp/2-6-1-master-construct.md).
369369

370370
### Example
371371

@@ -425,7 +425,7 @@ The `ordered` directive must be within the dynamic extent of a [for](#for-openmp
425425

426426
The `ordered` directive supports no OpenMP clauses.
427427

428-
For more information, see [2.6.6 ordered Construct](../../../parallel/openmp/2-6-6-ordered-construct.md).
428+
For more information, see [2.6.6 ordered construct](../../../parallel/openmp/2-6-6-ordered-construct.md).
429429

430430
### Example
431431

@@ -501,18 +501,18 @@ Defines a parallel region, which is code that will be executed by multiple threa
501501

502502
The `parallel` directive supports the following OpenMP clauses:
503503

504-
- [copyin](../../../parallel/openmp/reference/copyin.md)
505-
- [default](../../../parallel/openmp/reference/default-openmp.md)
506-
- [firstprivate](../../../parallel/openmp/reference/firstprivate.md)
507-
- [if](../../../parallel/openmp/reference/if-openmp.md)
508-
- [num_threads](../../../parallel/openmp/reference/num-threads.md)
509-
- [private](../../../parallel/openmp/reference/private-openmp.md)
510-
- [reduction](../../../parallel/openmp/reference/reduction.md)
511-
- [shared](../../../parallel/openmp/reference/shared-openmp.md)
504+
- [copyin](openmp-clauses.md#copyin)
505+
- [default](openmp-clauses.md#default-openmp)
506+
- [firstprivate](openmp-clauses.md#firstprivate)
507+
- [if](openmp-clauses.md#if-openmp)
508+
- [num_threads](openmp-clauses.md#num-threads)
509+
- [private](openmp-clauses.md#private-openmp)
510+
- [reduction](openmp-clauses.md#reduction)
511+
- [shared](openmp-clauses.md#shared-openmp)
512512

513513
`parallel` can also be used with the [sections](#sections-openmp) and [for](#for-openmp) directives.
514514

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

517517
### Example
518518

@@ -569,15 +569,15 @@ The `sections` directive can contain zero or more `section` directives.
569569

570570
The `sections` directive supports the following OpenMP clauses:
571571

572-
- [firstprivate](../../../parallel/openmp/reference/firstprivate.md)
573-
- [lastprivate](../../../parallel/openmp/reference/lastprivate.md)
574-
- [nowait](../../../parallel/openmp/reference/nowait.md)
575-
- [private](../../../parallel/openmp/reference/private-openmp.md)
576-
- [reduction](../../../parallel/openmp/reference/reduction.md)
572+
- [firstprivate](openmp-clauses.md#firstprivate)
573+
- [lastprivate](openmp-clauses.md#lastprivate)
574+
- [nowait](openmp-clauses.md#nowait)
575+
- [private](openmp-clauses.md#private-openmp)
576+
- [reduction](openmp-clauses.md#reduction)
577577

578578
If `parallel` is also specified, `clauses` can be any clause accepted by the `parallel` or `sections` directives, except `nowait`.
579579

580-
For more information, see [2.4.2 sections Construct](../../../parallel/openmp/2-4-2-sections-construct.md).
580+
For more information, see [2.4.2 sections construct](../../../parallel/openmp/2-4-2-sections-construct.md).
581581

582582
### Example
583583

@@ -622,14 +622,14 @@ Lets you specify that a section of code should be executed on a single thread, n
622622

623623
The `single` directive supports the following OpenMP clauses:
624624

625-
- [copyprivate](../../../parallel/openmp/reference/copyprivate.md)
626-
- [firstprivate](../../../parallel/openmp/reference/firstprivate.md)
627-
- [nowait](../../../parallel/openmp/reference/nowait.md)
628-
- [private](../../../parallel/openmp/reference/private-openmp.md)
625+
- [copyprivate](openmp-clauses.md#copyprivate)
626+
- [firstprivate](openmp-clauses.md#firstprivate)
627+
- [nowait](openmp-clauses.md#nowait)
628+
- [private](openmp-clauses.md#private-openmp)
629629

630630
The [master](#master) directive lets you specify that a section of code should be executed only on the master thread.
631631

632-
For more information, see [2.4.3 single Construct](../../../parallel/openmp/2-4-3-single-construct.md).
632+
For more information, see [2.4.3 single construct](../../../parallel/openmp/2-4-3-single-construct.md).
633633

634634
### Example
635635

@@ -680,11 +680,11 @@ A comma-separated list of variables that you want to make private to a thread. `
680680

681681
The `threadprivate` directive supports no OpenMP clauses.
682682

683-
For more information, see [2.7.1 threadprivate Directive](../../../parallel/openmp/2-7-1-threadprivate-directive.md).
683+
For more information, see [2.7.1 threadprivate directive](../../../parallel/openmp/2-7-1-threadprivate-directive.md).
684684

685685
The `threadprivate` directive is based on the [thread](../../../cpp/thread.md) attribute using the [__declspec](../../../cpp/declspec.md) keyword; limits on `__declspec(thread)` apply to `threadprivate`.
686686

687-
You can't use `threadprivate` in any DLL that will be loaded via [LoadLibrary](/windows/desktop/api/libloaderapi/nf-libloaderapi-loadlibrarya). This prohibition includes DLLs that are loaded with [/DELAYLOAD (Delay Load Import)](../../../build/reference/delayload-delay-load-import.md), which also uses `LoadLibrary`.
687+
You can't use `threadprivate` in any DLL that will be loaded via [LoadLibrary](/windows/desktop/api/libloaderapi/nf-libloaderapi-loadlibrarya). This prohibition includes DLLs that are loaded with [/DELAYLOAD (delay load import)](../../../build/reference/delayload-delay-load-import.md), which also uses `LoadLibrary`.
688688

689689
You can use `threadprivate` in a DLL that is statically loaded at process startup.
690690

@@ -711,4 +711,4 @@ Users have no control as to when the threads constituting the parallel region wi
711711

712712
### Example
713713

714-
For a sample of using `threadprivate`, see [private](../../../parallel/openmp/reference/private-openmp.md).
714+
For a sample of using `threadprivate`, see [private](openmp-clauses.md#private-openmp).

‎docs/parallel/openmp/reference/openmp-environment-variables.md‎

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

1717
Provides links to environment variables used in the OpenMP API.
1818

@@ -22,7 +22,7 @@ Environment variable | Description
2222
----------------------------------- | -----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2323
[OMP_DYNAMIC](#omp-dynamic) | Specifies whether the OpenMP run time can adjust the number of threads in a parallel region.
2424
[OMP_NESTED](#omp-nested) | Specifies whether nested parallelism is enabled, unless nested parallelism is enabled or disabled with `omp_set_nested`.
25-
[OMP_NUM_THREADS](#omp-num-threads) | Sets the maximum number of threads in the parallel region, unless overridden by [omp_set_num_threads](../../../parallel/openmp/reference/omp-set-num-threads.md) or [num_threads](openmp-clauses.md#num-threads).
25+
[OMP_NUM_THREADS](#omp-num-threads) | Sets the maximum number of threads in the parallel region, unless overridden by [omp_set_num_threads](openmp-functions.md#omp-set-num-threads) or [num_threads](openmp-clauses.md#num-threads).
2626
[OMP_SCHEDULE](#omp-schedule) | Modifies the behavior of the [schedule](openmp-clauses.md#schedule) clause when `schedule(runtime)` is specified in a `for` or `parallel for` directive.
2727

2828
## <a name="omp-dynamic"></a>OMP_DYNAMIC
@@ -35,7 +35,7 @@ set OMP_DYNAMIC[=TRUE | =FALSE]
3535

3636
### Remarks
3737

38-
The `OMP_DYNAMIC` environment variable can be overridden by the [omp_set_dynamic](../../../parallel/openmp/reference/omp-set-dynamic.md) function.
38+
The `OMP_DYNAMIC` environment variable can be overridden by the [omp_set_dynamic](openmp-functions.md#omp-set-dynamic) function.
3939

4040
The default value in the Visual C++ implementation of the OpenMP standard is `OMP_DYNAMIC=FALSE`.
4141

@@ -65,7 +65,7 @@ set OMP_NESTED[=TRUE | =FALSE]
6565

6666
### Remarks
6767

68-
The `OMP_NESTED` environment variable can be overridden by the [omp_set_nested](../../../parallel/openmp/reference/omp-set-nested.md) function.
68+
The `OMP_NESTED` environment variable can be overridden by the [omp_set_nested](openmp-functions.md#omp-set-nested) function.
6969

7070
The default value in the Visual C++ implementation of the OpenMP standard is `OMP_DYNAMIC=FALSE`.
7171

@@ -87,7 +87,7 @@ set OMP_NESTED
8787

8888
## <a name="omp-num-threads"></a>OMP_NUM_THREADS
8989

90-
Sets the maximum number of threads in the parallel region, unless overridden by [omp_set_num_threads](../../../parallel/openmp/reference/omp-set-num-threads.md) or [num_threads](openmp-clauses.md#num-threads).
90+
Sets the maximum number of threads in the parallel region, unless overridden by [omp_set_num_threads](openmp-functions.md#omp-set-num-threads) or [num_threads](openmp-clauses.md#num-threads).
9191

9292
```
9393
set OMP_NUM_THREADS[=num]
@@ -100,7 +100,7 @@ The maximum number of threads you want in the parallel region, up to 64 in the V
100100

101101
### Remarks
102102

103-
The `OMP_NUM_THREADS` environment variable can be overridden by the [omp_set_num_threads](../../../parallel/openmp/reference/omp-set-num-threads.md) function or by [num_threads](openmp-clauses.md#num-threads).
103+
The `OMP_NUM_THREADS` environment variable can be overridden by the [omp_set_num_threads](openmp-functions.md#omp-set-num-threads) function or by [num_threads](openmp-clauses.md#num-threads).
104104

105105
The default value of `num` in the Visual C++ implementation of the OpenMP standard is the number of virtual processors, including hyperthreading CPUs.
106106

0 commit comments

Comments
 (0)