This is an archive of the discontinued LLVM Phabricator instance.

[1/4][mlir][doc] Fix links and references in documentation of Dialects
ClosedPublic

Authored by zero9178 on May 24 2021, 4:53 AM.

Details

Summary

This patch is the first in a series of patches fixing markdown links and references inside the mlir documentation. I chose to split it in a few reviews to be able to iterate quicker and to ease review.

This patch addresses all broken references to other markdown files and sections inside the Dialects folder.

One change that was also done was to insert '/' between the markdown files and section:
Example:
Builtin.md#integertype
was changed to:
Builtin.md/#integertype

After compilation, hugo then translates the later to jump directly to the integer type section, but not the former. Not inserting the slash would simply jump to just the Builtin page, instead of the to the integertype section. I therefore changed occurrences of the former version to the later as well.

Depends on https://reviews.llvm.org/D103013

Diff Detail

Event Timeline

zero9178 created this revision.May 24 2021, 4:53 AM
zero9178 requested review of this revision.May 24 2021, 4:53 AM
zero9178 added inline comments.May 24 2021, 4:54 AM
mlir/docs/Dialects/SPIR-V.md
1399

MlirFloatType seems to have been unused. Neither do I know which section it is supposed to map to as there is no one floating point type in Builtin. I therefore chose to remove it.

zero9178 retitled this revision from [mlir][doc] Fix links and references in documentation of Dialects to [1/4][mlir][doc] Fix links and references in documentation of Dialects.
ftynse added inline comments.May 24 2021, 6:33 AM
mlir/docs/Dialects/Linalg.md
40

I see that this is prior-art-namea is indeed the anchor name produced by Hugo, but could we rather fix that instead of perpetuating such bad anchors? This one in particular is due to the source file having <a name=""></a> in the header for some reason - https://github.com/llvm/llvm-project/blame/main/mlir/docs/Rationale/RationaleLinalgDialect.md#L115 - I suppose the intention was to use manually-specified anchors, but it doesn't seem to play well with the generator.

zero9178 updated this revision to Diff 347385.May 24 2021, 7:25 AM

Addressed Review comments.

Used the name prior-art instead of the badly auto generated one.
Change to the title in RationaleLinalgDialect.md is part of https://reviews.llvm.org/D103013 which this differential now depends on.

zero9178 marked an inline comment as done.May 24 2021, 7:26 AM
zero9178 edited the summary of this revision. (Show Details)
ftynse accepted this revision.May 25 2021, 12:30 AM

Thanks!

This revision is now accepted and ready to land.May 25 2021, 12:30 AM