This is an archive of the discontinued LLVM Phabricator instance.

Differential D143419

lit: Fix formatting in README.rst
ClosedPublic

Authored by tstellar on Feb 6 2023, 9:57 AM.

Details

Reviewers
mgorny
Commits
rGe6d670dc2b52: lit: Fix formatting in README.rst
Summary

This was preventing lit from being uploaded to pypi.

Diff Detail

Event Timeline

tstellar created this revision.Feb 6 2023, 9:57 AM
Herald added a project: Restricted Project. · View Herald TranscriptFeb 6 2023, 9:57 AM
Herald added a subscriber: delcypher. · View Herald Transcript
tstellar requested review of this revision.Feb 6 2023, 9:57 AM
Herald added a project: Restricted Project. · View Herald TranscriptFeb 6 2023, 9:57 AM
Harbormaster completed remote builds in B212152: Diff 495193.Feb 6 2023, 12:35 PM
mgorny requested changes to this revision.Feb 23 2023, 7:28 AM
mgorny added inline comments.
llvm/utils/lit/README.rst
44

The problem is that actually it isn't interpreted as code block. If you add a second colon after the preceding paragraph, the snippet is processed correctly.

This revision now requires changes to proceed.Feb 23 2023, 7:28 AM
tstellar updated this revision to Diff 505425.Mar 15 2023, 3:24 AM

Better fix for formatting.

mgorny accepted this revision.Mar 15 2023, 4:10 AM

LGTM. Thanks!

This revision is now accepted and ready to land.Mar 15 2023, 4:10 AM
This revision was landed with ongoing or failed builds.Mar 15 2023, 4:19 AM
Closed by commit rGe6d670dc2b52: lit: Fix formatting in README.rst (authored by tstellar). · Explain Why
This revision was automatically updated to reflect the committed changes.
tstellar added a commit: rGe6d670dc2b52: lit: Fix formatting in README.rst.
Harbormaster completed remote builds in B219588: Diff 505425.Mar 15 2023, 4:50 AM

Revision Contents

PathSize
llvm/
utils/
lit/
2 lines

Diff 505436

llvm/utils/lit/README.rst

Show All 35 Lines
Contributing to lit Contributing to lit
=================== ===================
Please browse the issues labeled *tools:llvm-lit* in LLVM's issue tracker for Please browse the issues labeled *tools:llvm-lit* in LLVM's issue tracker for
ideas on what to work on: ideas on what to work on:
https://github.com/llvm/llvm-project/labels/tools%3Allvm-lit https://github.com/llvm/llvm-project/labels/tools%3Allvm-lit
Before submitting patches, run the test suite to ensure nothing has regressed: Before submitting patches, run the test suite to ensure nothing has regressed::
mgornyUnsubmitted
Not Done
ReplyInline Actions
https://github.com/llvm/llvm-project/labels/tools%3Allvm-lit
- Before submitting patches, run the test suite to ensure nothing has regressed:
+ Before submitting patches, run the test suite to ensure nothing has regressed::
# From within your LLVM source directory.

The problem is that actually it isn't interpreted as code block. If you add a second colon after the preceding paragraph, the snippet is processed correctly.

mgorny: The problem is that actually it isn't interpreted as code block. If you add a second colon…
# From within your LLVM source directory. # From within your LLVM source directory.
utils/lit/lit.py \ utils/lit/lit.py \
--path /path/to/your/llvm/build/bin \ --path /path/to/your/llvm/build/bin \
utils/lit/tests utils/lit/tests
Note that lit's tests depend on ``not`` and ``FileCheck``, LLVM utilities. Note that lit's tests depend on ``not`` and ``FileCheck``, LLVM utilities.
You will need to have built LLVM tools in order to run lit's test suite You will need to have built LLVM tools in order to run lit's test suite
Show All 17 Lines