github.com/osrg/gobgp/v3@v3.30.0/tools/spell-check/README.md (about)

     1  # What's this
     2  
     3  This script is a spell checker for GoBGP's source codes.
     4  
     5  ## Requirements
     6  
     7  - [scspell3k](https://pypi.python.org/pypi/scspell3k): Spell checker for
     8    source code written in Python.
     9  
    10    ```bash
    11    pip install scspell3k
    12    ```
    13  
    14  ## How to use
    15  
    16  Just run `scspell.sh`.
    17  
    18  ```bash
    19  bash tools/spell-check/scspell.sh
    20  ```
    21  
    22  Example of output:
    23  
    24  ```bash
    25  # Format:
    26  # path/to/file.go: <messages>
    27  xxx/xxx.go: 'mispeld' not found in dictionary (from token 'Mispeld')
    28  ```
    29  
    30  ## Adding new words to dictionary
    31  
    32  If you want to add new words to the dictionary for this spell checker, please
    33  insert words into `tools/spell-check/dictionary.txt` or
    34  `tools/spell-check/ignore.txt`.