[PATCH] D134105: [Docs] Add a link that refers to C++ standard modules in Clang modules doc

Jun Zhang via Phabricator via cfe-commits cfe-commits at lists.llvm.org
Sat Sep 17 02:51:36 PDT 2022


junaire created this revision.
junaire added a reviewer: ChuanqiXu.
Herald added a project: All.
junaire requested review of this revision.
Herald added a project: clang.
Herald added a subscriber: cfe-commits.

Currently there're two pages that both talk about "Modules" in clang, but
they're different. The one that describes C++ standard modules explicitly
spells out the difference but the other one which targeting Clang modules
doesn't.

This patch adds a link that refers to the C++ standard modules
one in Clang modules doc, as you usually got the later page when
googling. I believe this will make newcomers less confused.

Signed-off-by: Jun Zhang <jun at junz.org>


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D134105

Files:
  clang/docs/Modules.rst


Index: clang/docs/Modules.rst
===================================================================
--- clang/docs/Modules.rst
+++ clang/docs/Modules.rst
@@ -7,6 +7,8 @@
 
 Introduction
 ============
+This pages mainly talks about Clang Modules, please refer to .. _StandardCPlusPlusModules: StandardCPlusPlusModules.html if you're looking for standard C++ modules.
+
 Most software is built using a number of software libraries, including libraries supplied by the platform, internal libraries built as part of the software itself to provide structure, and third-party libraries. For each library, one needs to access both its interface (API) and its implementation. In the C family of languages, the interface to a library is accessed by including the appropriate header files(s):
 
 .. code-block:: c


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D134105.460983.patch
Type: text/x-patch
Size: 802 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/cfe-commits/attachments/20220917/c8a6a032/attachment.bin>


More information about the cfe-commits mailing list