aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2018-10-04 05:09:29 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2018-10-04 05:09:29 +0200
commit060973ff774eaaee029945b40584f4cbb25c8041 (patch)
tree3a8eaed38e28914a174239c0eccf89f4932b2bed
parent04ffbbe777f6fb345037ded2d62a745baad38f25 (diff)
Add note on C++ module interface unit naming to manual
-rw-r--r--doc/manual.cli9
1 files changed, 8 insertions, 1 deletions
diff --git a/doc/manual.cli b/doc/manual.cli
index d6d4a00..f588e24 100644
--- a/doc/manual.cli
+++ b/doc/manual.cli
@@ -654,7 +654,14 @@ inclusion scheme where each header is prefixed with its project name. It also
has a predictable name where users can expect to find our project's source
code. Finally, this layout prevents clutter in the project's root directory
which usually contains various other files. See \l{intro#structure-canonical
-Canonical Project Structure} for more information.|
+Canonical Project Structure} for more information.
+
+Note also that while we can name our header and source files however we like
+(but, again, see \l{intro#structure-canonical Canonical Project Structure} for
+some sensible guidelines), C++ module interface files need to embed a
+sufficient amount of the module name suffix in their names to unambiguously
+resolve all the modules within a project. See \l{#cxx-modules-build
+Building Modules} for details.|
The source subdirectory \c{buildfile} is identical to the simple project's
minus the parts moved to \c{root.build}: