Information on LIT is outdated

Below is out of date

pip install svn+https://llvm.org/svn/llvm-project/llvm/trunk/utils/lit

above command is mentioned here

it should just be

pip install lit

Can someone please update the page please?
Thank you!

Parts of our documentation are not up to date indeed.
Since you know what do you want to see there, can you open a PR at Pull requests · llvm/llvm-project · GitHub ?

2 Likes

Note that it is generally easiest to just use the llvm-lit from an LLVM build directory. But if you want/need to go the pip install route:

I think when I wrote that page the lit version on PyPi was not consistently updated so pip install lit would risk getting an outdated version that did not always work properly with the latest testsuite. Hence the complicated expression installing directly from the LLVM SVN repository. Glancing at pypi it seems someone is regularily uploading new version to pypi nowadays so maybe this situation has improved? Does someone know the details here? Is this updated automatically and daily if necessary or is there still a chance of it lagging behind?

FWIW the equivalent to install immediately from the git repository would be:
pip install git+https://github.com/llvm/llvm-project.git#subdirectory=llvm/utils/lit Though it is pretty slow with git now as it clones the complete repository just to install the handful of python files; I had to wait around ~10 minutes when I tried it just now…

Pull requests to update the documentation in llvm-project/llvm/doc/*.rst are always welcome!

3 Likes

And while at it: I would also recommend python3 -m venv <directory> nowadays instead of virtualenv <directory> (both will probably work, but the former comes already preinstalled with python3)

3 Likes

We update this regularly now after each LLVM release.

the updates are here:

is it possible for someone with the right credential to provide details on the failure?

buildkite/github-pull-requests — Build #33322 failed (6 hours, 44 minutes, 6 seconds)

also who else needs to approve the PR

1 workflow awaiting approval

This workflow requires approval from a maintainer. Learn more about approving workflows.3 successful and 1 failing checks

It’s a know issue with Windows CI, so not your fault. You can try to push an empty commit to trigger pipelines again.

So, when’s this getting merged? Became a recent victim to the outdated documentation guide, almost convinced infra to install svn for me (no sudo perms) before realizing pip install lit makes more sense.

I’ve just merged it.

If you want to add pip install as another method there, a PR to do that is welcome.

1 Like

Will make the PR once I have the time. Feel free to assign the issue to me (you can find me from this PR [clang-tidy] Create bugprone-incorrect-enable-shared-from-this check by MichelleCDjunaidi · Pull Request #102299 · llvm/llvm-project · GitHub) if you want; I’ll do it regardless. Cheers and thanks!

PR created here. [llvm][Docs] Update guide to include ``pip install lit`` by MichelleCDjunaidi · Pull Request #106526 · llvm/llvm-project · GitHub