[docs] don't use "=" in lit options with arguments

[kwk]

This is a fixup for #141851 and removes = from all
options with additional arguments.

Before 14 out of 22 options with arguments used "=" and 7 didn't.

[llvmbot]

@llvm/pr-subscribers-testing-tools

Author: Konrad Kleine (kwk)

Changes

This is a fixup for #141851.

---

Full diff: https://github.com/llvm/llvm-project/pull/142340.diff

1 Files Affected:

• (modified) llvm/docs/CommandGuide/lit.rst (+1-1)

diff --git a/llvm/docs/CommandGuide/lit.rst b/llvm/docs/CommandGuide/lit.rst
index 86879f870e06e..7f2ea6b82a716 100644
--- a/llvm/docs/CommandGuide/lit.rst
+++ b/llvm/docs/CommandGuide/lit.rst
@@ -218,7 +218,7 @@ EXECUTION OPTIONS
 
  Stop execution after the given number of failures.
 
-.. option:: --max-retries-per-test N
+.. option:: --max-retries-per-test=N
 
  Retry running failed tests at most ``N`` times.
  Out of the following options to rerun failed tests the

[nikic]

It seems like the docs use a mix of both styles -- should we normalize to one or the other for all options?

[kwk]

It seems like the docs use a mix of both styles -- should we normalize to one or the other for all options?

Oh, indeed. I must say in terms of readability I like the one without the = better.

Here are some stats:

• There are 53 options in the file
  • grep '.. option::' llvm/docs/CommandGuide/lit.rst | wc -l
• There are 22 options with additional arguments (e.g. in capital letters)
  • grep '.. option::' llvm/docs/CommandGuide/lit.rst | grep -P '[A-Z=]' | wc -l
• Out of the 22 options with arguments, there are 14 options that use "=" and 7 that use no "=".
  • grep '.. option::' llvm/docs/CommandGuide/lit.rst | grep -P '[A-Z]' | grep "=" | wc -l
  • grep '.. option::' llvm/docs/CommandGuide/lit.rst | grep -P '[A-Z]' | grep -v "=" | wc -l

That means the majority of options with additional arguments uses =.

Consistency wise we should probably use = for this PR and the rest as well. I've changed this PR accordingly.

[nikic]

The print text that lit itself prints uses whitespace instead of =, so I'd be inclined to normalize the other way around...

[nikic]

Hm, -o=PATH looks quite unusual.

[kwk]

It does.

[kwk]

The print test that lit itself prints uses whitespace instead of =, so I'd be inclined to normalize the other way around...

Like I said, this would have been my favourable way too but I went with the majority of what was in the file. Let me work on this real quick.

[kwk]

@nikic can you recheck?

[nikic]

Is this change correct? I think = here is part of the parameter argument.

[kwk]

I am a lousy programmer it seems. But luckily you're a great reviewer. You're absolutely right. This HAS to stay.

[kwk]

This is fixed now.

[nikic]

LGTM, this matches llvm-lit --help.