This is an archive of the discontinued LLVM Phabricator instance.

[lit] Deduplicate README and longdescription, and update it
ClosedPublic

Authored by mgorny on Oct 28 2022, 9:47 PM.

Details

Summary

Since long_description is effectively the README that's displayed
on pypi project page, combine it with the existing README file and read
the file in setup.py. This is a common practice among Python
projects, to the point of declarative-style setuptools configurations
providing a shorthand for it.

While at it, update the outdated information about LLVM Bugzilla for use
of GitHub issues.

Diff Detail

Event Timeline

mgorny created this revision.Oct 28 2022, 9:47 PM
Herald added a project: Restricted Project. · View Herald TranscriptOct 28 2022, 9:47 PM
mgorny requested review of this revision.Oct 28 2022, 9:47 PM
Herald added a project: Restricted Project. · View Herald TranscriptOct 28 2022, 9:47 PM
mgorny added inline comments.Oct 28 2022, 9:49 PM
llvm/utils/lit/README.rst
27

I've left the verbose URLs since this is how long_description previously did it. If you prefer, I can change them to proper ReST links.

I'm fine with the change. Thanks!

llvm/utils/lit/README.rst
41
This revision is now accepted and ready to land.Oct 28 2022, 11:28 PM
MaskRay accepted this revision.Oct 28 2022, 11:46 PM
MaskRay added inline comments.
llvm/utils/lit/README.rst
51
mgorny marked 2 inline comments as done.Oct 29 2022, 4:26 AM

Thanks!

This revision was landed with ongoing or failed builds.Oct 29 2022, 4:27 AM
This revision was automatically updated to reflect the committed changes.