]> git.ipfire.org Git - thirdparty/bird.git/commitdiff
Added skeleton Doc files for the whole developer's documentation.
authorMartin Mares <mj@ucw.cz>
Fri, 5 May 2000 17:17:42 +0000 (17:17 +0000)
committerMartin Mares <mj@ucw.cz>
Fri, 5 May 2000 17:17:42 +0000 (17:17 +0000)
14 files changed:
Doc [new file with mode: 0644]
client/Doc [new file with mode: 0644]
conf/Doc [new file with mode: 0644]
filter/Doc [new file with mode: 0644]
lib/Doc [new file with mode: 0644]
nest/Doc [new file with mode: 0644]
proto/Doc [new file with mode: 0644]
proto/bgp/Doc [new file with mode: 0644]
proto/ospf/Doc [new file with mode: 0644]
proto/pipe/Doc [new file with mode: 0644]
proto/rip/Doc [new file with mode: 0644]
proto/static/Doc [new file with mode: 0644]
sysdep/Doc [new file with mode: 0644]
sysdep/unix/Doc [new file with mode: 0644]

diff --git a/Doc b/Doc
new file mode 100644 (file)
index 0000000..0ba53c6
--- /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 (file)
index 0000000..885b829
--- /dev/null
@@ -0,0 +1,2 @@
+F client Client
+.S client.c commands.c
diff --git a/conf/Doc b/conf/Doc
new file mode 100644 (file)
index 0000000..4fc295d
--- /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 (file)
index 0000000..0063b82
--- /dev/null
@@ -0,0 +1 @@
+H Filters
diff --git a/lib/Doc b/lib/Doc
new file mode 100644 (file)
index 0000000..483b108
--- /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 (file)
index 0000000..752067a
--- /dev/null
+++ b/nest/Doc
@@ -0,0 +1 @@
+H Core
diff --git a/proto/Doc b/proto/Doc
new file mode 100644 (file)
index 0000000..305e5ba
--- /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 (file)
index 0000000..1976d39
--- /dev/null
@@ -0,0 +1 @@
+H BGP
diff --git a/proto/ospf/Doc b/proto/ospf/Doc
new file mode 100644 (file)
index 0000000..be4c971
--- /dev/null
@@ -0,0 +1 @@
+H OSPF
diff --git a/proto/pipe/Doc b/proto/pipe/Doc
new file mode 100644 (file)
index 0000000..6b57c14
--- /dev/null
@@ -0,0 +1 @@
+H Pipe
diff --git a/proto/rip/Doc b/proto/rip/Doc
new file mode 100644 (file)
index 0000000..0714409
--- /dev/null
@@ -0,0 +1,2 @@
+F rip RIP
+.S rip.c
diff --git a/proto/static/Doc b/proto/static/Doc
new file mode 100644 (file)
index 0000000..e38897b
--- /dev/null
@@ -0,0 +1 @@
+H Static
diff --git a/sysdep/Doc b/sysdep/Doc
new file mode 100644 (file)
index 0000000..f06e3d8
--- /dev/null
@@ -0,0 +1,2 @@
+H System-dependent parts
+.C unix
diff --git a/sysdep/unix/Doc b/sysdep/unix/Doc
new file mode 100644 (file)
index 0000000..5a835b9
--- /dev/null
@@ -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