[clang-doc] Add Mustache case to test for DR 131697 #170197
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
Author
This was referenced Dec 1, 2025
Member
|
@llvm/pr-subscribers-clang-tools-extra Author: Erick Velez (evelez7) ChangesThe test for DR 131697 only requires that clang-doc doesn't crash. There Full diff: https://github.com/llvm/llvm-project/pull/170197.diff 2 Files Affected:
diff --git a/clang-tools-extra/clang-doc/Generators.cpp b/clang-tools-extra/clang-doc/Generators.cpp
index 667e5d5a318f0..5d76901b95833 100644
--- a/clang-tools-extra/clang-doc/Generators.cpp
+++ b/clang-tools-extra/clang-doc/Generators.cpp
@@ -84,27 +84,30 @@ Error MustacheGenerator::generateDocumentation(
return JSONGenerator.takeError();
}
- SmallString<128> JSONPath;
- sys::path::native(RootDir.str() + "/json", JSONPath);
+ SmallString<128> JSONDirPath(RootDir);
+ sys::path::append(JSONDirPath, "json");
+ if (auto EC = sys::fs::create_directories(JSONDirPath))
+ return createFileError(JSONDirPath, EC);
+ SmallString<128> DocsDirPath(RootDir);
+ sys::path::append(DocsDirPath, DirName);
+ if (auto EC = sys::fs::create_directories(DocsDirPath))
+ return createFileError(DocsDirPath, EC);
{
llvm::TimeTraceScope TS("Iterate JSON files");
std::error_code EC;
- sys::fs::recursive_directory_iterator JSONIter(JSONPath, EC);
+ sys::fs::recursive_directory_iterator JSONIter(JSONDirPath, EC);
std::vector<json::Value> JSONFiles;
JSONFiles.reserve(Infos.size());
if (EC)
return createStringError("Failed to create directory iterator.");
- SmallString<128> DocsDirPath(RootDir.str() + '/' + DirName);
- sys::path::native(DocsDirPath);
- if (auto EC = sys::fs::create_directories(DocsDirPath))
- return createFileError(DocsDirPath, EC);
while (JSONIter != sys::fs::recursive_directory_iterator()) {
// create the same directory structure in the docs format dir
if (JSONIter->type() == sys::fs::file_type::directory_file) {
SmallString<128> DocsClonedPath(JSONIter->path());
- sys::path::replace_path_prefix(DocsClonedPath, JSONPath, DocsDirPath);
+ sys::path::replace_path_prefix(DocsClonedPath, JSONDirPath,
+ DocsDirPath);
if (auto EC = sys::fs::create_directories(DocsClonedPath)) {
return createFileError(DocsClonedPath, EC);
}
@@ -134,7 +137,7 @@ Error MustacheGenerator::generateDocumentation(
std::error_code FileErr;
SmallString<128> DocsFilePath(JSONIter->path());
- sys::path::replace_path_prefix(DocsFilePath, JSONPath, DocsDirPath);
+ sys::path::replace_path_prefix(DocsFilePath, JSONDirPath, DocsDirPath);
sys::path::replace_extension(DocsFilePath, DirName);
raw_fd_ostream InfoOS(DocsFilePath, FileErr, sys::fs::OF_None);
if (FileErr)
diff --git a/clang-tools-extra/test/clang-doc/DR-131697.cpp b/clang-tools-extra/test/clang-doc/DR-131697.cpp
index 9025bbf910813..06168e6642f62 100644
--- a/clang-tools-extra/test/clang-doc/DR-131697.cpp
+++ b/clang-tools-extra/test/clang-doc/DR-131697.cpp
@@ -1,6 +1,7 @@
// RUN: rm -rf %t && mkdir -p %t
// RUN: split-file %s %t
// RUN: clang-doc -format=html %t/compile_commands.json %t/main.cpp
+// RUN: clang-doc -format=mustache %t/compile_commands.json %t/main.cpp
//--- main.cpp
|
ilovepi
approved these changes
Dec 1, 2025
evelez7
force-pushed
the
users/evelez7/clang-doc-fix-enum-indentation
branch
from
6705300 to
fdf9479
Compare
evelez7
force-pushed
the
users/evelez7/clang-doc-mustache-dr131697
branch
from
f55da9f to
3589489
Compare
Base automatically changed from
users/evelez7/clang-doc-fix-enum-indentation
to
main
December 4, 2025 17:41
evelez7
force-pushed
the
users/evelez7/clang-doc-mustache-dr131697
branch
from
3589489 to
45b366a
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The test for DR 131697 only requires that clang-doc doesn't crash. There
is no documentation created. However, when using Mustache, clang-doc still expects certain
paths to exist, like the directory where assets are placed. In legacy
HTML, the
docsdirectory is still created and assets are placed thereregardless of there being any Infos to document. Mustache didn't do
this, so now we create
docs/jsonanddocs/htmleven if there isnothing to document.