infra/linters: Replace spellcheck with typos

Alex-deVis · Alex-deVis · commit f5b94fef8d57 · 2024-12-28T20:55:56.000+02:00
Use typos to find misspelled words since it does not require extensive
wordlists and it is easier to configurate. The trade-off is that it will
not complain about uncommon typos since it will assume they are
technical terms.
Overall it should be a lot easier to maintain than spellcheck.

Signed-off-by: Alex Apostolescu &lt;alexx.apostolescu@gmail.com&gt;
diff --git a/.github/.typos.toml b/.github/.typos.toml
@@ -0,0 +1,19 @@
+[default]
+# ```(console)?[\\s\\S]+?```    -> Ignore fenced sequences
+# -\\w+|--\\w+                  -> Ignore command flags
+extend-ignore-re = ["```(console)?[\\s\\S]+?```", "-\\w+|--\\w+"]
+[files]
+extend-exclude = [
+    "*.svg",
+    "*.drawio",
+    "ssh_key",
+    "ssh_key.pub",
+    "content/assignments/async-web-server/src/http-parser/samples/Makefile", # Windows compile flags
+    # Third-party files
+    "chapters/compute/processes-threads-apache2/guides/apache2/support/httpd.conf",
+    "chapters/compute/processes-threads-apache2/drills/tasks/apache2/support/httpd.conf"
+]
+[default.extend-words]
+# word1 = "word2" to correct word1 to word2
+# word3 = "word3" to consider word3 a valid word
+VAS = "VAS"
diff --git a/.github/workflows/actions.yml b/.github/workflows/actions.yml
@@ -24,11 +24,9 @@ jobs:
         with:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-  spellcheck:
-    name: Spellcheck
+  typos:
+    name: Typos
     runs-on: ubuntu-latest
     steps:
-      - name: Spellcheck
-        uses: open-education-hub/actions/spellcheck@main
-        with:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Typos
+        uses: open-education-hub/actions/typos@main
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,3 @@
+{
+    "editor.formatOnSave": false
+}
diff --git a/Makefile b/Makefile
@@ -39,3 +39,16 @@ clean: stop_bash
 
 cleanall: clean
 	-docker inspect --type=image $(IMAGE_NAME) > /dev/null 2>&1 && docker image rm $(IMAGE_NAME)
+
+# Linters
+.PHONY: lint typos
+lint: typos
+
+typos:
+	@echo "Running crate-ci/typos"
+	@# Replace ghcr.io/alex-devis/typos:1.28.4 with ghcr.io/crate-ci/typos:latest
+	@# once https://github.com/crate-ci/typos/pull/1183 or equivalent is merged.
+	@docker run --rm -v $(PWD):/data -w /data \
+		ghcr.io/alex-devis/typos:latest \
+		--config .github/.typos.toml . \
+		--exclude spellcheck # Do not validate spellcheck wordlist
diff --git a/chapters/compute/processes/guides/sum-array-processes/support/c/sum_array_sequential.c b/chapters/compute/processes/guides/sum-array-processes/support/c/sum_array_sequential.c
@@ -31,7 +31,7 @@ int main(void)
 
 	time = 1000 * (stop.tv_sec - start.tv_sec) + (stop.tv_usec - start.tv_usec) / 1000;
 
-	printf("Array sum is %ld\nTime spent: %lu miliseconds\n", result, time);
+	printf("Array sum is %ld\nTime spent: %lu milliseconds\n", result, time);
 
 	free(array);
 
diff --git a/chapters/compute/scheduling/drills/tasks/libult/solution/queue.h b/chapters/compute/scheduling/drills/tasks/libult/solution/queue.h
@@ -58,7 +58,7 @@ void queue_destroy(QUEUE *queue);
 size_t queue_size(const QUEUE *queue);
 
 
-/* Add elem to the end of queue. Returns 0 on succes and non-zero on
+/* Add elem to the end of queue. Returns 0 on success and non-zero on
  * failure.
  */
 int queue_enqueue(QUEUE *queue, TCB *elem);
diff --git a/chapters/compute/scheduling/drills/tasks/libult/support/queue.h b/chapters/compute/scheduling/drills/tasks/libult/support/queue.h
@@ -58,7 +58,7 @@ void queue_destroy(QUEUE *queue);
 size_t queue_size(const QUEUE *queue);
 
 
