Commit 371adba6 authored by Martin Mareš's avatar Martin Mareš

Use <chapt> for chapters, <sect> for sections and <sect1> for subsections.

parent 6cba2d5e
This diff is collapsed.
......@@ -572,7 +572,7 @@ sub output_intro_bird {
# print out each section
$lineprefix=" ";
foreach $section (@{$args{'sectionlist'}}) {
print "<sect1>$section\n<p>\n";
print "<sect>$section\n<p>\n";
......@@ -6,7 +6,7 @@
Copyright (c) 2000 Martin Mares <>
<title>BIRD Programmer's Documentation
<sect>BIRD Design
<chapt>BIRD Design
<p>This document describes the internal workings of the BIRD, its architecture,
design decisions and rationale behind them. It also contains documentation on
......@@ -17,7 +17,7 @@ is a sister of talent", we've tried to write a much shorter document highlightin
the most important stuff and leaving the boring technical details better explained
by the program source itself together with comments contained therein.
<sect1>Design goals
<sect>Design goals
<p>When planning the architecture of BIRD, we've taken a close look at the other existing routing
daemons and also at some of the operating systems used on dedicated routers, gathered all important
......@@ -81,7 +81,7 @@ our own scheduling of events.
<p>The requirements set above have lead to a simple modular architecture containing
the following types of modules:
......@@ -118,7 +118,7 @@ interface to the CLI.
<p>BIRD has been written in GNU C. We've considered using of C++, but we've
preferred the simplicity and straightforward nature of C which gives us fine
......@@ -4,9 +4,9 @@
(c) 2000 Martin Mares <>
<sect1>Routing protocols
<sect>Routing protocols
<p>The routing protocols are the BIRD's heart and a fine amount of code
is dedicated to their management and for providing support functions to them.
......@@ -41,7 +41,7 @@ running protocols, <param/initial_proto_list/ for protocols being initialized or
configuration of protocols, please refer to the configuration chapter and also
to the description of the <func/proto_commit/ function.
<sect2>Protocol states
<sect1>Protocol states
<p>As startup and shutdown of each protocol are complex processes which can be affected
by lots of external events (user's actions, reconfigurations, behaviour of neighboring routers etc.),
......@@ -86,6 +86,6 @@ new state. There exist the following core states:
routing tables.
<sect2>Functions of the protocol module
<sect1>Functions of the protocol module
<p>The protocol module provides the following functions:
......@@ -33,7 +33,7 @@ sub process {
if ($cmd eq "C") { process("$dir/$arg"); }
elsif ($cmd eq "H") {
push @stack, "H";
print OUT "<sect>$arg\n";
print OUT "<chapt>$arg\n";
} elsif ($cmd eq "S") {
print " $arg\n";
open(DOC, "cd $srcdir/$dir ; $srcdir/doc/kernel-doc -bird $arg |") || die "Unable to start kernel-doc";
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment