codespell

.github/workflows/codespell.yml

@@ -0,0 +1,30 @@
+name: Spell Check
+
+on:
+  push:
+    paths-ignore:
+      - test
+      - bundle
+      - .ci
+      - "**/.db"
+  pull_request:
+    paths-ignore:
+      - test
+      - bundle
+      - .ci
+      - "**/.db"
+  workflow_dispatch:
+
+jobs:
+  codespell:
+    name: Spell Check
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Apt
+      run: |
+        sudo apt-get update
+        sudo apt-get -y install codespell
+    - name: codespell
+      run: git ls-files | grep -vE 'test|bundle|.ci|.\db' | xargs codespell -I .ci-local/codespell.dic

documentation/client.rst

@@ -252,7 +252,7 @@ Secondly, to provide certain well-known options to modify the operation.
 The pvRequest conditions may be specified in three ways through the methods of `pvxs::client::detail::CommonBuilder`
 exposed through the individual \*Builder types.
 
-Programatic
+Programmatic
     The field() and record() methods.
 
 Textual

documentation/nt.rst

@@ -69,7 +69,7 @@ alarm_t
 
     The meaning of Minor and Major are contextual and may be different for each PV.
     An Invalid alarm severity means that the value field should not be taken as
-    a meaningful represention of eg. the quantity being measured.  Typically,
+    a meaningful representation of eg. the quantity being measured.  Typically,
     it reflects the most recent valid value.
 
     A UI client may change the state of a widget displaying a value which is alarming

documentation/ntscalar.rst

@@ -6,7 +6,7 @@ NTScalar and NTScalarArray
 
 The ``epics:nt/NTScalar:1.0`` and related ``epics:nt/NTScalarArray:1.0``
 definitions describe a primary 'value' and supporting meta-data.
-In the case of NTScalarArray the value is a 1-d array of primative type.
+In the case of NTScalarArray the value is a 1-d array of primitive type.
 In the case of NTScalar the value is a single primitive value.
 
 Both variants include time and alarm meta-data fields,

documentation/releasenotes.rst

@@ -154,7 +154,7 @@ Release Notes
 * PVXS now attempts to fanout unicast searches through the loopback interface, and
   to handle ``CMD_ORIGIN_TAG`` messages (aka. the local multicast hack).
 * Add `pvxs::client::Context::discover` to enumerate and track PVA Servers.
-* ``pvxlist`` add "continous" mode.  (eg. ``pvxlist -v -w 0``)
+* ``pvxlist`` add "continuous" mode.  (eg. ``pvxlist -v -w 0``)
   To immediately Discover new servers, then continue listening for Beacons to detect
   as server go up and down (like ``casw``).
   Also, to be gentler on your network, add ``-P`` to skip initial Discovery ping,

documentation/server.rst

@@ -46,12 +46,12 @@ Entries naming multiple :ref:`environ` will prefer the left most which is set.
 eg. ``EPICS_PVA_ADDR_LIST`` is only checked if ``EPICS_PVAS_BEACON_ADDR_LIST`` is unset.
 
 EPICS_PVAS_INTF_ADDR_LIST
-    Space seperated list of local interface addresses to which the server will bind.
+    Space separated list of local interface addresses to which the server will bind.
     Port numbers are parsed and ignore.
     Sets `pvxs::server::Config::interfaces`
 
 EPICS_PVAS_BEACON_ADDR_LIST or EPICS_PVA_ADDR_LIST
-    Space seperated list of unicast or broadcast addresses.
+    Space separated list of unicast or broadcast addresses.
     This list is supplimented all local broadcast addresses if auto-beacon is YES.
     Sets `pvxs::server::Config::beaconDestinations`
 
@@ -61,7 +61,7 @@ EPICS_PVAS_AUTO_BEACON_ADDR_LIST or EPICS_PVA_AUTO_ADDR_LIST
 
 EPICS_PVAS_SERVER_PORT or EPICS_PVA_SERVER_PORT
     Single integer.
-    Prefered TCP port to bind.
+    Preferred TCP port to bind.
     If already in use then a random port will be chosen.
     Sets `pvxs::server::Config::tcp_port`
 
@@ -72,7 +72,7 @@ EPICS_PVAS_BROADCAST_PORT or EPICS_PVA_BROADCAST_PORT
     Sets `pvxs::server::Config::udp_port`
 
 EPICS_PVAS_IGNORE_ADDR_LIST
-    Space seperated list of addresses with optional port.
+    Space separated list of addresses with optional port.
     Port zero is treated as a wildcard to match any port.
     UDP traffic from matched addresses will be ignored with no further processing.
 

