Page MenuHomePhabricator

[docs] cleanup documentation on lit substitutions
ClosedPublic

Authored by bd1976llvm on Jan 30 2017, 6:50 AM.

Details

Summary
  1. Added missing substitutions to the documentation in docs/TestingGuide.rst
  2. Modified docs/CommandGuide/lit.rst to only document the "base" set of substitutions and to refer the reader to docs/TestingGuide.rst for more detailed info on substitutions.

Diff Detail

Repository
rL LLVM

Event Timeline

bd1976llvm created this revision.Jan 30 2017, 6:50 AM
davidb added a subscriber: davidb.Jan 30 2017, 6:56 AM
rengolin edited edge metadata.Jan 30 2017, 7:48 AM

I don't know enough about the Windows behaviour, but the move looks good to me.

docs/TestingGuide.rst
474 ↗(On Diff #86275)

From the old doc, it seems to be the other way round.

488 ↗(On Diff #86275)

I had no idea this worked at all! Then again, last time I used Windows was when it was still being launched from DOS.

bd1976llvm added inline comments.Jan 30 2017, 8:38 AM
docs/TestingGuide.rst
474 ↗(On Diff #86275)

I think that the new doc is correct. From the source code:

  1. "%/[STpst]" should be normalized. substitutions.extend([ ('%/s', escapedSourcePath.replace('\\', '/')),
474 ↗(On Diff #86275)

Well that came out badly :( The key point is that the code does this: replace('\\', '/')

488 ↗(On Diff #86275)

You have no idea what your missing out on :)

bd1976llvm added inline comments.Jan 30 2017, 8:42 AM
docs/TestingGuide.rst
488 ↗(On Diff #86275)

You have no idea what you're missing out on :)

rengolin added inline comments.Jan 30 2017, 8:58 AM
docs/TestingGuide.rst
474 ↗(On Diff #86275)

Right, this is in line with what I remembered, tbh.

rengolin accepted this revision.Feb 9 2017, 5:57 AM

No one shouted, so LGTM. Thanks! :)

This revision is now accepted and ready to land.Feb 9 2017, 5:57 AM
This revision was automatically updated to reflect the committed changes.