From: Elizabeth Myers <redacted>
Date: Mon, 7 Mar 2016 07:16:24 +0000 (-0600)
Subject: Add more core module descriptions
X-Git-Url: https://jfr.im/git/solanum.git/commitdiff_plain/ee6dcb05147fd7fa417541e47a53e9bfe06b6479

Add more core module descriptions
---

diff --git a/modules/core/m_error.c b/modules/core/m_error.c
index c2ce31ad..14c0813f 100644
--- a/modules/core/m_error.c
+++ b/modules/core/m_error.c
@@ -24,7 +24,7 @@
 
 #include "stdinc.h"
 #include "client.h"
-#include "common.h"		/* FALSE */
+#include "common.h"
 #include "ircd.h"
 #include "numeric.h"
 #include "send.h"
@@ -45,7 +45,10 @@ mapi_clist_av1 error_clist[] = {
 	&error_msgtab, NULL
 };
 
-DECLARE_MODULE_AV2(error, NULL, NULL, error_clist, NULL, NULL, NULL, NULL, NULL);
+static const char error_desc[] =
+	"Provides the ERROR command for clients and servers";
+
+DECLARE_MODULE_AV2(error, NULL, NULL, error_clist, NULL, NULL, NULL, NULL, error_desc);
 
 /* Determine whether an ERROR message is safe to show (no IP address in it) */
 static int
diff --git a/modules/core/m_mode.c b/modules/core/m_mode.c
index c84ffaaf..26bb1b34 100644
--- a/modules/core/m_mode.c
+++ b/modules/core/m_mode.c
@@ -64,8 +64,10 @@ struct Message bmask_msgtab = {
 };
 
 mapi_clist_av1 mode_clist[] = { &mode_msgtab, &tmode_msgtab, &mlock_msgtab, &bmask_msgtab, NULL };
+static const char mode_desc[] =
+	"Provides the MODE and MLOCK client and server commands, and TS6 server-to-server TMODE and BMASK commands";
 
-DECLARE_MODULE_AV2(mode, NULL, NULL, mode_clist, NULL, NULL, NULL, NULL, NULL);
+DECLARE_MODULE_AV2(mode, NULL, NULL, mode_clist, NULL, NULL, NULL, NULL, mode_desc);
 
 /*
  * m_mode - MODE command handler
diff --git a/modules/core/m_nick.c b/modules/core/m_nick.c
index e29e81a8..6b6af698 100644
--- a/modules/core/m_nick.c
+++ b/modules/core/m_nick.c
@@ -85,7 +85,10 @@ struct Message save_msgtab = {
 mapi_clist_av1 nick_clist[] = { &nick_msgtab, &uid_msgtab, &euid_msgtab,
 	&save_msgtab, NULL };
 
-DECLARE_MODULE_AV2(nick, NULL, NULL, nick_clist, NULL, NULL, NULL, NULL, NULL);
+static const char nick_desc[] =
+	"Provides the NICK client and server commands as well as the UID, EUID, and SAVE TS6 server commands";
+
+DECLARE_MODULE_AV2(nick, NULL, NULL, nick_clist, NULL, NULL, NULL, NULL, nick_desc);
 
 static int change_remote_nick(struct Client *, struct Client *, time_t,
 			      const char *, int);
diff --git a/modules/core/m_part.c b/modules/core/m_part.c
index cd26b677..fca9c8d1 100644
--- a/modules/core/m_part.c
+++ b/modules/core/m_part.c
@@ -49,7 +49,10 @@ struct Message part_msgtab = {
 
 mapi_clist_av1 part_clist[] = { &part_msgtab, NULL };
 
-DECLARE_MODULE_AV2(part, NULL, NULL, part_clist, NULL, NULL, NULL, NULL, NULL);
+static const char part_desc[] =
+	"Provides the PART client and server commands";
+
+DECLARE_MODULE_AV2(part, NULL, NULL, part_clist, NULL, NULL, NULL, NULL, part_desc);
 
 static void part_one_client(struct Client *client_p,
 			    struct Client *source_p, char *name,
diff --git a/modules/core/m_server.c b/modules/core/m_server.c
index c25f02b9..3933c311 100644
--- a/modules/core/m_server.c
+++ b/modules/core/m_server.c
@@ -55,7 +55,9 @@ struct Message sid_msgtab = {
 
 mapi_clist_av1 server_clist[] = { &server_msgtab, &sid_msgtab, NULL };
 
-DECLARE_MODULE_AV2(server, NULL, NULL, server_clist, NULL, NULL, NULL, NULL, NULL);
+static const char server_desc[] = "Provides the SERVER and SID commands for TS6 use";
+
+DECLARE_MODULE_AV2(server, NULL, NULL, server_clist, NULL, NULL, NULL, NULL, server_desc);
 
 int bogus_host(const char *host);
 static int set_server_gecos(struct Client *, const char *);
diff --git a/modules/core/m_squit.c b/modules/core/m_squit.c
index 9c72969d..9fca6d73 100644
--- a/modules/core/m_squit.c
+++ b/modules/core/m_squit.c
@@ -24,7 +24,7 @@
 
 #include "stdinc.h"
 #include "client.h"
-#include "common.h"		/* FALSE bleah */
+#include "common.h"
 #include "match.h"
 #include "ircd.h"
 #include "numeric.h"
@@ -48,7 +48,9 @@ struct Message squit_msgtab = {
 
 mapi_clist_av1 squit_clist[] = { &squit_msgtab, NULL };
 
-DECLARE_MODULE_AV2(squit, NULL, NULL, squit_clist, NULL, NULL, NULL, NULL, NULL);
+static const char squit_desc[] = "Provides the TS6 SQUIT command";
+
+DECLARE_MODULE_AV2(squit, NULL, NULL, squit_clist, NULL, NULL, NULL, NULL, squit_desc);
 
 struct squit_parms
 {