Jens Geyer created THRIFT-6220:
----------------------------------

             Summary: make style rewrites the whole tree with codespell, and 
its skip list names CHANGES rather than CHANGES.md
                 Key: THRIFT-6220
                 URL: https://issues.apache.org/jira/browse/THRIFT-6220
             Project: Thrift
          Issue Type: Bug
          Components: Build Process
            Reporter: Jens Geyer


The {{style-local}} target in the top-level {{Makefile.am}} is

{code}
codespell --write-changes --skip=$(skipped_files) --disable-colors
{code}

with no path, so {{make style}} rewrites every file in the tree that codespell 
has an opinion about. {{codespell_skip_files}} lists {{CHANGES}}, but the 
changelog is {{CHANGES.md}}, so that file is rewritten too.

It also cannot safely run unattended where codespell is wrong. In {{lib/d}}, 
for example, it would change the exception variable {{te}} in {{catch 
(TTransportException te)}}, the variable {{listin}} (paired with {{listout}}), 
and {{AAs}}, D's usual abbreviation for associative arrays.

The contribution guidelines ask for {{make style}} to pass, which in practice 
can only mean "scoped to the files you touched".

Suggested: add {{CHANGES.md}} to the skip list; make the default target 
check-only, or add a check-only target for CI; add an {{--ignore-words-list}} 
for known false positives such as the ones above.

_Drafted with AI assistance (Claude Opus 5); reviewed and filed by Jens Geyer._



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

Reply via email to