-/* Add elem to the end of queue. Returns 0 on succes and non-zero on
+/* Add elem to the end of queue. Returns 0 on success and non-zero on
  * failure.
  */
 int queue_enqueue(QUEUE *queue, TCB *elem);
diff --git a/chapters/compute/scheduling/guides/libult/solution/queue.h b/chapters/compute/scheduling/guides/libult/solution/queue.h
@@ -58,7 +58,7 @@ void queue_destroy(QUEUE *queue);
 size_t queue_size(const QUEUE *queue);
 
 
-/* Add elem to the end of queue. Returns 0 on succes and non-zero on
+/* Add elem to the end of queue. Returns 0 on success and non-zero on
  * failure.
  */
 int queue_enqueue(QUEUE *queue, TCB *elem);
diff --git a/chapters/compute/scheduling/guides/libult/support/queue.h b/chapters/compute/scheduling/guides/libult/support/queue.h
@@ -58,7 +58,7 @@ void queue_destroy(QUEUE *queue);
 size_t queue_size(const QUEUE *queue);
 
 
-/* Add elem to the end of queue. Returns 0 on succes and non-zero on
+/* Add elem to the end of queue. Returns 0 on success and non-zero on
  * failure.
  */
 int queue_enqueue(QUEUE *queue, TCB *elem);
diff --git a/chapters/compute/synchronization/drills/tasks/race-condition/solution/d/race_condition_atomic.d b/chapters/compute/synchronization/drills/tasks/race-condition/solution/d/race_condition_atomic.d
@@ -16,7 +16,7 @@ void incrementVar()
         // `atomicOp` is a template function. It can perform any simple
         // operation, such as `+=`, &= or `-=`, atomically. The operations is
         // given to the function as a template argument using the following
-        // construction: !"+=". The values in parantheses are the operands
+        // construction: !"+=". The values in parentheses are the operands
         // of the atomic operation.
         atomicOp!"+="(var, 1);
     }
diff --git a/chapters/compute/synchronization/drills/tasks/threadsafe-data-struct/support/clist.h b/chapters/compute/synchronization/drills/tasks/threadsafe-data-struct/support/clist.h
@@ -59,7 +59,7 @@ typedef struct CList
                                                                 /* Returns object with first match of string or byte compare */
   void * (* lastMatch)   (struct CList *l, const void *o, size_t shift, size_t size, int string);
                                                                 /* Returns object with last match of string or byte compare */
-  int    (* index)       (struct CList *l);                     /* Get index of previos search match */
+  int    (* index)       (struct CList *l);                     /* Get index of previous search match */
   int    (* swap)        (struct CList *l, int a, int b);       /* Swap, replace two items with index a b */
   int    (* allocSize)   (struct CList *l);                     /* Get allocated size in items */
   size_t (* itemSize)    (struct CList *l);                     /* Get item size in bytes */
diff --git a/chapters/compute/synchronization/drills/tasks/threadsafe-data-struct/support/test.c b/chapters/compute/synchronization/drills/tasks/threadsafe-data-struct/support/test.c
@@ -242,7 +242,7 @@ int main(void)
 
 	/******************************************************* POINTERS LIST */
 
-	/* If we want create list of objects located in diffent places of memory, */
+	/* If we want create list of objects located in different places of memory, */
 	/* let create pointers list or in our case "uintptr_t" address list       */
 
 	printf("Size of 'uintptr_t' = %zu bytes\n", sizeof(uintptr_t));
diff --git a/chapters/compute/synchronization/slides/mutual-exclusion.md b/chapters/compute/synchronization/slides/mutual-exclusion.md
@@ -97,7 +97,7 @@ void mutex_unlock(struct mutex *m)
 * Prevents overhead from busy-waiting
 * Threads move to WAITING state while waiting for the lock
 * Introduces overhead from context switch
