[clang-doc] The Mustache HTML output uses full file paths for links

[ilovepi]

These full paths break web pages if they're opened anywhere but the build machine, because the links are wrong. These should all be relative file paths.

Current HTML:

<a href="file:///usr/local/google/home/paulkirth/clang-doc-gen/@nonymous_record_00774ABA8C0A775DA34D65BFF8EE1967BE25FAE3.html">@nonymous_record_00774ABA8C0A775DA34D65BFF8EE1967BE25FAE3</a>

Corrected:

<a href="file:///@nonymous_record_00774ABA8C0A775DA34D65BFF8EE1967BE25FAE3.html">@nonymous_record_00774ABA8C0A775DA34D65BFF8EE1967BE25FAE3</a>

CC: @evelez7 I'm guessing this is somehow generated from the json paths. Do you know where in the JSONGenerator or the Mustache bits where the links are generated?

[llvmbot]

@llvm/issue-subscribers-bug

Author: Paul Kirth (ilovepi)

These full paths break web pages if they're opened anywhere but the build machine, because the links are wrong. These should all be relative file paths.

Current HTML:

&lt;a href="file:///usr/local/google/home/paulkirth/clang-doc-gen/@<!-- -->nonymous_record_00774ABA8C0A775DA34D65BFF8EE1967BE25FAE3.html"&gt;@<!-- -->nonymous_record_00774ABA8C0A775DA34D65BFF8EE1967BE25FAE3&lt;/a&gt;

Corrected:

&lt;a href="file:///@<!-- -->nonymous_record_00774ABA8C0A775DA34D65BFF8EE1967BE25FAE3.html"&gt;@<!-- -->nonymous_record_00774ABA8C0A775DA34D65BFF8EE1967BE25FAE3&lt;/a&gt;

CC: @evelez7 I'm guessing this is somehow generated from the json paths. Do you know where in the JSONGenerator or the Mustache bits where the links are generated?

[evelez7]

I think the culprit is in JSONGenerator::generateDocs.

llvm-project/clang-tools-extra/clang-doc/JSONGenerator.cpp

Lines 594 to 605 in 78b80a1

	Error JSONGenerator::generateDocs(
	StringRef RootDir, llvm::StringMap<std::unique_ptr<doc::Info>> Infos,
	const ClangDocContext &CDCtx) {
	StringSet<> CreatedDirs;
	StringMap<std::vector<doc::Info *>> FileToInfos;
	for (const auto &Group : Infos) {
	Info *Info = Group.getValue().get();
	SmallString<128> Path;
	auto RootDirStr = RootDir.str() + "/json";
	StringRef JSONDir = StringRef(RootDirStr);
	sys::path::native(JSONDir, Path);

I used the RootDir, which is the output command line arg, to create the file but that also gets appended to the name that's used for links in determineFileName.

llvm-project/clang-tools-extra/clang-doc/JSONGenerator.cpp

Line 590 in 78b80a1

sys::path::append(Path, FileName + ".json");

The Path in determineFileName should be able to be made relative without disturbing file creation, since the absolute path is added as the key in FileToInfos separately.

[ilovepi]

annoying. this is a difference between a webserver and opening a local file in a brower. if you use a webserver, the links are OK. not so much otherwise.

[ilovepi]

oh, I also think we're overwriting the main index.js after moving to flattened directories. I wonder if that's related to the weird links I saw? but in any case when I generate docs for clang, the clang's SymbolKind enum, and not the top level namespace. that's not related to this specifically, but its definitely an issue.