changeset 1073:f18988efb96b

man: update documentation
author David Demelier <markand@malikania.fr>
date Tue, 13 Jul 2021 20:41:37 +0200
parents a5eaf207ecc2
children 4ed442cf25c0
files irccd/peer.h man/libirccd-hook.3 man/libirccd-rule.3 man/libirccd-server.3
diffstat 4 files changed, 12 insertions(+), 25 deletions(-) [+]
line wrap: on
line diff
--- a/irccd/peer.h	Tue Jul 13 20:35:32 2021 +0200
+++ b/irccd/peer.h	Tue Jul 13 20:41:37 2021 +0200
@@ -19,8 +19,6 @@
 #ifndef IRCCD_PEER_H
 #define IRCCD_PEER_H
 
-#include <sys/queue.h>
-
 #include <irccd/limits.h>
 
 struct pollfd;
--- a/man/libirccd-hook.3	Tue Jul 13 20:35:32 2021 +0200
+++ b/man/libirccd-hook.3	Tue Jul 13 20:41:37 2021 +0200
@@ -40,7 +40,7 @@
 struct irc_hook {
 	char name[IRC_ID_LEN];
 	char path[PATH_MAX];
-	LIST_ENTRY(irc_hook) link;
+	struct irc_hook *next;
 };
 .Ed
 .Pp
@@ -52,10 +52,8 @@
 Name to identify this hook.
 .It Va path
 Absolute path to the hook.
-.It Va link
-Abstract entry to be used with the
-.Xr queue 3
-macros.
+.It Va next
+Pointer to the next hook.
 .El
 .Pp
 The
--- a/man/libirccd-rule.3	Tue Jul 13 20:35:32 2021 +0200
+++ b/man/libirccd-rule.3	Tue Jul 13 20:41:37 2021 +0200
@@ -65,7 +65,8 @@
 	char origins[IRC_RULE_LEN];
 	char plugins[IRC_RULE_LEN];
 	char events[IRC_RULE_LEN];
-	TAILQ_ENTRY(irc_rule) link;
+	struct irc_rule *next;
+	struct irc_rule *prev;
 };
 .Ed
 .Pp
@@ -87,21 +88,13 @@
 A colon separated list of plugins to match.
 .It Va events
 A colon separated list of events to match.
-.It Va link
-Abstract entry to be used with the
-.Xr sys/queue 3
-macros.
+.It Va next
+Pointer to the next rule.
+.It Va perv
+Pointer to the previous rule.
 .El
 .Pp
 The
-.Vt "struct irc_rule_list"
-is an abstract type declared with
-.Fn TAILQ_HEAD
-from
-.Xr queue 3
-macros.
-.Pp
-The
 .Vt "enum irc_rule_action"
 is declared as:
 .Bd -literal
--- a/man/libirccd-server.3	Tue Jul 13 20:35:32 2021 +0200
+++ b/man/libirccd-server.3	Tue Jul 13 20:41:37 2021 +0200
@@ -146,7 +146,7 @@
 	struct irc_server_params params;        /* server parameters */
 	enum irc_server_flags flags;            /* optional user flags */
 	struct irc_channel_list channels;       /* list of channels */
-	LIST_ENTRY(irc_server) link;
+	struct irc_server *next;                /* next server */
 };
 .Ed
 .Pp
@@ -158,10 +158,8 @@
 The
 .Vt struct irc_server
 is implemented as linked list through the
-.Va link
-field usable through
-.Xr queue 3
-macros.
+.Va next
+field.
 .Pp
 Note: few other private fields are not listed as they must not be used by the
 user.