Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bug 5021: Add a script to fix spelling errors with codespell #565

Closed
wants to merge 11 commits into from

Commits on Mar 4, 2020

  1. [Bug 5021] Add a script to fix spelling errors with codespell

    Run "scripts/spell-check.sh" from the Squid tree root directory.
    For details, see bug report 5021:
    - https://bugs.squid-cache.org/show_bug.cgi?id=5021
    
     Changes to be committed:
    	new file:   scripts/codespell-whitelist.txt
    	new file:   scripts/spell-check.sh
    
    (cherry picked from commit 0678534)
    mrumph committed Mar 4, 2020
    Configuration menu
    Copy the full SHA
    8a9f679 View commit details
    Browse the repository at this point in the history

Commits on Mar 5, 2020

  1. Bug 5021: Improve the spell check script

    Addressed comments from the pull request squid-cache#565.
    
     Changes to be committed:
    	modified:   scripts/spell-check.sh
    mrumph committed Mar 5, 2020
    Configuration menu
    Copy the full SHA
    bc08d0f View commit details
    Browse the repository at this point in the history

Commits on Mar 23, 2020

  1. Configuration menu
    Copy the full SHA
    acd49d3 View commit details
    Browse the repository at this point in the history
  2. fixup: DRY

    rousskov committed Mar 23, 2020
    Configuration menu
    Copy the full SHA
    0cf053f View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    5523abb View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    9b3822b View commit details
    Browse the repository at this point in the history
  5. Do process doc/*.txt files by default

    doc/HTTP-codes.txt has a spelling error.
    
    Still exclude doc/debug-sections.txt because it is generated.
    
    Still exclude doc/*/*.txt because they are imported/foreign.
    rousskov committed Mar 23, 2020
    Configuration menu
    Copy the full SHA
    f44a864 View commit details
    Browse the repository at this point in the history
  6. Whitelist tread to work around codespell inability to interpret \t

    I could not find any more cases where \x was misinterpreted (for any x).
    rousskov committed Mar 23, 2020
    Configuration menu
    Copy the full SHA
    37649dc View commit details
    Browse the repository at this point in the history
  7. Allow spell-check.sh to be applied to a subset of files

    This is very useful when working on a small subset of files because
    spell checking the whole tree takes a while:
    
        git diff $base --name-only | xargs ./scripts/spell-check.sh
    rousskov committed Mar 23, 2020
    Configuration menu
    Copy the full SHA
    2c18b64 View commit details
    Browse the repository at this point in the history

Commits on Mar 24, 2020

  1. fixup: Documented usage

    rousskov committed Mar 24, 2020
    Configuration menu
    Copy the full SHA
    94a2043 View commit details
    Browse the repository at this point in the history
  2. fixup: Clarified why folks need to stage workspace changes.

    The script cannot, technically, create "conflicts" (at least not in a
    git sense of that word). The script might wipe out or corrupt unstaged
    changes, and we want to protect users from that.
    
    A very useful side effect of our protection is that any script changes
    are very easy to _review_ using `git diff --word-diff`. Any developer
    ought to review codespell changes. The script itself is probably not the
    right place to document/discuss all that.
    rousskov committed Mar 24, 2020
    Configuration menu
    Copy the full SHA
    21a54ee View commit details
    Browse the repository at this point in the history