INN commit: branches/2.5/doc/pod (6 files)
INN Commit
rra at isc.org
Mon May 31 19:01:32 UTC 2010
Date: Monday, May 31, 2010 @ 12:01:32
Author: iulius
Revision: 9074
Use pre-formatted text for a better HTML and *nroff output.
Modified:
branches/2.5/doc/pod/libinnhist.pod
branches/2.5/doc/pod/libstorage.pod
branches/2.5/doc/pod/list.pod
branches/2.5/doc/pod/qio.pod
branches/2.5/doc/pod/tst.pod
branches/2.5/doc/pod/uwildmat.pod
----------------+
libinnhist.pod | 74 +++++++++---------
libstorage.pod | 218 +++++++++++++++++++++++++++----------------------------
list.pod | 44 +++++------
qio.pod | 22 ++---
tst.pod | 14 +--
uwildmat.pod | 9 +-
6 files changed, 190 insertions(+), 191 deletions(-)
Modified: libinnhist.pod
===================================================================
--- libinnhist.pod 2010-05-31 19:00:23 UTC (rev 9073)
+++ libinnhist.pod 2010-05-31 19:01:32 UTC (rev 9074)
@@ -4,61 +4,61 @@
=head1 SYNOPSIS
-B<#include E<lt>inn/history.hE<gt>>
+ #include <inn/history.h>
-B<struct history;>
-B<struct token;>
+ struct history;
+ struct token;
-B<struct histstats {>
-B< int hitpos;>
-B< int hitneg;>
-B< int misses;>
-B< int dne;>
-B<};>
+ struct histstats {
+ int hitpos;
+ int hitneg;
+ int misses;
+ int dne;
+ };
-B<#define HIS_RDONLY ...>
-B<#define HIS_RDWR ...>
-B<#define HIS_CREAT ...>
-B<#define HIS_ONDISK ...>
-B<#define HIS_INCORE ...>
-B<#define HIS_MMAP ...>
+ #define HIS_RDONLY ...
+ #define HIS_RDWR ...
+ #define HIS_CREAT ...
+ #define HIS_ONDISK ...
+ #define HIS_INCORE ...
+ #define HIS_MMAP ...
-B<enum {>
-B< HISCTLG_PATH,>
-B< HISCTLS_PATH,>
-B< HISCTLS_SYNCCOUNT,>
-B< HISCTLS_NPAIRS,>
-B< HISCTLS_IGNOREOLD,>
-B< HISCTLS_STATINTERVAL>
-B<};>
+ enum {
+ HISCTLG_PATH,
+ HISCTLS_PATH,
+ HISCTLS_SYNCCOUNT,
+ HISCTLS_NPAIRS,
+ HISCTLS_IGNOREOLD,
+ HISCTLS_STATINTERVAL
+ };
-B<struct history *HISopen(const char *>I<path>B<, const char *>I<method>B<, int >I<flags>B<);>
+ struct history *HISopen(const char *path, const char *method, int flags);
-B<bool HISclose(struct history *>I<history>B<);>
+ bool HISclose(struct history *history);
-B<bool HISsync(struct history *>I<history>B<);>
+ bool HISsync(struct history *history);
-B<void HISsetcache(struct history *>I<history>B<, size_t >I<size>B<);>
+ void HISsetcache(struct history *history, size_t size);
-B<bool HISlookup(struct history *>I<history>B<, const char *>I<key>B<, time_t *>I<arrived>B<, time_t *>I<posted>B<, time_t *>I<expires>B<, TOKEN *>I<token>B<);>
+ bool HISlookup(struct history *history, const char *key, time_t *arrived, time_t *posted, time_t *expires, TOKEN *token);
-B<bool HIScheck(struct history *>I<history>B<, const char *>I<key>B<);>
+ bool HIScheck(struct history *history, const char *key);
-B<bool HISwrite(struct history *>I<history>B<, const char *>I<key>B<, time_t >I<arrived>B<, time_t >I<posted>B<, time_t >I<expires>B<, const TOKEN *>I<token>B<);>
+ bool HISwrite(struct history *history, const char *key, time_t arrived, time_t posted, time_t expires, const TOKEN *token);
-B<bool HISremember(struct history *>I<history>B<, const char *>I<key>B<, time_t >I<arrived>B<, time_t >I<posted>B<);>
+ bool HISremember(struct history *history, const char *key, time_t arrived, time_t posted);
-B<bool HISreplace(struct history *>I<history>B<, const char *>I<key>B<, time_t >I<arrived>B<, time_t >I<posted>B<, time_t >I<expires>B<, const TOKEN *>I<token>B<);>
+ bool HISreplace(struct history *history, const char *key, time_t arrived, time_t posted, time_t expires, const TOKEN *token);
-B<bool HISexpire(struct history *>I<history>B<, const char *>I<path>B<, const char *>I<reason>B<, bool >I<writing>B<, void *>I<cookie>B<, time_t >I<threshold>B<, bool (*>I<exists>B<)(void *>I<cookie>B<, time_t >I<arrived>B<, time_t >I<posted>B<, time_t >I<expires>B<, const TOKEN *>I<token>B<));>
+ bool HISexpire(struct history *history, const char *path, const char *reason, bool writing, void *cookie, time_t threshold, bool (*exists)(void *cookie, time_t arrived, time_t posted, time_t expires, const TOKEN *token));
-B<bool HISwalk(struct history *>I<history>B<, const char *>I<reason>B<, void *>I<cookie>B<, bool (*>I<callback>B<)(void *>I<cookie>B<, time_t >I<arrived>B<, time_t >I<posted>B<, time_t >I<expires>B<, const TOKEN *>I<token>B<));>
+ bool HISwalk(struct history *history, const char *reason, void *cookie, bool (*callback)(void *cookie, time_t arrived, time_t posted, time_t expires, const TOKEN *token));
-B<struct histstats HISstats(struct history *>I<history>B<);>
+ struct histstats HISstats(struct history *history);
-B<const char *HISerror(struct history *>I<history>B<);>
+ const char *HISerror(struct history *history);
-B<bool HISctl(struct history *>I<history>B<, int >I<request>B<, void *>I<val>B<);>
+ bool HISctl(struct history *history, int request, void *val);
=head1 DESCRIPTION
Modified: libstorage.pod
===================================================================
--- libstorage.pod 2010-05-31 19:00:23 UTC (rev 9073)
+++ libstorage.pod 2010-05-31 19:01:32 UTC (rev 9074)
@@ -4,159 +4,159 @@
=head1 SYNOPSIS
-B<#include E<lt>inn/storage.hE<gt>>
+ #include <inn/storage.h>
-B<typedef enum {>
-B< RETR_ALL,>
-B< RETR_HEAD,>
-B< RETR_BODY,>
-B< RETR_STAT>
-B<} RETRTYPE;>
+ typedef enum {
+ RETR_ALL,
+ RETR_HEAD,
+ RETR_BODY,
+ RETR_STAT
+ } RETRTYPE;
-B<typedef enum {>
-B< SM_RDWR,>
-B< SM_PREOPEN>
-B<} SMSETUP;>
+ typedef enum {
+ SM_RDWR,
+ SM_PREOPEN
+ } SMSETUP;
-B<typedef unsigned char STORAGECLASS;>
-B<typedef unsigned char STORAGETYPE;>
+ typedef unsigned char STORAGECLASS;
+ typedef unsigned char STORAGETYPE;
-B<typedef struct token {>
-B< STORAGETYPE >I<type>B<;>
-B< STORAGECLASS >I<class>B<;>
-B< char >I<token>B<[STORAGE_TOKEN_LENGTH];>
-B<} TOKEN;>
+ typedef struct token {
+ STORAGETYPE type;
+ STORAGECLASS class;
+ char token[STORAGE_TOKEN_LENGTH];
+ } TOKEN;
-B<typedef struct {>
-B< unsigned char >I<type>B<;>
-B< const char *>I<data>B<;>
-B< struct iovec *>I<iov>B<;>
-B< int >I<iovcnt>B<;>
-B< size_t >I<len>B<;>
-B< unsigned char >I<nextmethod>B<;>
-B< void *>I<private>B<;>
-B< time_t >I<arrived>B<;>
-B< time_t >I<expires>B<;>
-B< char *>I<groups>B<;>
-B< int >I<groupslen>B<;>
-B< TOKEN *>I<token>B<;>
-B<} ARTHANDLE;>
+ typedef struct {
+ unsigned char type;
+ const char *data;
+ struct iovec *iov;
+ int iovcnt;
+ size_t len;
+ unsigned char nextmethod;
+ void *private;
+ time_t arrived;
+ time_t expires;
+ char *groups;
+ int groupslen;
+ TOKEN *token;
+ } ARTHANDLE;
-B<typedef enum {>
-B< SELFEXPIRE,>
-B< SMARTNGNUM,>
-B< EXPENSIVESTAT>
-B<} PROBETYPE;>
+ typedef enum {
+ SELFEXPIRE,
+ SMARTNGNUM,
+ EXPENSIVESTAT
+ } PROBETYPE;
-B<typedef enum {>
-B< SM_ALL,>
-B< SM_HEAD,>
-B< SM_CANCELLEDART>
-B<} FLUSHTYPE;>
+ typedef enum {
+ SM_ALL,
+ SM_HEAD,
+ SM_CANCELLEDART
+ } FLUSHTYPE;
-B<struct artngnum {>
-B< char *>I<groupname>B<;>
-B< ARTNUM >I<artnum>B<;>
-B<};>
+ struct artngnum {
+ char *groupname;
+ ARTNUM artnum;
+ };
-B<bool IsToken(const char *>I<text>B<);>
+ bool IsToken(const char *text);
-B<char *TokenToText(const TOKEN >I<token>B<);>
+ char *TokenToText(const TOKEN token);
-B<TOKEN TextToToken(const char >I<*text>B<);>
+ TOKEN TextToToken(const char *text);
-B<bool SMsetup(SMSETUP >I<type>B<, void >I<*value>B<);>
+ bool SMsetup(SMSETUP type, void *value);
-B<bool SMinit(void);>
+ bool SMinit(void);
-B<TOKEN SMstore(const ARTHANDLE >I<article>B<);>
+ TOKEN SMstore(const ARTHANDLE article);
-B<ARTHANDLE *SMretrieve(const TOKEN >I<token>B<, const RETRTYPE >I<amount>B<);>
+ ARTHANDLE *SMretrieve(const TOKEN token, const RETRTYPE amount);
-B<ARTHANDLE *SMnext(const ARTHANDLE *>I<article>B<, const RETRTYPE >I<amount>B<);>
+ ARTHANDLE *SMnext(const ARTHANDLE *article, const RETRTYPE amount);
-B<void SMfreearticle(ARTHANDLE *>I<article>B<);>
+ void SMfreearticle(ARTHANDLE *article);
-B<bool SMcancel(TOKEN >I<token>B<);>
+ bool SMcancel(TOKEN token);
-B<bool SMprobe(PROBETYPE >I<type>B<, TOKEN *>I<token>B<, void *>I<value>B<);>
+ bool SMprobe(PROBETYPE type, TOKEN *token, void *value);
-B<void SMprintfiles(FILE *>I<file>B<, TOKEN >I<token>B<, char **>I<xref>B<, int >I<ngroups>B<);>
+ void SMprintfiles(FILE *file, TOKEN token, char **xref, int ngroups);
-B<bool SMflushcacheddata(FLUSHTYPE >I<type>B<);>
+ bool SMflushcacheddata(FLUSHTYPE type);
-B<char *SMexplaintoken(const TOKEN >I<token>B<);>
+ char *SMexplaintoken(const TOKEN token);
-B<void SMshutdown(void);>
+ void SMshutdown(void);
-B<int SMerrno;>
+ int SMerrno;
-B<char *SMerrorstr;>
+ char *SMerrorstr;
-B<#include E<lt>inn/ov.hE<gt>>
+ #include <inn/ov.h>
-B<#define OV_NOSPACE ...>
+ #define OV_NOSPACE ...
-B<typedef enum {>
-B< OVSPACE,>
-B< OVSORT,>
-B< OVCUTOFFLOW,>
-B< OVGROUPBASEDEXPIRE,>
-B< OVSTATICSEARCH,>
-B< OVSTATALL,>
-B< OVCACHEKEEP,>
-B< OVCACHEFREE>
-B<} OVCTLTYPE;>
+ typedef enum {
+ OVSPACE,
+ OVSORT,
+ OVCUTOFFLOW,
+ OVGROUPBASEDEXPIRE,
+ OVSTATICSEARCH,
+ OVSTATALL,
+ OVCACHEKEEP,
+ OVCACHEFREE
+ } OVCTLTYPE;
-B<typedef enum {>
-B< OVNEWSGROUP,>
-B< OVARRIVED,>
-B< OVNOSORT>
-B<} OVSORTTYPE;>
+ typedef enum {
+ OVNEWSGROUP,
+ OVARRIVED,
+ OVNOSORT
+ } OVSORTTYPE;
-B<typedef enum {>
-B< OVADDCOMPLETED,>
-B< OVADDFAILED,>
-B< OVADDGROUPNOMATCH>
-B<} OVADDRESULT;>
+ typedef enum {
+ OVADDCOMPLETED,
+ OVADDFAILED,
+ OVADDGROUPNOMATCH
+ } OVADDRESULT;
-B<bool OVopen(int >I<mode>B<);>
+ bool OVopen(int mode);
-B<bool OVctl(OVCTLTYPE >I<type>B<, void *>I<val>B<);>
+ bool OVctl(OVCTLTYPE type, void *val);
-B<bool OVgroupstats(char *>I<group>B<, int *>I<lo>B<, int *>I<hi>B<, int *>I<count>B<, int *>I<flag>B<);>
+ bool OVgroupstats(char *group, int *lo, int *hi, int *count, int *flag);
-B<bool OVgroupadd(char *>I<group>B<, ARTNUM >I<lo>B<, ARTNUM >I<hi>B<, char *>I<flag>B<);>
+ bool OVgroupadd(char *group, ARTNUM lo, ARTNUM hi, char *flag);
-B<bool OVgroupdel(char *>I<group>B<);>
+ bool OVgroupdel(char *group);
-B<OVADDRESULT OVadd(TOKEN >I<token>B<, char *>I<data>B<, int >I<len>B<, time_t >I<arrived>B<, time_t >I<expires>B<);>
+ OVADDRESULT OVadd(TOKEN token, char *data, int len, time_t arrived, time_t expires);
-B<bool OVcancel(TOKEN >I<token>B<);>
+ bool OVcancel(TOKEN token);
-B<void *OVopensearch(char *>I<group>B<, int >I<low>B<, int >I<high>B<);>
+ void *OVopensearch(char *group, int low, int high);
-B<bool OVsearch(void *>I<handle>B<, ARTNUM *>I<artnum>B<, char **>I<data>B<, int *>I<len>B<, TOKEN *>I<token>B<, time_t *>I<arrived>B<);>
+ bool OVsearch(void *handle, ARTNUM *artnum, char **data, int *len, TOKEN *token, time_t *arrived);
-B<void OVclosesearch(void *>I<handle>B<);>
+ void OVclosesearch(void *handle);
-B<bool OVgetartinfo(char *>I<group>B<, ARTNUM >I<artnum>B<, TOKEN *>I<token>B<);>
+ bool OVgetartinfo(char *group, ARTNUM artnum, TOKEN *token);
-B<bool OVexpiregroup(char *>I<group>B<, int *>I<lo>B<, struct history *>I<h>B<);>
+ bool OVexpiregroup(char *group, int *lo, struct history *h);
-B<typedef struct _OVGE {>
-B< bool >I<delayrm>B<;>
-B< bool >I<usepost>B<;>
-B< bool >I<quiet>B<;>
-B< bool >I<keep>B<;>
-B< bool >I<earliest>B<;>
-B< bool >I<ignoreselfexpire>B<;>
-B< char *>I<filename>B<;>
-B< time_t >I<now>B<;>
-B< float >I<timewarp>B<;>
-B<} OVGE;>
+ typedef struct _OVGE {
+ bool delayrm;
+ bool usepost;
+ bool quiet;
+ bool keep;
+ bool earliest;
+ bool ignoreselfexpire;
+ char *filename;
+ time_t now;
+ float timewarp;
+ } OVGE;
-B<void OVclose(void);>
+ void OVclose(void);
=head1 DESCRIPTION
Modified: list.pod
===================================================================
--- list.pod 2010-05-31 19:00:23 UTC (rev 9073)
+++ list.pod 2010-05-31 19:01:32 UTC (rev 9074)
@@ -4,42 +4,42 @@
=head1 SYNOPSIS
-B<#include E<lt>inn/list.hE<gt>>
+ #include <inn/list.h>
-struct node {
- struct node *succ;
- struct node *pred;
-};
+ struct node {
+ struct node *succ;
+ struct node *pred;
+ };
-struct list {
- struct node *head;
- struct node *tail;
- struct node *tailpred;
-};
+ struct list {
+ struct node *head;
+ struct node *tail;
+ struct node *tailpred;
+ };
-B<void list_new(struct list *>I<list>B<);>
+ void list_new(struct list *list);
-B<struct node *list_addhead(struct list *>I<list>B<, struct node *>I<node>B<);>
+ struct node *list_addhead(struct list *list, struct node *node);
-B<struct node *list_addtail(struct list *>I<list>B<, struct node *>I<node>B<);>
+ struct node *list_addtail(struct list *list, struct node *node);
-B<struct node *list_head(struct list *>I<list>B<);>
+ struct node *list_head(struct list *list);
-B<struct node *list_tail(struct list *>I<list>B<);>
+ struct node *list_tail(struct list *list);
-B<struct node *list_succ(struct node *>I<node>B<);>
+ struct node *list_succ(struct node *node);
-B<struct node *list_pred(struct node *>I<node>B<);>
+ struct node *list_pred(struct node *node);
-B<struct node *list_remhead(struct list *>I<list>B<);>
+ struct node *list_remhead(struct list *list);
-B<struct node *list_remtail(struct list *>I<list>B<);>
+ struct node *list_remtail(struct list *list);
-B<struct node *list_remove(struct node *>I<node>B<);>
+ struct node *list_remove(struct node *node);
-B<struct node *list_insert(struct list *>I<list>B<, struct node *>I<node>B<, struct node *>I<pred>B<);>
+ struct node *list_insert(struct list *list, struct node *node, struct node *pred);
-B<bool list_isempty(struct list *>I<list>B<);>
+ bool list_isempty(struct list *list);
=head1 DESCRIPTION
Modified: qio.pod
===================================================================
--- qio.pod 2010-05-31 19:00:23 UTC (rev 9073)
+++ qio.pod 2010-05-31 19:01:32 UTC (rev 9074)
@@ -4,27 +4,27 @@
=head1 SYNOPSIS
-B<#include E<lt>inn/qio.hE<gt>>
+ #include <inn/qio.h>
-B<QIOSTATE *QIOopen(const char *>I<name>B<);>
+ QIOSTATE *QIOopen(const char *name);
-B<QIOSTATE *QIOfdopen(int> I<fd>B<);>
+ QIOSTATE *QIOfdopen(int> I<fd);
-B<void QIOclose(QIOSTATE *>I<qp>B<);>
+ void QIOclose(QIOSTATE *qp);
-B<char *QIOread(QIOSTATE *>I<qp>B<);>
+ char *QIOread(QIOSTATE *qp);
-B<int QIOfileno(QIOSTATE *>I<qp>B<);>
+ int QIOfileno(QIOSTATE *qp);
-B<size_t QIOlength(QIOSTATE *>I<qp>B<);>
+ size_t QIOlength(QIOSTATE *qp);
-B<int QIOrewind(QIOSTATE *>I<qp>B<);>
+ int QIOrewind(QIOSTATE *qp);
-B<off_t QIOtell(QIOSTATE *>I<qp>B<);>
+ off_t QIOtell(QIOSTATE *qp);
-B<bool QIOerror(QIOSTATE *>I<qp>B<);>
+ bool QIOerror(QIOSTATE *qp);
-B<bool QIOtoolong(QIOSTATE *>I<qp>B<);>
+ bool QIOtoolong(QIOSTATE *qp);
=head1 DESCRIPTION
Modified: tst.pod
===================================================================
--- tst.pod 2010-05-31 19:00:23 UTC (rev 9073)
+++ tst.pod 2010-05-31 19:01:32 UTC (rev 9074)
@@ -4,19 +4,19 @@
=head1 SYNOPSIS
-B<#include E<lt>inn/tst.hE<gt>>
+ #include <inn/tst.h>
-B<struct tst;>
+ struct tst;
-B<struct tst *tst_init(int >I<node_line_width>B<);>
+ struct tst *tst_init(int node_line_width);
-B<void tst_cleanup(struct tst *>I<tst>B<);>
+ void tst_cleanup(struct tst *tst);
-B<int tst_insert(struct tst *>I<tst>B<, const unsigned char *>I<key>B<, void *>I<data>B<, int >I<option>B<, void **>I<exist_ptr>B<);>
+ int tst_insert(struct tst *tst, const unsigned char *key, void *data, int option, void **exist_ptr);
-B<void *tst_search(struct tst *>I<tst>B<, const unsigned char *>I<key>B<);>
+ void *tst_search(struct tst *tst, const unsigned char *key);
-B<void *tst_delete(struct tst *>I<tst>B<, const unsigned char *>I<key>B<);>
+ void *tst_delete(struct tst *tst, const unsigned char *key);
=head1 DESCRIPTION
Modified: uwildmat.pod
===================================================================
--- uwildmat.pod 2010-05-31 19:00:23 UTC (rev 9073)
+++ uwildmat.pod 2010-05-31 19:01:32 UTC (rev 9074)
@@ -4,14 +4,13 @@
=head1 SYNOPSIS
-B<#include E<lt>inn/libinn.hE<gt>>
+ #include <inn/libinn.h>
-B<bool uwildmat(const char *>I<text>B<, const char *>I<pattern>B<);>
+ bool uwildmat(const char *text, const char *pattern);
-B<bool uwildmat_simple(const char *>I<text>B<, const char *>I<pattern>B<);>
+ bool uwildmat_simple(const char *text, const char *pattern);
-B<enum uwildmat uwildmat_poison(const char *>I<text>B<,
-const char *>I<pattern>B<);>
+ enum uwildmat uwildmat_poison(const char *text, const char *pattern);
=head1 DESCRIPTION
More information about the inn-committers
mailing list