From 380435c13a56231fa43145ffa6cfc3a31fc85ccf Mon Sep 17 00:00:00 2001
From: Sharpz7 <adam.mcarthur62@gmail.com>
Date: Fri, 26 Jan 2024 05:02:53 +0000
Subject: [PATCH] [codespell] Adding Tox Target for Codespell

Second in a series of commits to add Codespell to Ironic Repos. This one adds the command that was used to fix the spelling errors.

Future Commits will add CI support and potentially a git-blame-ignore-revs file if their are lots of spelling mistakes that could clutter git blame.

Change-Id: Ie5b066676b9058d7f4cb00fe279711834ca06720
---
 setup.cfg | 6 ++++++
 tox.ini   | 9 +++++++++
 2 files changed, 15 insertions(+)

diff --git a/setup.cfg b/setup.cfg
index 7a548f5b4..2ee46a2cc 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -135,3 +135,9 @@ openstack.baremetal.v1 =
 [extras]
 cli =
   python-openstackclient>=3.12.0 # Apache-2.0
+
+[codespell]
+quiet-level = 4
+# Words to ignore:
+# cna: Intel CNA card
+ignore-words-list = cna
\ No newline at end of file
diff --git a/tox.ini b/tox.ini
index 8fea6d20f..6cddf55cf 100644
--- a/tox.ini
+++ b/tox.ini
@@ -87,3 +87,12 @@ application-import-names = ironicclient
 
 [hacking]
 import_exceptions = testtools.matchers, ironicclient.common.i18n
+
+[testenv:codespell]
+description =
+  Run codespell to check spelling
+deps = codespell
+# note(JayF): {posargs} lets us run `tox -ecodespell -- -w` to get codespell
+#             to correct spelling issues in our code it's aware of.
+commands =
+  codespell {posargs}
\ No newline at end of file