diff options
| author | Sergio Martins <smartins@kde.org> | 2019-05-13 10:17:47 +0100 |
|---|---|---|
| committer | Sergio Martins <smartins@kde.org> | 2019-05-13 10:17:47 +0100 |
| commit | 57888024f0316bab5e530648348c8cc684e6e02d (patch) | |
| tree | c4758716ad5f38b94631dbcc105cd7532afb2057 | |
| parent | 73f8700b4b2a4c191d5488e2dc209aa227798b00 (diff) | |
Remove mention of CLAZY_FIXIT from the READMEs
The manpage is left, but that has many other things to be rewritten.
| -rw-r--r-- | docs/checks/README-auto-unexpected-qstringbuilder.md | 2 | ||||
| -rw-r--r-- | docs/checks/README-function-args-by-ref.md | 3 | ||||
| -rw-r--r-- | docs/checks/README-old-style-connect.md | 4 | ||||
| -rw-r--r-- | docs/checks/README-qstring-allocations.md | 7 | ||||
| -rw-r--r-- | docs/checks/README-qstring-ref.md | 3 |
5 files changed, 6 insertions, 13 deletions
diff --git a/docs/checks/README-auto-unexpected-qstringbuilder.md b/docs/checks/README-auto-unexpected-qstringbuilder.md index 0c9e8143..947535ed 100644 --- a/docs/checks/README-auto-unexpected-qstringbuilder.md +++ b/docs/checks/README-auto-unexpected-qstringbuilder.md @@ -13,4 +13,4 @@ Also warns for lambdas returning `QStringBuilder`. #### Fixits - export CLAZY_FIXIT="fix-auto-unexpected-qstringbuilder" +This check supports a fixit to rewrite your code. See the README.md on how to enable it. diff --git a/docs/checks/README-function-args-by-ref.md b/docs/checks/README-function-args-by-ref.md index 8f78b386..55c2fb6e 100644 --- a/docs/checks/README-function-args-by-ref.md +++ b/docs/checks/README-function-args-by-ref.md @@ -7,9 +7,8 @@ This check will ignore shared pointers, you're on your own. Most of the times pa #### Fixits -This check supports adding missing `&` or `const-&` with: - export CLAZY_FIXIT="fix-function-args-by-ref" +This check supports adding missing `&` or `const-&`. See the README.md on how to enable it. - [1] <http://www.macieira.org/blog/2012/02/the-value-of-passing-by-value/> diff --git a/docs/checks/README-old-style-connect.md b/docs/checks/README-old-style-connect.md index 2cad4e8d..b1ec0524 100644 --- a/docs/checks/README-old-style-connect.md +++ b/docs/checks/README-old-style-connect.md @@ -10,8 +10,8 @@ Here's however a non-exhaustive list of caveats you should be aware of: #### Fixits -You can convert the most simple cases with `export CLAZY_FIXIT=fix-old-style-connect`. -Be careful, as PMF is not a 100% drop-in replacement. +This check supports a fixit to rewrite your code to the new connect syntax. See the README.md on how to enable it. +Be careful, as PMF is not a 100% drop-in replacement and the fixit might introduce bugs. #### Pitfalls diff --git a/docs/checks/README-qstring-allocations.md b/docs/checks/README-qstring-allocations.md index 22645b43..c156353a 100644 --- a/docs/checks/README-qstring-allocations.md +++ b/docs/checks/README-qstring-allocations.md @@ -30,12 +30,7 @@ Here's a summary of usages that allocate: #### Fixits - fix-qlatin1string-allocations // To replace QLatin1String with QStringLiteral only where it was allocating before - fix-fromLatin1_fromUtf8-allocations // To replace fromLatin1() and fromUtf8() so it doesn't allocate - fix-fromCharPtrAllocations // To replace raw string literals so it doesn't allocate - - Example: - export CLAZY_FIXIT="fix-fromCharPtrAllocations" +This check supports a fixit to rewrite your code. See the README.md on how to enable it. #### Pitfalls diff --git a/docs/checks/README-qstring-ref.md b/docs/checks/README-qstring-ref.md index 7dcf05e8..98b77dd0 100644 --- a/docs/checks/README-qstring-ref.md +++ b/docs/checks/README-qstring-ref.md @@ -13,5 +13,4 @@ And `toInt()` can be any of: `compare`, `contains`, `count`, `startsWith`, `ends #### FixIts -Fixing the above cases can be automated with: -`export CLAZY_FIXIT="fix-missing-qstringref"` +This check supports a fixit to rewrite your code. See the README.md on how to enable it. |