Add spellcheck GHA (#27)

.github/workflows/markdown.yml

@@ -0,0 +1,19 @@
+# SPDX-License-Identifier: Apache-2.0
+# Copyright 2023 Intel Corporation
+
+name: Spellcheck
+on:
+  - pull_request
+
+jobs:
+  check-spelling:
+    name: Markdown spellcheck
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Check Spelling
+        uses: rojopolis/[email protected]
+        with:
+          config_path: .spellcheck.yml
+          task_name: Markdown

.gitignore

@@ -9,6 +9,7 @@ core/extra.dpdk.mk
 core/kmod/.cache.mk
 *.retry
 *.cache.mk
+dictionary.dic
 
 # Vagrant stores temporary files in env/.vagrant
 env/.vagrant
@@ -52,7 +53,9 @@ compile_commands.json
 # virtualenv
 venv/
 
-# Keep GitHub Actions, reuse, and clang-format file
+# Keep GitHub Actions, reuse, clang-format file and spellchecking files
 !.github
 !.reuse
 !.clang-format
+!.spellcheck.yml
+!.wordlist.txt

.spellcheck.yml

@@ -0,0 +1,31 @@
+# SPDX-License-Identifier: Apache-2.0
+# Copyright 2023 Intel Corporation
+
+matrix:
+- name: Markdown
+  # expect_match: false
+  apsell:
+    lang: en
+    # ignore-case: true
+  dictionary:
+    wordlists:
+    - .wordlist.txt
+    # output: wordlist.dic
+    encoding: utf-8
+  pipeline:
+    - pyspelling.filters.markdown:
+        markdown_extensions:
+        - markdown.extensions.extra:
+    - pyspelling.filters.html:
+        comments: false
+        attributes:
+        - title
+        - alt
+        ignores:
+        - ':matches(code, pre)'
+        - 'code'
+        - 'pre'
+        - 'blockquote'
+  sources:
+  - '**/*.md'
+  default_encoding: utf-8

.wordlist.txt

@@ -0,0 +1,106 @@
+# SPDX-License-Identifier: Apache-2.0
+# Copyright 2023 Intel Corporation
+Ansible
+bess
+pre
+initializer
+protobuf
+RPC
+utils
+VM
+DPDK
+QEMU
+TXQ
+VMs
+dev
+hugepages
+io
+macswap
+testpmd
+vSwitch
+virtio
+py
+vm
+VPort
+vhost
+qcow
+NUMA
+datapath
+qemu
+kvm
+numactl
+Grunenberger
+Yan
+Asim
+Jamshed
+Alireza
+Sanaee
+Rozet
+Standt
+Ivanov
+Mussomele
+Sagie
+Torek
+Eran
+Gampel
+Lévai
+Tamás
+CLA
+PRs
+unittest
+Sangjin
+Jang
+Keon
+Aurojit
+Edupuganti
+Saikrishna
+Xiaoshuang
+Shinae
+Peng
+McCauley
+Amin
+Tootoonchian
+Lan
+Barath
+Raghavan
+Lala
+Situ
+Daniele
+Proietto
+di
+Felicián
+Németh
+LaTeX
+doxygen
+sudo
+CNDP
+bessctl
+cndp
+cndpfwd
+conf
+coreid
+ethtool
+jsonc
+netdev
+recv
+OpenFlow
+SoftNIC
+programmability
+Nefeli
+html
+dox
+Nefeli
+customizability
+XDP
+https
+cd
+besscndp
+runtime
+epc
+ghcr
+omec
+runnable
+upf
+env
+macOS
+vagrantup

README.md

@@ -1,6 +1,6 @@
 ## BESS (Berkeley Extensible Software Switch)
 
-BESS (formerly known as [SoftNIC](https://www2.eecs.berkeley.edu/Pubs/TechRpts/2015/EECS-2015-155.html)) is a modular framework for software switches. BESS itself is *not* a virtual switch; it is neither pre-configured nor hardcoded to provide particular functionality, such as Ethernet bridging or OpenFlow-driven switching. Instead, you (or an external controller) can *configure* your own packet processing datapath by composing small "modules". While the basic concept is similar to [Click](http://read.cs.ucla.edu/click/click), BESS does not sacrifice performance for programmability.
+BESS (formerly known as [SoftNIC](https://www2.eecs.berkeley.edu/Pubs/TechRpts/2015/EECS-2015-155.html)) is a modular framework for software switches. BESS itself is *not* a virtual switch; it is neither pre-configured nor hard-coded to provide particular functionality, such as Ethernet bridging or OpenFlow-driven switching. Instead, you (or an external controller) can *configure* your own packet processing datapath by composing small "modules". While the basic concept is similar to [Click](http://read.cs.ucla.edu/click/click), BESS does not sacrifice performance for programmability.
 
 BESS was created by Sangjin Han and is developed at the University of California, Berkeley and at Nefeli Networks. [Contributors to BESS](https://github.com/omec-project/bess/blob/master/CONTRIBUTING.md) include students, researchers, and developers who care about networking with high performance and high customizability. BESS is open-source under a BSD license.
 

bessctl/conf/port/vhost/README.md

@@ -38,7 +38,7 @@ VMs below.
 You can launch one or multiple VMs. Each VM runs `testpmd` that simply swaps
 source/destination MAC addresses of packets and forward them from one port to
 another. You must launch `vhost.bess` first, so that QEMU can connect to BESS
-vport sockets. Otherwise you will see an error like this:
+VPort sockets. Otherwise you will see an error like this:
 `qemu-system-x86_64: ... Failed to connect socket: No such file or directory`
 
 

core/resume_hooks/README.md

@@ -5,7 +5,7 @@ resumed. They can be configured with the `ConfigureResumeHook()` RPC.
 The API is simple, similar to that of `GateHook`. All you need to do is:
 
 - Define `YourHook::kName`. This must be unique across all other resume hooks.
-- Define `YourHook::kPriority` (lower values get higher priority). Ties are broken by hook name in increasing lexographical order.
+- Define `YourHook::kPriority` (lower values get higher priority). Ties are broken by hook name in increasing lexicographical order.
 - Include `ResumeHook(kName, kPriority)` in `YourHook`'s initializer list.
 - Define `void YourHook::Run()`.
 - Define `void YourHook::Init(const bess::pb::YourHookArg &)`.

env/README.md

@@ -6,7 +6,7 @@ laptop or server.
 
 ## Playing with BESS VM
 
-You can launch a fully conigured VM on which you can build and test BESS at your
+You can launch a fully configured VM on which you can build and test BESS at your
 fingertips. We don't provide a binary VM image though. Instead, We provide a
 Vagrant (https://vagrantup.com) script that automatically generates a VM based
 on Ubuntu 18.04. You can install Vagrant not only on Linux, but also on Windows
@@ -19,7 +19,7 @@ $ vagrant up
 
 to launch a VM. The current BESS directory is mapped to `/opt/bess` in the VM.
 You can connect to the VM with `vagrant ssh`. All compilers and libraries are
-readiliy available.
+readily available.
 
 ## Building BESS without installing dependencies