[PATCH 1/2] [gdb] Document word regexp choice in pyproject.toml

[Tom de Vries <tdevries@suse.de>]

The codespell tool has an option regex that can be used to control what it
considered a word.

An open question is whether dropping dash or underscore from that regexp is a
good tradeoff in terms of amount of true and false positives.

Document this issue in detail in pyproject.toml.

Bug: https://sourceware.org/bugzilla/show_bug.cgi?id=34241
---
 gdb/pyproject.toml | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/gdb/pyproject.toml b/gdb/pyproject.toml
index 47704bb0048..32f14f13f3e 100644
--- a/gdb/pyproject.toml
+++ b/gdb/pyproject.toml
@@ -151,3 +151,13 @@ ignore-multiline-regex = 'codespell:ignore-begin.*?codespell:ignore-end'
 # Add 1 (disable warnings about wrong encoding) in addition to the default
 # 2+32 to skip warnings about iso-8859-1 encoded files.
 quiet-level = 35 # 1+2+32
+
+# For regex we currently use the default value, which since v2.2.6 corresponds
+# to: regex = '''[A-Za-z0-9_'’-]+''' .
+#
+# Dropping the underscore or dash exposes us to more true and false positives.
+# It remains to be seen whether that's a good tradeoff.
+#
+# A related issue ( https://github.com/codespell-project/codespell/issues/1508
+# ) is the fact that using a non-default regex is not compatible with -w, which
+# is a convenient way to fix codespell errors.

base-commit: 881f1e8384b69f2dcf832b29eb7cf8fe7a1fae1a
-- 
2.51.0