Documentation improvements

Description

--quiet

Do not deadlocks; only print errors and warnings to STDERR.

I believe it means to say “Do not print deadlocks to STDOUT”, am I correct?

 

I always get confused with how the “--no” works, and I believe the documentation could be improved to make that clearer.

For example:

--[no]drop-old-table

--[no]check-unique-key-change

This gives the impression that the negative options are to be written as:

--nodrop-old-table

--nocheck-unique-key-change

When in fact, they should be written as:

--no-drop-old-table

--no-check-unique-key-change

So I’d suggest for the documentation to add a “-”, showing them as:

--[no-]drop-old-table

--[no-]check-unique-key-change

 

Thanks!

Environment

None

Activity

Show:

Aaditya Dubey February 24, 2025 at 10:40 AM
Edited

Hi

Thank you for the report and feedback.
Our documentation indeed has room for improvement.
We are classifying this as an improvement instead of a bug.

Details

Assignee

Reporter

Priority

Needs QA

Yes

Smart Checklist

Created February 18, 2025 at 2:42 AM
Updated February 24, 2025 at 10:41 AM