This is an archive of the discontinued LLVM Phabricator instance.

[Docs] Remove old HTML related comment from Passes documentation
ClosedPublic

Authored by aidengrossman on Aug 10 2023, 12:35 PM.

Details

Summary

This patch removes a comment at the top of the Passes.rst file which was
related to checking if the HTML documentation was up to date. It was
moved over as part of the original transition to restructured text and
never modified for some reason. Given that this comment has been
irrelevant for the past 10 years, it should be removed.

Diff Detail

Event Timeline

aidengrossman created this revision.Aug 10 2023, 12:35 PM
Herald added a project: Restricted Project. · View Herald TranscriptAug 10 2023, 12:35 PM
aidengrossman requested review of this revision.Aug 10 2023, 12:35 PM
Herald added a project: Restricted Project. · View Herald TranscriptAug 10 2023, 12:35 PM

Probably should write an updated version at some point (and maybe integrate it with Github actions) since there is a lot of code debt in the passes documentation currently, but I'll leave that for a future patch.

aeubanks added inline comments.Aug 10 2023, 2:10 PM
llvm/docs/Passes.rst
30

this line should stay?

aidengrossman marked an inline comment as done.

Address reviewer feedback.

llvm/docs/Passes.rst
30

It works either way. I deleted it as I was referencing some of the examples from llvm/docs/CommandGuide and none of them use it and it still generates the <h1> tag. I'll readd it to not make the diff any bigger than it needs to be and for consistency with the rest of the llvm/docs/* pages. I don't think there's a preferred way to do it in restructured text.

This revision is now accepted and ready to land.Aug 10 2023, 2:17 PM
This revision was landed with ongoing or failed builds.Aug 10 2023, 2:19 PM
This revision was automatically updated to reflect the committed changes.