Skip to content

Commit d539f51

Browse files
committed
update
1 parent f18b50f commit d539f51

File tree

2 files changed

+15
-8
lines changed

2 files changed

+15
-8
lines changed

clang/docs/StandardCPlusPlusModules.rst

+12-8
Original file line numberDiff line numberDiff line change
@@ -465,16 +465,20 @@ translation units.
465465
Source Files Consistency
466466
^^^^^^^^^^^^^^^^^^^^^^^^
467467

468-
Clang may open the input files (*) of a BMI during the compilation. It implies that
469-
when we consume a BMI, all the input files need to be present with the same path
470-
and the same contents.
468+
Clang may open the input files\ :sup:`*` of a BMI during the compilation. This implies that
469+
when Clang consumes a BMI, all the input files need to be present in the original path
470+
and with the original contents.
471471

472-
To overcome the requirements and simplify cases like distributed builds and sandboxed
473-
builds, users can use ``-fmodules-embed-all-files`` flag to embed all input files
474-
into the BMI so that clang won't ask to open the corresponding file on disk.
472+
To overcome these requirements and simplify cases like distributed builds and sandboxed
473+
builds, users can use the ``-fmodules-embed-all-files`` flag to embed all input files
474+
into the BMI so that Clang does not need to open the corresponding file on disk.
475475

476-
Input files (*): The source files that took part in the compilation of the BMI.
477-
For example,
476+
When the ``-fmodules-embed-all-files`` flag are enabled, Clang explicitly emits the source
477+
code into the BMI file, the contents of the BMI file contain a sufficiently verbose
478+
representation to reproduce the original source file.
479+
480+
:sup:`*`Input files: The source files which took part in the compilation of the BMI.
481+
For example:
478482

479483
.. code-block:: c++
480484

Original file line numberDiff line numberDiff line change
@@ -1,2 +1,5 @@
11
// RUN: %clang -std=c++20 %s -fmodules-embed-all-files -### 2>&1 | FileCheck %s
22
// CHECK: -fmodules-embed-all-files
3+
4+
// RUN: %clang -std=c++20 %s -### 2>&1 | FileCheck %s --check-prefix=NON-EMBED
5+
// NON-EMBED-NOT: -fmodules-embed-all-files

0 commit comments

Comments
 (0)