From ab1129c1bdea41ff06fd21390cde5667d07f6e65 Mon Sep 17 00:00:00 2001 From: Martin Mares Date: Fri, 5 May 2000 17:17:42 +0000 Subject: [PATCH] Added skeleton Doc files for the whole developer's documentation. --- Doc | 7 +++++++ client/Doc | 2 ++ conf/Doc | 2 ++ filter/Doc | 1 + lib/Doc | 26 ++++++++++++++++++++++++++ nest/Doc | 1 + proto/Doc | 6 ++++++ proto/bgp/Doc | 1 + proto/ospf/Doc | 1 + proto/pipe/Doc | 1 + proto/rip/Doc | 2 ++ proto/static/Doc | 1 + sysdep/Doc | 2 ++ sysdep/unix/Doc | 7 +++++++ 14 files changed, 60 insertions(+) create mode 100644 Doc create mode 100644 client/Doc create mode 100644 conf/Doc create mode 100644 filter/Doc create mode 100644 lib/Doc create mode 100644 nest/Doc create mode 100644 proto/Doc create mode 100644 proto/bgp/Doc create mode 100644 proto/ospf/Doc create mode 100644 proto/pipe/Doc create mode 100644 proto/rip/Doc create mode 100644 proto/static/Doc create mode 100644 sysdep/Doc create mode 100644 sysdep/unix/Doc diff --git a/Doc b/Doc new file mode 100644 index 00000000..0ba53c65 --- /dev/null +++ b/Doc @@ -0,0 +1,7 @@ +C lib +C nest +C conf +C filter +C proto +C sysdep +C client diff --git a/client/Doc b/client/Doc new file mode 100644 index 00000000..885b8291 --- /dev/null +++ b/client/Doc @@ -0,0 +1,2 @@ +F client Client +.S client.c commands.c diff --git a/conf/Doc b/conf/Doc new file mode 100644 index 00000000..4fc295d6 --- /dev/null +++ b/conf/Doc @@ -0,0 +1,2 @@ +F conf Configuration +.S conf.c diff --git a/filter/Doc b/filter/Doc new file mode 100644 index 00000000..0063b827 --- /dev/null +++ b/filter/Doc @@ -0,0 +1 @@ +H Filters diff --git a/lib/Doc b/lib/Doc new file mode 100644 index 00000000..483b1088 --- /dev/null +++ b/lib/Doc @@ -0,0 +1,26 @@ +H Library +.F csum Checksums and hash functions +..S checksum.c md5.c +.F ip IP addresses +..S ip.c ipv4.c ipv6.c +.F list Linked lists +..S lists.c +.H Resource management +..F gen Generic resource functions +...S resource.c +..F mempool Memory pools +...S mempool.c +..F slab Slabs +...S slab.c +..F sock Sockets +...S socket.h +.H Miscellaneous functions +..F bit Bit operations +...S bitops.c +..F event Events +...S event.c +..F pat Pattern matching +...S patmatch.c +..F printf Printf +...S printf.c +..F unaligned Unaligned access diff --git a/nest/Doc b/nest/Doc new file mode 100644 index 00000000..752067a8 --- /dev/null +++ b/nest/Doc @@ -0,0 +1 @@ +H Core diff --git a/proto/Doc b/proto/Doc new file mode 100644 index 00000000..305e5ba9 --- /dev/null +++ b/proto/Doc @@ -0,0 +1,6 @@ +H Protocols +.C bgp +.C ospf +.C pipe +.C rip +.C static diff --git a/proto/bgp/Doc b/proto/bgp/Doc new file mode 100644 index 00000000..1976d392 --- /dev/null +++ b/proto/bgp/Doc @@ -0,0 +1 @@ +H BGP diff --git a/proto/ospf/Doc b/proto/ospf/Doc new file mode 100644 index 00000000..be4c9715 --- /dev/null +++ b/proto/ospf/Doc @@ -0,0 +1 @@ +H OSPF diff --git a/proto/pipe/Doc b/proto/pipe/Doc new file mode 100644 index 00000000..6b57c147 --- /dev/null +++ b/proto/pipe/Doc @@ -0,0 +1 @@ +H Pipe diff --git a/proto/rip/Doc b/proto/rip/Doc new file mode 100644 index 00000000..0714409b --- /dev/null +++ b/proto/rip/Doc @@ -0,0 +1,2 @@ +F rip RIP +.S rip.c diff --git a/proto/static/Doc b/proto/static/Doc new file mode 100644 index 00000000..e38897b6 --- /dev/null +++ b/proto/static/Doc @@ -0,0 +1 @@ +H Static diff --git a/sysdep/Doc b/sysdep/Doc new file mode 100644 index 00000000..f06e3d84 --- /dev/null +++ b/sysdep/Doc @@ -0,0 +1,2 @@ +H System-dependent parts +.C unix diff --git a/sysdep/unix/Doc b/sysdep/unix/Doc new file mode 100644 index 00000000..5a835b9f --- /dev/null +++ b/sysdep/unix/Doc @@ -0,0 +1,7 @@ +H UNIX +.F io I/O Functions +..S io.c +.F log Logging Functions +..S log.c +.F krt Kernel Syncer +..S krt.c