From e859880db83c5120670b87c1d5a8cf03eedc1806 Mon Sep 17 00:00:00 2001 From: Test_User Date: Mon, 22 Jul 2024 21:45:53 -0400 Subject: File descriptions --- LICENSE.c | 2 +- LICENSE.h | 2 ++ config.h | 3 ++- general_network.c | 2 +- general_network.h | 2 +- main.c | 2 +- main.h | 4 +++- mutex.c | 2 +- mutex.h | 2 ++ networks/gnutls.c | 2 +- networks/gnutls.h | 2 +- networks/gnutls_buffered.c | 2 +- networks/gnutls_buffered.h | 2 +- networks/openssl.c | 2 +- networks/openssl.h | 2 +- networks/openssl_buffered.c | 2 +- networks/openssl_buffered.h | 2 +- networks/plaintext.c | 2 +- networks/plaintext.h | 2 +- networks/plaintext_buffered.c | 2 +- networks/plaintext_buffered.h | 2 +- protocol_numbers.h | 2 ++ protocols.c | 2 +- protocols.h | 2 ++ protocols/inspircd2.c | 2 +- protocols/inspircd2.h | 2 ++ protocols/inspircd3.c | 2 +- protocols/inspircd3.h | 2 ++ pseudoclients.c | 2 +- pseudoclients.h | 2 ++ pseudoclients/haxserv.c | 2 +- pseudoclients/haxserv.h | 2 ++ pseudoclients/services.c | 2 ++ pseudoclients/services.h | 2 ++ real_main.c | 2 +- server_network.c | 2 +- server_network.h | 2 ++ 37 files changed, 51 insertions(+), 26 deletions(-) diff --git a/LICENSE.c b/LICENSE.c index 708783d..a22e0d3 100644 --- a/LICENSE.c +++ b/LICENSE.c @@ -1,4 +1,4 @@ -// One of the code files for HaxServ +// TODO: Give a description after you copy this // // Written by: Test_User // diff --git a/LICENSE.h b/LICENSE.h index a10cafb..74f475a 100644 --- a/LICENSE.h +++ b/LICENSE.h @@ -1,3 +1,5 @@ +// TODO: Give a description after you copy this +// // Written by: Test_User // // This is free and unencumbered software released into the public diff --git a/config.h b/config.h index 5e02490..0ce5f51 100644 --- a/config.h +++ b/config.h @@ -1,4 +1,5 @@ -// One of the headers for HaxServ +// HaxIRCd's config definitions +// You will need to supply a config.c that matches all the fields below (if included by your choice of options) // // Written by: Test_User // diff --git a/general_network.c b/general_network.c index d04dbcd..afc11fb 100644 --- a/general_network.c +++ b/general_network.c @@ -1,4 +1,4 @@ -// One of the code files for HaxServ +// Functions for implementing generic IRC behavior, and some general networking stuff // // Written by: Test_User // diff --git a/general_network.h b/general_network.h index 5099c7d..2705cec 100644 --- a/general_network.h +++ b/general_network.h @@ -1,4 +1,4 @@ -// One of the headers for HaxServ +// Header for generic IRC behavior and general networking usage // // Written by: Test_User // diff --git a/main.c b/main.c index 2a3e740..65bfc47 100644 --- a/main.c +++ b/main.c @@ -1,4 +1,4 @@ -// One of the code files for HaxServ +// This just loads the actual HaxIRCd, so its symbols and such are available to its modules // // Written by: Test_User // diff --git a/main.h b/main.h index 9b48a24..cb4fac5 100644 --- a/main.h +++ b/main.h @@ -1,3 +1,5 @@ +// Definitions for a few global things that don't fit anywhere more specific +// // Written by: Test_User // // This is free and unencumbered software released into the public @@ -32,4 +34,4 @@ extern pthread_attr_t pthread_attr; extern MUTEX_TYPE state_lock; -int main(void); +int real_main(void); diff --git a/mutex.c b/mutex.c index d2bd860..7536556 100644 --- a/mutex.c +++ b/mutex.c @@ -1,4 +1,4 @@ -// One of the code files for HaxServ +// Just ensures the mutex functions get compiled in somewhere, and only once, for if it's not inlined somewhere // // Written by: Test_User // diff --git a/mutex.h b/mutex.h index 7d1b4b2..df81f54 100644 --- a/mutex.h +++ b/mutex.h @@ -1,3 +1,5 @@ +// Selection of mutexes (semaphores, futexes (may get rid of), or some miserable spinlocks (for use if all else fails)) +// // Written by: Test_User // // This is free and unencumbered software released into the public diff --git a/networks/gnutls.c b/networks/gnutls.c index cb59a51..dfa9e88 100644 --- a/networks/gnutls.c +++ b/networks/gnutls.c @@ -1,4 +1,4 @@ -// One of the code files for HaxServ +// Direct GnuTLS networking // // Written by: Test_User // diff --git a/networks/gnutls.h b/networks/gnutls.h index 51c7362..585bd03 100644 --- a/networks/gnutls.h +++ b/networks/gnutls.h @@ -1,4 +1,4 @@ -// One of the headers for HaxServ +// Direct GnuTLS networking // // Written by: Test_User // diff --git a/networks/gnutls_buffered.c b/networks/gnutls_buffered.c index 28a50ca..3202a8a 100644 --- a/networks/gnutls_buffered.c +++ b/networks/gnutls_buffered.c @@ -1,4 +1,4 @@ -// One of the code files for HaxServ +// GnuTLS networking, with a buffer and a seperate sending thread // // Written by: Test_User // diff --git a/networks/gnutls_buffered.h b/networks/gnutls_buffered.h index a12d4cd..40b4acd 100644 --- a/networks/gnutls_buffered.h +++ b/networks/gnutls_buffered.h @@ -1,4 +1,4 @@ -// One of the headers for HaxServ +// GnuTLS networking, with a buffer and a seperate sending thread // // Written by: Test_User // diff --git a/networks/openssl.c b/networks/openssl.c index 8d41c25..bf6b869 100644 --- a/networks/openssl.c +++ b/networks/openssl.c @@ -1,4 +1,4 @@ -// One of the code files for HaxServ +// Direct OpenSSL networking // // Written by: Test_User // diff --git a/networks/openssl.h b/networks/openssl.h index 8c032f7..5039ca5 100644 --- a/networks/openssl.h +++ b/networks/openssl.h @@ -1,4 +1,4 @@ -// One of the headers for HaxServ +// Direct OpenSSL networking // // Written by: Test_User // diff --git a/networks/openssl_buffered.c b/networks/openssl_buffered.c index 1afc2a3..78d2830 100644 --- a/networks/openssl_buffered.c +++ b/networks/openssl_buffered.c @@ -1,4 +1,4 @@ -// One of the code files for HaxServ +// OpenSSL networking, with a buffer and a seperate sending thread // // Written by: Test_User // diff --git a/networks/openssl_buffered.h b/networks/openssl_buffered.h index def2ec7..5d4dca6 100644 --- a/networks/openssl_buffered.h +++ b/networks/openssl_buffered.h @@ -1,4 +1,4 @@ -// One of the headers for HaxServ +// OpenSSL networking, with a buffer and a seperate sending thread // // Written by: Test_User // diff --git a/networks/plaintext.c b/networks/plaintext.c index 7914b9e..56c06fb 100644 --- a/networks/plaintext.c +++ b/networks/plaintext.c @@ -1,4 +1,4 @@ -// One of the code files for HaxServ +// Raw socket networking // // Written by: Test_User // diff --git a/networks/plaintext.h b/networks/plaintext.h index 2cc390a..0827f3b 100644 --- a/networks/plaintext.h +++ b/networks/plaintext.h @@ -1,4 +1,4 @@ -// One of the headers for HaxServ +// Raw socket networking // // Written by: Test_User // diff --git a/networks/plaintext_buffered.c b/networks/plaintext_buffered.c index 3112875..d8cfc77 100644 --- a/networks/plaintext_buffered.c +++ b/networks/plaintext_buffered.c @@ -1,4 +1,4 @@ -// One of the code files for HaxServ +// Plaintext TCP networking, with a buffer and a seperate sending thread // // Written by: Test_User // diff --git a/networks/plaintext_buffered.h b/networks/plaintext_buffered.h index dbe591f..71b0483 100644 --- a/networks/plaintext_buffered.h +++ b/networks/plaintext_buffered.h @@ -1,4 +1,4 @@ -// One of the headers for HaxServ +// Plaintext TCP networking, with a buffer and a seperate sending thread // // Written by: Test_User // diff --git a/protocol_numbers.h b/protocol_numbers.h index 23f9dcc..215d70e 100644 --- a/protocol_numbers.h +++ b/protocol_numbers.h @@ -1,3 +1,5 @@ +// Protocol-related constants +// // Written by: Test_User // // This is free and unencumbered software released into the public diff --git a/protocols.c b/protocols.c index 56eecc0..bf3959d 100644 --- a/protocols.c +++ b/protocols.c @@ -1,4 +1,4 @@ -// One of the code files for HaxServ +// s2s protocol interface // // Written by: Test_User // diff --git a/protocols.h b/protocols.h index 189d58d..21a9d03 100644 --- a/protocols.h +++ b/protocols.h @@ -1,3 +1,5 @@ +// s2s protocol interface +// // Written by: Test_User // // This is free and unencumbered software released into the public diff --git a/protocols/inspircd2.c b/protocols/inspircd2.c index c11577e..76f85eb 100644 --- a/protocols/inspircd2.c +++ b/protocols/inspircd2.c @@ -1,4 +1,4 @@ -// One of the code files for HaxServ +// InspIRCd v2 / InspIRCd 1202 protocol support // // Written by: Test_User // diff --git a/protocols/inspircd2.h b/protocols/inspircd2.h index 144ba15..b5df434 100644 --- a/protocols/inspircd2.h +++ b/protocols/inspircd2.h @@ -1,3 +1,5 @@ +// InspIRCd v2 / InspIRCd 1202 protocol support +// // Written by: Test_User // // This is free and unencumbered software released into the public diff --git a/protocols/inspircd3.c b/protocols/inspircd3.c index 2e66d53..19ab187 100644 --- a/protocols/inspircd3.c +++ b/protocols/inspircd3.c @@ -1,4 +1,4 @@ -// One of the code files for HaxServ +// InspIRCd v3 / InspIRCd 1205 protocol support // // Written by: Test_User // diff --git a/protocols/inspircd3.h b/protocols/inspircd3.h index daea5e0..69e962d 100644 --- a/protocols/inspircd3.h +++ b/protocols/inspircd3.h @@ -1,3 +1,5 @@ +// InspIRCd v3 / InspIRCd 1205 protocol support +// // Written by: Test_User // // This is free and unencumbered software released into the public diff --git a/pseudoclients.c b/pseudoclients.c index 77ba1e2..558a414 100644 --- a/pseudoclients.c +++ b/pseudoclients.c @@ -1,4 +1,4 @@ -// One of the code files for HaxServ +// Pseudoclient interface // // Written by: Test_User // diff --git a/pseudoclients.h b/pseudoclients.h index 606cb39..24a38fe 100644 --- a/pseudoclients.h +++ b/pseudoclients.h @@ -1,3 +1,5 @@ +// Pseudoclient interface +// // Written by: Test_User // // This is free and unencumbered software released into the public diff --git a/pseudoclients/haxserv.c b/pseudoclients/haxserv.c index d5fa128..7d78d57 100644 --- a/pseudoclients/haxserv.c +++ b/pseudoclients/haxserv.c @@ -1,4 +1,4 @@ -// One of the code files for HaxServ +// The HaxServ pseudoclient // // Written by: Test_User // diff --git a/pseudoclients/haxserv.h b/pseudoclients/haxserv.h index ff2c603..7c09fe0 100644 --- a/pseudoclients/haxserv.h +++ b/pseudoclients/haxserv.h @@ -1,3 +1,5 @@ +// The HaxServ pseudoclient +// // Written by: Test_User // // This is free and unencumbered software released into the public diff --git a/pseudoclients/services.c b/pseudoclients/services.c index 3be6d60..fb0e074 100644 --- a/pseudoclients/services.c +++ b/pseudoclients/services.c @@ -1,3 +1,5 @@ +// Services pseudoclients +// // Written by: Test_User // // This is free and unencumbered software released into the public diff --git a/pseudoclients/services.h b/pseudoclients/services.h index 7361cea..84e62cf 100644 --- a/pseudoclients/services.h +++ b/pseudoclients/services.h @@ -1,3 +1,5 @@ +// Services pseudoclients +// // Written by: Test_User // // This is free and unencumbered software released into the public diff --git a/real_main.c b/real_main.c index 946af63..6685740 100644 --- a/real_main.c +++ b/real_main.c @@ -1,4 +1,4 @@ -// "Main" file for haxserv +// Actual "Main" file for HaxIRCd, just does the required setup // // Written by: Test_User // diff --git a/server_network.c b/server_network.c index 29639fd..0bfe2e2 100644 --- a/server_network.c +++ b/server_network.c @@ -1,4 +1,4 @@ -// One of the code files for HaxServ +// Server networking setup and connection accepting // // Written by: Test_User // diff --git a/server_network.h b/server_network.h index 8b6457e..b32f1b2 100644 --- a/server_network.h +++ b/server_network.h @@ -1,3 +1,5 @@ +// Server networking setup and connection accepting +// // Written by: Test_User // // This is free and unencumbered software released into the public -- cgit v1.2.3