documentation/typedef.rst

@@ -13,7 +13,7 @@ as well as arrays of either.
 The `pvxs::TypeCode::code_t` enum is an exhaustive list of all valid types,
 as well as Null.
 
-Any valid type may be instanciate directly.
+Any valid type may be instantiate directly.
 
 .. code-block:: c++
 

documentation/util.rst

@@ -32,7 +32,7 @@ through the environment variable **$PVXS_LOG** by calling `pvxs::logger_config_e
 
 .. doxygenfunction:: pvxs::logger_config_env()
 
-If this is undesireable, logger levels may be (reset) manually.
+If this is undesirable, logger levels may be (reset) manually.
 
 .. doxygenfunction:: pvxs::logger_level_set(const char *, Level)
 

ioc/field.h

@@ -42,7 +42,7 @@ public:
     // points to storage in containing Group::fields
     std::vector<Field*> triggers;
 
-    // only for Meta mapping.  type infered from dbChannelFinalFieldType()
+    // only for Meta mapping.  type inferred from dbChannelFinalFieldType()
     Value anyType;
 
     Field(const FieldDefinition& def);

ioc/iochooks.cpp

@@ -432,7 +432,7 @@ bool enable2() {
                enable ? "ENABLED" : "disabled");
 
         if(!permit) {
-            printf("      Not permitted due to confict with QSRV1.\n"
+            printf("      Not permitted due to conflict with QSRV1.\n"
                    "      Remove qsrv.dbd from IOC.\n");
         }
     }

ioc/pvalink.h

@@ -114,7 +114,7 @@ struct linkGlobal_t final : private epicsThreadRunable {
 
     // a tuple of channel name and printed pvRequest (or Monitor)
     typedef std::pair<std::string, std::string> channels_key_t;
-    // pvaLinkChannel dtor prunes dead entires
+    // pvaLinkChannel dtor prunes dead entries
     typedef std::map<channels_key_t, std::weak_ptr<pvaLinkChannel> > channels_t;
     // Cache of active Channels (really about caching Monitor)
     channels_t channels;

qsrv/softMain.cpp

@@ -67,7 +67,7 @@ void usage(const char *arg0, const std::string& base_dbd) {
                "    -D <dbd>  If used, must come first. Specify the path to the softIoc.dbdfile."
                "        The compile-time install location is saved in the binary as a default.\n"
                "\n"
-               "    -h  Print this mesage and exit.\n"
+               "    -h  Print this message and exit.\n"
                "\n"
                "    -V  Print version and exit.\n"
                "\n"

src/bitmask.h

@@ -61,7 +61,7 @@ BitAnd<BitBase<Lhs>, BitBase<Rhs>>
 operator &(const BitBase<Lhs>& lhs, const BitBase<Rhs>& rhs)
 {
     if(lhs.size()!=rhs.size())
-        throw std::logic_error("op size mis-match"); // this sucks, need to figure out a way to handle different size input
+        throw std::logic_error("op size mismatch"); // this sucks, need to figure out a way to handle different size input
     return BitAnd<BitBase<Lhs>, BitBase<Rhs>>{lhs, rhs};
 }
 
@@ -82,7 +82,7 @@ BitOr<BitBase<Lhs>, BitBase<Rhs>>
 operator |(const BitBase<Lhs>& lhs, const BitBase<Rhs>& rhs)
 {
     if(lhs.size()!=rhs.size())
-        throw std::logic_error("op size mis-match");
+        throw std::logic_error("op size mismatch");
     return BitOr<BitBase<Lhs>, BitBase<Rhs>>{lhs, rhs};
 }
 

src/clientget.cpp

@@ -54,7 +54,7 @@ struct PRBase::Args
         for(auto& name : names) {
             auto it = values.find(name);
             if(it==values.end())
-                throw std::logic_error("uriArgs() names vs. values mis-match");
+                throw std::logic_error("uriArgs() names vs. values mismatch");
 
             auto& value = it->second.first;
 

src/log.cpp

@@ -285,8 +285,8 @@ Level logger::init()
 void xerrlogHexPrintf(const void *buf, size_t buflen)
 {
     const auto cbuf = static_cast<const uint8_t*>(buf);
-    bool elipsis = buflen > 64u;
-    if(elipsis)
+    bool ellipsis = buflen > 64u;
+    if(ellipsis)
         buflen = 64u;
 
     // whole buffer
@@ -318,7 +318,7 @@ void xerrlogHexPrintf(const void *buf, size_t buflen)
 
         errlogPrintf("%04x : %s %s %s %s\n", addr, buf[0], buf[1], buf[2], buf[3]);
     }
-    if(elipsis)
+    if(ellipsis)
         errlogPrintf("...\n");
 }
 

src/pvaproto.h

@@ -172,7 +172,7 @@ inline void _to_wire(Buffer& buf, const uint8_t *mem, bool reverse, const char *
         return;
 
     } else if(reverse) {
-        // byte order mis-match
+        // byte order mismatch
         for(unsigned i=0; i<N; i++) {
             buf[N-1-i] = mem[i];
         }
@@ -192,7 +192,7 @@ inline void _from_wire(Buffer& buf, uint8_t *mem, bool reverse, const char *fnam
         return;
 
     } else if(reverse) {
-        // byte order mis-match
+        // byte order mismatch
         for(unsigned i=0; i<N; i++) {
             mem[i] = buf[N-1-i];
         }

src/pvxs/server.h

@@ -162,7 +162,7 @@ struct PVXS_API Config {
     std::vector<std::string> ignoreAddrs;
     //! Addresses (**not** host names) to which (UDP) beacons message will be sent.
     //! May include broadcast and/or unicast addresses.
-    //! Supplemented iif auto_beacon==true
+    //! Supplemented only if auto_beacon==true
     std::vector<std::string> beaconDestinations;
     //! TCP port to bind.  Default is 5075.  May be zero.
     unsigned short tcp_port = 5075;

src/pvxs/source.h

@@ -62,7 +62,7 @@ struct MonitorStat {
     size_t maxQueue=0;
     //! Negotiated limit on nQueue
     size_t limitQueue=0;
-    //! Number of updates squashed during post() calss
+    //! Number of updates squashed during post() calls
     //! @since 1.2.0
     size_t nSquash=0;
 

src/pvxs/version.h

@@ -77,7 +77,7 @@ unsigned long version_abi_int();
 
 /** Runtime ABI check.
  *
- * This test is only meaningful if it is preformed prior to any
+ * This test is only meaningful if it is performed prior to any
  * other library calls.
  *
  * It is guaranteed that the library has no global constructors.

test/benchdata.cpp

@@ -83,7 +83,7 @@ void benchAllocNTScalar()
 
     constexpr size_t niter = 1000u;
 
-    const Value protoype(nt::NTScalar{TypeCode::UInt64, true, true, true}.create());
+    const Value prototype(nt::NTScalar{TypeCode::UInt64, true, true, true}.create());
 
     std::vector<Value> can(niter);
 
@@ -93,7 +93,7 @@ void benchAllocNTScalar()
         StopWatch W;
 
         (void)W.click();
-        can[n] = protoype.cloneEmpty();
+        can[n] = prototype.cloneEmpty();
         S.sample(W.click());
     }
 

test/testpvalink.cpp

@@ -473,7 +473,7 @@ namespace {
         testdbGetFieldEqual("enum:tgt:s", DBR_STRING, "one");
         // not clear how to handle this case, where a string is
         // read as DBR_USHORT, which is actually as DBF_ENUM
-        testTodoBegin("Not yet implimented");
+        testTodoBegin("Not yet implemented");
         testdbGetFieldEqual("enum:tgt:b", DBR_STRING, "one");
         testTodoEnd();
     }

tools/mshim.cpp

@@ -242,8 +242,8 @@ int main(int argc, char *argv[])
         auto manager(UDPManager::instance());
         std::vector<std::unique_ptr<UDPListener>> listeners;
 
-        auto onS = [&app](const UDPManager::Search& msg) {app.onSearch(msg);};
-        auto onB = [&app](const UDPManager::Beacon& msg) {app.onBeacon(msg);};
+        auto onSearch = [&app](const UDPManager::Search& msg) {app.onSearch(msg);};
+        auto onBeacon = [&app](const UDPManager::Beacon& msg) {app.onBeacon(msg);};
 
         {
             int opt;
@@ -252,8 +252,8 @@ int main(int argc, char *argv[])
                 case 'L':
                 {
                     SockEndpoint ep(parseEP(optarg, conf));
-                    listeners.push_back(manager.onSearch(ep, onS));
-                    listeners.push_back(manager.onBeacon(ep, onB));
+                    listeners.push_back(manager.onSearch(ep, onSearch));
+                    listeners.push_back(manager.onBeacon(ep, onBeacon));
                     break;
                 }
                 case 'F':