-* Releasing a mutex held by another thread is [**undefinded behaviour**](https://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_mutex_lock.html)
+* Releasing a mutex held by another thread is [**undefined behaviour**](https://pubs.opengroup.org/onlinepubs/9699919799/functions/pthread_mutex_lock.html)
 
 ----
 
diff --git a/chapters/compute/threads/drills/tasks/sum-array-bugs/solution/seg-fault/sum_array_processes.d b/chapters/compute/threads/drills/tasks/sum-array-bugs/solution/seg-fault/sum_array_processes.d
@@ -62,10 +62,10 @@ void main(string[] args)
 
     for (size_t i = 0; i < numProcesses; ++i)
     {
-        size_t elemsPerThred = cast(size_t) ceil(
+        size_t elemsPerThread = cast(size_t) ceil(
             (cast(double) ARR_LEN) / numProcesses);
-        size_t start = i * elemsPerThred;
-        size_t end = min(ARR_LEN, (i + 1) * elemsPerThred);
+        size_t start = i * elemsPerThread;
+        size_t end = min(ARR_LEN, (i + 1) * elemsPerThread);
 
         // Spawn another process with the current one as its parent.
         children[i] = fork();
diff --git a/chapters/compute/threads/drills/tasks/sum-array/support/c/sum_array_sequential.c b/chapters/compute/threads/drills/tasks/sum-array/support/c/sum_array_sequential.c
@@ -31,7 +31,7 @@ int main(void)
 
 	time = 1000 * (stop.tv_sec - start.tv_sec) + (stop.tv_usec - start.tv_usec) / 1000;
 
-	printf("Array sum is %ld\nTime spent: %lu miliseconds\n", result, time);
+	printf("Array sum is %ld\nTime spent: %lu milliseconds\n", result, time);
 
 	free(array);
 
diff --git a/chapters/compute/threads/guides/sum-array-threads/support/c/sum_array_sequential.c b/chapters/compute/threads/guides/sum-array-threads/support/c/sum_array_sequential.c
@@ -31,7 +31,7 @@ int main(void)
 
 	time = 1000 * (stop.tv_sec - start.tv_sec) + (stop.tv_usec - start.tv_usec) / 1000;
 
-	printf("Array sum is %ld\nTime spent: %lu miliseconds\n", result, time);
+	printf("Array sum is %ld\nTime spent: %lu milliseconds\n", result, time);
 
 	free(array);
 
diff --git a/chapters/data/working-with-memory/drills/tasks/access-counter/README.md b/chapters/data/working-with-memory/drills/tasks/access-counter/README.md
@@ -29,15 +29,15 @@ In case of a correct solution, you will get an output such as:
 
 ```text
 ./run_all_tests.sh
-test_acess_read                  ........................ passed ...   9
-test_acess_write                 ........................ passed ...   9
-test_acess_exec                  ........................ passed ...  10
-test_acess_read_write            ........................ passed ...  12
-test_acess_read_exec             ........................ passed ...  12
-test_acess_write_exec            ........................ passed ...  12
-test_acess_exec_read             ........................ passed ...  12
-test_acess_exec_write            ........................ passed ...  12
-test_acess_write_read            ........................ passed ...  12
+test_access_read                  ........................ passed ...   9
+test_access_write                 ........................ passed ...   9
+test_access_exec                  ........................ passed ...  10
+test_access_read_write            ........................ passed ...  12
+test_access_read_exec             ........................ passed ...  12
+test_access_write_exec            ........................ passed ...  12
+test_access_exec_read             ........................ passed ...  12
+test_access_exec_write            ........................ passed ...  12
+test_access_write_read            ........................ passed ...  12
 
 Total:                                                           100/100
 ```
diff --git a/chapters/data/working-with-memory/drills/tasks/access-counter/solution/src/access_counter.c b/chapters/data/working-with-memory/drills/tasks/access-counter/solution/src/access_counter.c
@@ -45,7 +45,7 @@ static void access_handler(int signum, siginfo_t *si, void *arg)
 		return;
 	}
 
-	/* TODO 2: Obtain page strart address in start variable. */
+	/* TODO 2: Obtain page start address in start variable. */
 	start = (void *) ((unsigned long) si->si_addr & ~0xFFFUL);
 	log_debug("start: %p", start);
 
diff --git a/chapters/data/working-with-memory/drills/tasks/access-counter/support/tests/test.c b/chapters/data/working-with-memory/drills/tasks/access-counter/support/tests/test.c
@@ -29,7 +29,7 @@ static void do_exec(void *addr)
 	((void (*)(void)) addr)();
 }
 
-static int test_acess_read(void)
+static int test_access_read(void)
 {
 	void *addr;
 
@@ -42,7 +42,7 @@ static int test_acess_read(void)
 	return counter == 1;
 }
 
-static int test_acess_write(void)
+static int test_access_write(void)
 {
 	void *addr;
 
@@ -55,7 +55,7 @@ static int test_acess_write(void)
 	return counter == 2;
 }
 
-static int test_acess_exec(void)
+static int test_access_exec(void)
 {
 	void *addr;
 
@@ -68,7 +68,7 @@ static int test_acess_exec(void)
 	return counter == 3;
 }
 
-static int test_acess_read_write(void)
+static int test_access_read_write(void)
 {
 	void *addr;
 
@@ -82,7 +82,7 @@ static int test_acess_read_write(void)
 	return counter == 1;
 }
 
-static int test_acess_read_exec(void)
+static int test_access_read_exec(void)
 {
 	void *addr;
 
@@ -96,7 +96,7 @@ static int test_acess_read_exec(void)
 	return counter == 2;
 }
 
-static int test_acess_write_exec(void)
+static int test_access_write_exec(void)
 {
 	void *addr;
 
@@ -110,7 +110,7 @@ static int test_acess_write_exec(void)
 	return counter == 1;
 }
 
-static int test_acess_exec_read(void)
+static int test_access_exec_read(void)
 {
 	void *addr;
 
@@ -124,7 +124,7 @@ static int test_acess_exec_read(void)
 	return counter == 0;
 }
 
-static int test_acess_exec_write(void)
+static int test_access_exec_write(void)
 {
 	void *addr;
 
@@ -138,7 +138,7 @@ static int test_acess_exec_write(void)
 	return counter == 0;
 }
 
-static int test_acess_write_read(void)
+static int test_access_write_read(void)
 {
 	void *addr;
 
@@ -153,15 +153,15 @@ static int test_acess_write_read(void)
 }
 
 static struct graded_test all_tests[] = {
-	{ test_acess_read, "test_acess_read", 9 },
-	{ test_acess_write, "test_acess_write", 9 },
-	{ test_acess_exec, "test_acess_exec", 10 },
-	{ test_acess_read_write, "test_acess_read_write", 12 },
-	{ test_acess_read_exec, "test_acess_read_exec", 12 },
-	{ test_acess_write_exec, "test_acess_write_exec", 12 },
-	{ test_acess_exec_read, "test_acess_exec_read", 12 },
-	{ test_acess_exec_write, "test_acess_exec_write", 12 },
-	{ test_acess_write_read, "test_acess_write_read", 12 }
+	{ test_access_read, "test_access_read", 9 },
+	{ test_access_write, "test_access_write", 9 },
+	{ test_access_exec, "test_access_exec", 10 },
+	{ test_access_read_write, "test_access_read_write", 12 },
+	{ test_access_read_exec, "test_access_read_exec", 12 },
+	{ test_access_write_exec, "test_access_write_exec", 12 },
+	{ test_access_exec_read, "test_access_exec_read", 12 },
+	{ test_access_exec_write, "test_access_exec_write", 12 },
+	{ test_access_write_read, "test_access_write_read", 12 }
 };
 
 int main(void)
diff --git a/config.yaml b/config.yaml
@@ -102,7 +102,7 @@ lab_structure:
       - reading/copy-on-write.md
       - guides/apache2.md
       - guides/fork-faults.md
-  - title: Lab 8 - Syncronization
+  - title: Lab 8 - Synchronization
     filename: lab8.md
     content:
       - tasks/race-condition.md
@@ -313,7 +313,7 @@ docusaurus:
                   - Not Race Condition: not-race-condition.md
             - Lab 6 - Multiprocess and Multithread: lab6.md
             - Lab 7 - Copy-on-Write: lab7.md
-            - Lab 8 - Syncronization: lab8.md
+            - Lab 8 - Synchronization: lab8.md
       - IO:
           path: /build/prepare_view/.view
           extra:
diff --git a/content/assignments/async-web-server/src/http-parser/README.md b/content/assignments/async-web-server/src/http-parser/README.md
@@ -57,7 +57,7 @@ When data is received on the socket execute the parser and check for errors.
     }
 
     /* Start up / continue the parser.
-     * Note we pass recved==0 to signal that EOF has been recieved.
+     * Note we pass recved==0 to signal that EOF has been received.
      */
     nparsed = http_parser_execute(parser, &settings, buf, recved);
 
diff --git a/content/assignments/async-web-server/src/http-parser/http_parser.c b/content/assignments/async-web-server/src/http-parser/http_parser.c
@@ -1383,7 +1383,7 @@ size_t http_parser_execute (http_parser *parser,
         /* Here we call the headers_complete callback. This is somewhat
          * different than other callbacks because if the user returns 1, we
          * will interpret that as saying that this message has no body. This
-         * is needed for the annoying case of recieving a response to a HEAD
+         * is needed for the annoying case of receiving a response to a HEAD
          * request.
          */
         if (settings->on_headers_complete) {
diff --git a/content/assignments/async-web-server/src/http-parser/http_parser.h b/content/assignments/async-web-server/src/http-parser/http_parser.h
@@ -52,7 +52,7 @@ typedef int ssize_t;
 #endif
 
 
-/* Maximium header size allowed */
+/* Maximum header size allowed */
 #define HTTP_MAX_HEADER_SIZE (80*1024)
 
 
diff --git a/content/assignments/lambda-function-loader/tests/checker.sh b/content/assignments/lambda-function-loader/tests/checker.sh
@@ -82,7 +82,7 @@ gen_big_test() {
         elif [ $((CLIENT_NUM%4)) -eq 1 ]; then
             cat "${BIG_DIR}/test_${CLIENT_NUM}" >> "$GEN_REF_FILE"
         elif [ $((CLIENT_NUM%4)) -eq 2 ]; then
-            echo "Reseted the counter!" >> "$GEN_REF_FILE"
+            echo "Reset the counter!" >> "$GEN_REF_FILE"
         else
             echo "Error: $CHECKER_DIR/libfictional.so reset could not be executed." >> "$GEN_REF_FILE"
         fi
diff --git a/content/assignments/lambda-function-loader/tests/special.c b/content/assignments/lambda-function-loader/tests/special.c
@@ -26,5 +26,5 @@ void reset(void)
 {
 	/* Let's erase the history, shall we? */
 	counter = 0;
-	printf("Reseted the counter!\n");
+	printf("Reset the counter!\n");
 }
diff --git a/content/assignments/minishell/tests/_test/run_test.sh b/content/assignments/minishell/tests/_test/run_test.sh
@@ -129,7 +129,7 @@ execute_cmd() {
 	mkdir -p "${OUT_DIR}" && cd "${OUT_DIR}" &>"$LOG_FILE" || exit 1
 	# shellcheck disable=SC2086
 	timeout "$TEST_TIMEOUT" $BUFFERING_WRAPPER $EXEC <"${INPUT}" &>"$OUTPUT"
-	# Ocasionally, in a virtualized environment, the diff that compares the
+	# Occasionally, in a virtualized environment, the diff that compares the
 	# target implementation with the reference output starts before the
 	# target implementation has finished writing files to disk. Handle this
 	# by mandating that all I/O buffers be flushed.
diff --git a/content/assignments/minishell/util/parser/parser.h b/content/assignments/minishell/util/parser/parser.h
@@ -157,7 +157,7 @@ typedef enum {
  * (the father of the current node in the parse tree)
  * The root of the tree has up == NULL
 
- * The parsed expressions do not contain parantheses, this means that
+ * The parsed expressions do not contain parentheses, this means that
  * the following holds:
  * for any op_lower that has a lower priority than op, there is no
  * parent in the tree with op == op_lower
@@ -194,7 +194,7 @@ void parse_error(const char *str, const int where);
 /*
  * Call this to parse a line
 
- * line must point to a string containig a single line
+ * line must point to a string containing a single line
  * The line must end with "\r\n\0" or "\n\0" or "\0"
  * (*root) must point to NULL ((*root) == NULL)
 
diff --git a/content/assignments/minishell/util/parser/parser.l b/content/assignments/minishell/util/parser/parser.l
diff --git a/content/assignments/minishell/util/parser/parser.y b/content/assignments/minishell/util/parser/parser.y
diff --git a/content/assignments/parallel-firewall/src/ring_buffer.h b/content/assignments/parallel-firewall/src/ring_buffer.h
diff --git a/content/assignments/parallel-firewall/tests/checker.py b/content/assignments/parallel-firewall/tests/checker.py
diff --git a/gen-view.py b/gen-view.py

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "editor.formatOnSave": false`
	`3`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ void incrementVar()`
`16`	`16`	// `atomicOp` is a template function. It can perform any simple
`17`	`17`	// operation, such as `+=`, &= or `-=`, atomically. The operations is
`18`	`18`	`// given to the function as a template argument using the following`
`19`		`- // construction: !"+=". The values in parantheses are the operands`
	`19`	`+ // construction: !"+=". The values in parentheses are the operands`
`20`	`20`	`// of the atomic operation.`
`21`	`21`	`atomicOp!"+="(var, 1);`
`22`	`22`	`}`