[gdb/testsuite, tclint] Document some tclint issues in tclint.toml

While tclint-cleaning gdb testsuite directories I ran into a few issues, which
I filed upstream.  Mention them in gdb/tclint.toml.

diff --git a/gdb/tclint.toml b/gdb/tclint.toml
index 47c3ce459e6ca13ce808215b072cd974389535f6..62e522c1764938e3152ba8358a48bc1d9b49d181 100644 (file)
--- a/gdb/tclint.toml
+++ b/gdb/tclint.toml
@@ -13,7 +13,21 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-# Configuration file for tclint ( https://github.com/nmoroze/tclint ).
+# Configuration file for the tclint and tclfmt tools from the tclint package
+# ( https://github.com/nmoroze/tclint ).
+#
+# Eventually we'd like to move these settings to pyproject.toml, but currently
+# that's not possible.  See this tclint issue (
+# https://github.com/nmoroze/tclint/issues/120 ).
+#
+# Issues related to using the tclint tool in the gdb testsuite:
+# - tclint does not support expect.
+#   https://github.com/nmoroze/tclint/issues/118
+# - tclint doesn't inspect code passed as arguments to gdb testsuite specific
+#   commands like with_test_prefix.
+#   https://github.com/nmoroze/tclint/issues/121
+# - tclint ignores splat ({*}$foo) when checking number of arguments
+#   https://github.com/nmoroze/tclint/issues/122
 
 exclude = [
 # TODO: