This is an archive of the discontinued LLVM Phabricator instance.

[libc++] Fix the documentation and re-enable documentation CI
ClosedPublic

Authored by ldionne on Jan 9 2022, 11:41 AM.

Details

Reviewers
None
Group Reviewers
Restricted Project
Commits
rG49b9b9dc9c96: [libc++] Fix the documentation and re-enable documentation CI
Summary

The documentation CI job is very cheap, so we can afford to keep it
around even with reduced capacity. This commit fixes the documentation
(which had an invalid reference in it) and re-enables that CI step.

Diff Detail

Event Timeline

ldionne created this revision.Jan 9 2022, 11:41 AM
ldionne requested review of this revision.Jan 9 2022, 11:41 AM
Herald added a project: Restricted Project. · View Herald TranscriptJan 9 2022, 11:41 AM
Herald added a reviewer: Restricted Project. · View Herald Transcript
tschuett added inline comments.
libcxx/docs/index.rst
201

LLVM is moving fast. Do you want to hint at GitHub? There are still bugzilla references in this document,

Quuxplusone added inline comments.
libcxx/docs/index.rst
160

https://github.com/llvm/llvm-project/issues?q=label%3Alibc%2B%2B

ldionne marked an inline comment as done.Jan 10 2022, 5:01 AM
ldionne added inline comments.
libcxx/docs/index.rst
201

I don't see any references to Bugzilla except for what @Quuxplusone caught above. Did you spot any others?

I think it's OK not to go out of our way to mention GitHub in case that changes in the future, and given that it doesn't add a lot of useful information. They'll see that it's on GitHub when/if they click on the link.

ldionne updated this revision to Diff 398586.Jan 10 2022, 5:06 AM

Remove link to bugzilla

This revision was not accepted when it landed; it landed in state Needs Review.Jan 10 2022, 5:06 AM
This revision was landed with ongoing or failed builds.
This revision was automatically updated to reflect the committed changes.
curdeius added inline comments.
ldionne marked an inline comment as done.Jan 10 2022, 5:33 AM
ldionne added inline comments.
libcxx/docs/index.rst
160

Yes, you're right, that seems a bit better. Thanks, doing as post-commit fix.