Skip to content

Commit 559719f

Browse files
TylerMSFTTylerMSFT
andauthored
tech review and my edits (#5062)
* tech review and my edits * formatting cleanup --------- Co-authored-by: TylerMSFT <[email protected]>
1 parent dc193c3 commit 559719f

File tree

1 file changed

+15
-12
lines changed

1 file changed

+15
-12
lines changed

docs/build/reference/ifc-map.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,33 @@
11
---
22
title: "/ifcMap"
33
description: "Map named modules and header units to IFC files."
4-
ms.date: 10/13/2023
4+
ms.date: 10/16/2023
55
author: "tylermsft"
66
ms.author: "twhitney"
77
f1_keywords: ["/ifcMap"]
88
helpviewer_keywords: ["/ifcMap", "Specify named module and header unit mappings to IFC files."]
99
---
1010
# `/ifcMap`
1111

12-
This switch tells the compiler where to find the [TOML](https://toml.io/en/) file that maps named modules and header units to their respective IFC (.ifc) files.
12+
This switch tells the compiler where to find the IFC reference map file, which maps references to named modules and header units to their corresponding IFC (`.ifc`) files.
1313

1414
## Syntax
1515

1616
> **`/ifcMap`** *`filename`*
1717
1818
## Remarks
1919

20-
The *`filename`* argument specifies a TOML (Tom's Obvious Minimal Language) file. The file can be relative to the compiler's working directory, or an absolute path.
21-
Multiple `/ifcMap` arguments can be provided to the compiler.
20+
The `*filename*` argument specifies the IFC reference map file. It can be relative to the compiler's working directory, or an absolute path.
2221

23-
The TOML file can contain a mix of `[[module]]` and `[[header-unit]]` references. Syntax errors or unrecognized table names result in compiler error `C7696` (TOML parse error).
22+
You can provide multiple `/ifcMap` arguments to the compiler.
2423

25-
### TOML for named modules
24+
The IFC reference map file format is a subset of the [TOML](https://toml.io/en/) file format. The IFC reference map file can contain a mix of `[[module]]` and `[[header-unit]]` references.
2625

27-
The format of the TOML file must adhere to the following specification for named modules:
26+
Syntax errors or unrecognized table names result in compiler error `C7696` (TOML parse error).
27+
28+
### Map named modules
29+
30+
The format of the IFC reference map file for named modules is:
2831

2932
```
3033
# Using literal strings
@@ -38,17 +41,17 @@ name = "N"
3841
ifc = "C:\\modules\\N.ifc"
3942
```
4043

41-
This TOML file maps the named modules `'M'` and `'N'` to their respective IFC files. The equivalent [`/reference'](module-reference.md) is:
44+
This IFC reference map file maps the named modules `'M'` and `'N'` to their respective IFC files. The equivalent [`/reference'](module-reference.md) is:
4245

4346
```cmd
4447
/reference M=C:\modules\M.ifc /reference N=C:\modules\N.ifc
4548
```
4649

4750
For more information about what types of module names are valid for the `name` field, see [`/reference remarks`](module-reference.md#remarks).
4851

49-
### TOML for header units
52+
### Map header units
5053

51-
The format of the TOML for header units is:
54+
The format of the IFC reference map file for header units is:
5255

5356
```
5457
# Using literal strings
@@ -70,13 +73,13 @@ name = ["angle", "algorithm"]
7073
ifc = "C:\\header-units\\algorithm.ifc"
7174
```
7275

73-
The equivalent [`/headerUnit`](headerunit.md) for the previous TOML is:
76+
This IFC reference map file maps `"my-utility.h"` to `C:\header-units\my-utility.h.ifc`, and `<vector>` to `C:\header-units\vector.ifc`, and so on. The equivalent [`/headerUnit`](headerunit.md) is:
7477

7578
```cmd
7679
/headerUnit:quote my-utility=C:\header-units\my-utility.h.ifc /headerUnit:angle vector=C:\header-units\vector.ifc /headerUnit:quote my-engine.h=C:\header-units\my-engine.h.ifc /headerUnit:angle algorithm=C:\header-units\algorithm.ifc
7780
```
7881

79-
When `[[header-unit]]` is specified in the TOML, the compiler implicitly enables [`/Zc:preprocessor`](zc-preprocessor.md), just as it's implicitly enabled when [`/headerUnit`](headerunit.md) is used. For more information about the behavior of the 'angle' and 'quote' lookup methods, see the [/headerUnit remarks](headerunit.md#remarks).
82+
When `[[header-unit]]` is specified in an IFC reference map file, the compiler implicitly enables [`/Zc:preprocessor`](zc-preprocessor.md), just as it's implicitly enabled when [`/headerUnit`](headerunit.md) is used. For more information about the behavior of the `angle` and `quote` lookup methods, see [/headerUnit remarks](headerunit.md#remarks).
8083

8184
## See also
8285

0 commit comments

Comments
 (0)