summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRunxi Yu <me@runxiyu.org>2024-07-26 08:00:00 +0800
committerRunxi Yu <me@runxiyu.org>2024-07-26 08:00:00 +0800
commitee35bd9066b42974a91013aab6a67fd7ed2c602a (patch)
treec29c7a7d41cc673abe2290f7ff0251ac22ed0d89
parentea1d2b364be5a985c5033d93af722efa1ca3251c (diff)
downloadhaxircd-docs-ee35bd9066b42974a91013aab6a67fd7ed2c602a.tar.gz
haxircd-docs-ee35bd9066b42974a91013aab6a67fd7ed2c602a.zip
config.md: Disclaim being up-to-date
-rw-r--r--config.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/config.md b/config.md
index 0cd7a04..3beb6a9 100644
--- a/config.md
+++ b/config.md
@@ -8,6 +8,10 @@ via [`config.c`](#codeconfigccode), which is just another C source file.
Build options are also significant in determining the behavior of HaxIRCd. Refer
to the [`.makeopts`](#codemakeoptscode) section for details.
+**Please note that there is no guarantee that the documentation here is
+up-to-date. Refer to `config.h` to understand the definitions that `config.c`
+should contain. Refer to the `Makefile` to understand the build options.**
+
# `config.c`
This is the main configuration file. When building HaxIRCd, it is built into an
object file and is linked into the main `HaxIRCd.so` shared object.