This is an archive of the discontinued LLVM Phabricator instance.

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

Authored by junaire on Sep 17 2022, 2:51 AM.

Details

Summary

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@junz.org>

Diff Detail

Event Timeline

junaire created this revision.Sep 17 2022, 2:51 AM
Herald added a project: Restricted Project. · View Herald TranscriptSep 17 2022, 2:51 AM
junaire requested review of this revision.Sep 17 2022, 2:51 AM
Herald added a project: Restricted Project. · View Herald TranscriptSep 17 2022, 2:51 AM
Herald added a subscriber: cfe-commits. · View Herald Transcript
ChuanqiXu added a comment.EditedSep 17 2022, 4:17 AM

Thanks. I wanted to do this. I suggest to do the change in later sections. Since the document talks more than the clang modules extension. It also describes some general module properties and semantics. It is a pretty good document and from my point of view, it should be helpful for people who desire C++20 Modules to read this (at least the sections in the frontend).

BTW, have you tested to generate the document?

clang/docs/Modules.rst
104
junaire updated this revision to Diff 461040.Sep 17 2022, 8:13 PM

I bet now it rendered correctly.

ChuanqiXu accepted this revision.Sep 18 2022, 12:44 AM
ChuanqiXu added inline comments.
clang/docs/Modules.rst
107–108

minor suggestion.

This revision is now accepted and ready to land.Sep 18 2022, 12:44 AM