From 52461c587563822939b238379bb1d72975e80b62 Mon Sep 17 00:00:00 2001 From: Joel Sherrill Date: Tue, 14 Apr 1998 16:03:45 +0000 Subject: New files --- doc/tools/src2html1.4a/FreeBSD/FreeBSD.hdr | 25 +++++++++ doc/tools/src2html1.4a/FreeBSD/FreeBSD.s2h | 68 +++++++++++++++++++++++++ doc/tools/src2html1.4a/FreeBSD/conf.hdr | 9 ++++ doc/tools/src2html1.4a/FreeBSD/ddb.hdr | 6 +++ doc/tools/src2html1.4a/FreeBSD/i386.i386.hdr | 5 ++ doc/tools/src2html1.4a/FreeBSD/i386.include.hdr | 5 ++ doc/tools/src2html1.4a/FreeBSD/i386.isa.hdr | 10 ++++ doc/tools/src2html1.4a/FreeBSD/i386.stand.hdr | 14 +++++ doc/tools/src2html1.4a/FreeBSD/kern.hdr | 18 +++++++ doc/tools/src2html1.4a/FreeBSD/net.hdr | 11 ++++ doc/tools/src2html1.4a/FreeBSD/netinet.hdr | 10 ++++ doc/tools/src2html1.4a/FreeBSD/nfs.hdr | 7 +++ doc/tools/src2html1.4a/FreeBSD/stand.hdr | 14 +++++ doc/tools/src2html1.4a/FreeBSD/sys.hdr | 6 +++ doc/tools/src2html1.4a/FreeBSD/ufs.hdr | 10 ++++ doc/tools/src2html1.4a/FreeBSD/vm.hdr | 9 ++++ 16 files changed, 227 insertions(+) create mode 100644 doc/tools/src2html1.4a/FreeBSD/FreeBSD.hdr create mode 100644 doc/tools/src2html1.4a/FreeBSD/FreeBSD.s2h create mode 100644 doc/tools/src2html1.4a/FreeBSD/conf.hdr create mode 100644 doc/tools/src2html1.4a/FreeBSD/ddb.hdr create mode 100644 doc/tools/src2html1.4a/FreeBSD/i386.i386.hdr create mode 100644 doc/tools/src2html1.4a/FreeBSD/i386.include.hdr create mode 100644 doc/tools/src2html1.4a/FreeBSD/i386.isa.hdr create mode 100644 doc/tools/src2html1.4a/FreeBSD/i386.stand.hdr create mode 100644 doc/tools/src2html1.4a/FreeBSD/kern.hdr create mode 100644 doc/tools/src2html1.4a/FreeBSD/net.hdr create mode 100644 doc/tools/src2html1.4a/FreeBSD/netinet.hdr create mode 100644 doc/tools/src2html1.4a/FreeBSD/nfs.hdr create mode 100644 doc/tools/src2html1.4a/FreeBSD/stand.hdr create mode 100644 doc/tools/src2html1.4a/FreeBSD/sys.hdr create mode 100644 doc/tools/src2html1.4a/FreeBSD/ufs.hdr create mode 100644 doc/tools/src2html1.4a/FreeBSD/vm.hdr (limited to 'doc/tools/src2html1.4a/FreeBSD') diff --git a/doc/tools/src2html1.4a/FreeBSD/FreeBSD.hdr b/doc/tools/src2html1.4a/FreeBSD/FreeBSD.hdr new file mode 100644 index 0000000000..6c2f8e185c --- /dev/null +++ b/doc/tools/src2html1.4a/FreeBSD/FreeBSD.hdr @@ -0,0 +1,25 @@ +Welcome to the hyperlinked source code tree for FreeBSD-2.1.0. This is an +attempt at a WWW document that allows you to find functions, structs +etc. in the FreeBSD source code by name.

+ +If you are interested in a particular type of symbols (e.g functions), use +the type links below. If you are interested in a particular directory in +FreeBSD, choose the directory link below.

+ +Follow the links until you reach the source code you are interested in.

+ +

Bugs and Missing Features

+ +I am using ctags and perl to find the symbols and produce the html documents. +My parsing of the ctags output (especially for variables) seems slightly +wrong. I'd appreciate a better way of doing things.

+ +The final code should have hyperlinks that allow you to follow references +to other symbols in the tree (e.g calls to bread() etc). This is difficult +given C's scoping rules, and I don't want to write a C grammar parser. +Until I can think of a clean way, I'll omit the desired hyperlinks.

+ + +Warren Toomey +wkt@cs.adfa.oz.au, January 1996 + diff --git a/doc/tools/src2html1.4a/FreeBSD/FreeBSD.s2h b/doc/tools/src2html1.4a/FreeBSD/FreeBSD.s2h new file mode 100644 index 0000000000..925eefeb58 --- /dev/null +++ b/doc/tools/src2html1.4a/FreeBSD/FreeBSD.s2h @@ -0,0 +1,68 @@ +# +# +# Input description for the FreeBSD 2.1.0 source tree +# Place this file and all the .hdr files in a directory, +# cd into that directory, and say `src2html FreeBSD.s2h'. +# +set Formdir /cgi-bin +set Htmldir FreeBSD-srctree +set Htmlroot . +set Newsrctree newsrc +set Srctree sys +# +dir conf Kernel configuration parameters +dir ddb Kernel debugging routines +dir dev/aic7xxx Adaptec AIC7770/AIC7870 sequencer code +dir dev/vn Vnode disk driver +dir gnu/i386/fpemul GNU's i387 floating point emulator +dir gnu/i386/isa Device drivers with GNU licensing +dir gnu/isdn An ISDN driver +dir i386/apm i386-specific power management +dir i386/apm/apm_init i386-specific power management +dir i386/boot/biosboot i386-specific boot code +dir i386/boot/dosboot i386-specific boot code +dir i386/boot/kzipboot i386-specific boot code +dir i386/boot/netboot i386-specific boot code +dir i386/eisa Device drivers for peripherals on the EISA bus +dir i386/i386 i386-specific code +dir i386/ibcs2 Intel Unix Binary Compatibility code +dir i386/include i386-specific C-language include files +dir i386/include/pc i386-specific C-language include files +dir i386/isa Device drivers for peripherals on the ISA bus +dir i386/isa/ic Device drivers for peripherals on the ISA bus +dir i386/isa/matcd Matsushita device driver +dir i386/isa/pcvt VT-220 emulation code +dir i386/isa/sound Device drivers for sound peripherals on the ISA bus +dir i386/linux Linux binaries support +dir i386/scsi Device drivers for SCSI peripherals on the ISA bus +dir isofs/cd9660 ISO CD9660 file-system code +dir kern The core OS routines: processes, scheduling, syscalls +dir libkern The kernel library +dir miscfs/deadfs Miscellaneous file systems +dir miscfs/devfs Miscellaneous file systems +dir miscfs/fdesc Miscellaneous file systems +dir miscfs/fifofs Miscellaneous file systems +dir miscfs/kernfs Miscellaneous file systems +dir miscfs/nullfs Miscellaneous file systems +dir miscfs/portal Miscellaneous file systems +dir miscfs/procfs Miscellaneous file systems +dir miscfs/specfs Miscellaneous file systems +dir miscfs/umapfs Miscellaneous file systems +dir miscfs/union Miscellaneous file systems +dir msdosfs The MS-DOS file system code +dir net Routing and general network interfaces +dir netccitt CCITT Networking code +dir netinet Internet protocols +dir netiso ISO Networking code +dir netiso/xebec ISO Networking code +dir netns Xerox NS Networking code +dir nfs The Network File System +dir pccard Interface code for PC-CARD controllers. +dir pci Device drivers for peripherals on the PCI bus +dir scsi Device drivers for peripherals on the SCSI bus +dir sys Widely used C-language include files +dir ufs/ffs The Berkeley Fast Filesystem +dir ufs/lfs The Log Filesystem +dir ufs/mfs The Memory Filesystem +dir ufs/ufs The Unix Filesystem +dir vm The Virtual Memory Management subsystem diff --git a/doc/tools/src2html1.4a/FreeBSD/conf.hdr b/doc/tools/src2html1.4a/FreeBSD/conf.hdr new file mode 100644 index 0000000000..103742dbe2 --- /dev/null +++ b/doc/tools/src2html1.4a/FreeBSD/conf.hdr @@ -0,0 +1,9 @@ +The conf directory holds miscellaneous files, such as the list of +files which are needed/optional in the OS. The main file of concern is +param.c, which describes the system-dependent configuration +parameters of FreeBSD. + +The 4.3BSD Internals book by Leffler, McKusick, Karels and Quarterman +doesn't really cover this directory. It is vaguely covered in Chapter 8 of +the "System Performance Tuning" Nutshell book by Mike Loukides. +

diff --git a/doc/tools/src2html1.4a/FreeBSD/ddb.hdr b/doc/tools/src2html1.4a/FreeBSD/ddb.hdr new file mode 100644 index 0000000000..2882f3dfa8 --- /dev/null +++ b/doc/tools/src2html1.4a/FreeBSD/ddb.hdr @@ -0,0 +1,6 @@ +The ddb directory holds routines used to debug the kernel. +The 4.3BSD Internals book by Leffler, McKusick, Karels and Quarterman +doesn't really cover this directory. However, some information has been +presented by Kirk KcKusick and Keith Bostic in their "UNIX Kernel Internals" +notes, which they have presented in many places in the past few years. +

diff --git a/doc/tools/src2html1.4a/FreeBSD/i386.i386.hdr b/doc/tools/src2html1.4a/FreeBSD/i386.i386.hdr new file mode 100644 index 0000000000..72ea58d1f1 --- /dev/null +++ b/doc/tools/src2html1.4a/FreeBSD/i386.i386.hdr @@ -0,0 +1,5 @@ +The i386/i386 directory holds the routines that deal with the Intel +386/486 CPU in the PC architecture. +The 4.3BSD Internals book by Leffler, McKusick, Karels and Quarterman +doesn't describe this anywhere at all, because this is machine-specific. +

diff --git a/doc/tools/src2html1.4a/FreeBSD/i386.include.hdr b/doc/tools/src2html1.4a/FreeBSD/i386.include.hdr new file mode 100644 index 0000000000..7acfb0ec1b --- /dev/null +++ b/doc/tools/src2html1.4a/FreeBSD/i386.include.hdr @@ -0,0 +1,5 @@ +The i386/include directory holds C-language include files that +define things that are specific about the PC architecture.

+ +The 4.3BSD Internals book by Leffler, McKusick, Karels and Quarterman +doesn't describe this anywhere at all.

diff --git a/doc/tools/src2html1.4a/FreeBSD/i386.isa.hdr b/doc/tools/src2html1.4a/FreeBSD/i386.isa.hdr new file mode 100644 index 0000000000..ec13230f00 --- /dev/null +++ b/doc/tools/src2html1.4a/FreeBSD/i386.isa.hdr @@ -0,0 +1,10 @@ +The i386/isa directory holds the routines that deal with the ISA +I/O bus in the PC architecture. +The 4.3BSD Internals book by Leffler, McKusick, Karels and Quarterman +doesn't describe this anywhere at all, because this is machine-specific. +You can however glean some information from the following chapter: + +

+
Chapter 8, pp 225-256 Device Drivers. +
+

diff --git a/doc/tools/src2html1.4a/FreeBSD/i386.stand.hdr b/doc/tools/src2html1.4a/FreeBSD/i386.stand.hdr new file mode 100644 index 0000000000..c548c044b0 --- /dev/null +++ b/doc/tools/src2html1.4a/FreeBSD/i386.stand.hdr @@ -0,0 +1,14 @@ +The i386/stand directory holds functions that are useful, but cannot +be called from the kernel. For example printf() is great, but if the kernel +called printf() it would generate a TRAP and wind up back in the kernel.

+ +The functions here emulate these functions by dealing directly with the +hardware on the system.

+ +The 4.3BSD Internals book by Leffler, McKusick, Karels and Quarterman +covers machine-independent stand functionality in: + +

+
Chapter 13.2, pg 394 Bootstrapping. +
+

diff --git a/doc/tools/src2html1.4a/FreeBSD/kern.hdr b/doc/tools/src2html1.4a/FreeBSD/kern.hdr new file mode 100644 index 0000000000..f8ec13e4a1 --- /dev/null +++ b/doc/tools/src2html1.4a/FreeBSD/kern.hdr @@ -0,0 +1,18 @@ +The kern directory holds the core functionality of FreeBSD: +system startup, core system calls and syscall dispatching, process +management, scheduling, signals, file descriptors, top-level filesystem +code, interprocess communication and terminal handling.

+ +The 4.3BSD Internals book by Leffler, McKusick, Karels and Quarterman +covers kern in: + +

+
Chapter 2, pp 19-42 Overview of the Kernel. +
Chapter 3, pp 43-66 Kernel Services. +
Chapter 4, pp 69-108 Process Management. +
Chapter 6, pp 169-186 I/O System Overview. +
Chapter 9, pp 259-278 Terminal Handling. +
Chapter 10, pp 281-309 Interprocess Communication. +
Chapter 13, pp 393-411 System Startup. +
+

diff --git a/doc/tools/src2html1.4a/FreeBSD/net.hdr b/doc/tools/src2html1.4a/FreeBSD/net.hdr new file mode 100644 index 0000000000..59c1f67741 --- /dev/null +++ b/doc/tools/src2html1.4a/FreeBSD/net.hdr @@ -0,0 +1,11 @@ +The net directory holds the network functionality of FreeBSD that +deals with routing and generic interfaces: SLIP, PPP, Ethernet, packet +filters. + +The 4.3BSD Internals book by Leffler, McKusick, Karels and Quarterman +covers kern in: + +

+
Chapter 11, pp 311-341 Network Communication. +
+

diff --git a/doc/tools/src2html1.4a/FreeBSD/netinet.hdr b/doc/tools/src2html1.4a/FreeBSD/netinet.hdr new file mode 100644 index 0000000000..19cdffa577 --- /dev/null +++ b/doc/tools/src2html1.4a/FreeBSD/netinet.hdr @@ -0,0 +1,10 @@ +The netinet directory holds the code for the Internet network +protocols used in FreeBSD: TCP, IP, ICMP, ARP.

+ +The 4.3BSD Internals book by Leffler, McKusick, Karels and Quarterman +covers netinet in: + +

+
Chapter 12, pp 343-389 Network Protocols. +
+

diff --git a/doc/tools/src2html1.4a/FreeBSD/nfs.hdr b/doc/tools/src2html1.4a/FreeBSD/nfs.hdr new file mode 100644 index 0000000000..f9aeab2bbb --- /dev/null +++ b/doc/tools/src2html1.4a/FreeBSD/nfs.hdr @@ -0,0 +1,7 @@ +The nfs directory holds the code for the Network File System. +The code was developed from a specification of NFS from Sun Microsystems.

+ +The 4.3BSD Internals book by Leffler, McKusick, Karels and Quarterman +doesn't cover nfs. You probably don't really want to delve into +it too much, but there is an RFC around describing the protocol, but not +the code here.

diff --git a/doc/tools/src2html1.4a/FreeBSD/stand.hdr b/doc/tools/src2html1.4a/FreeBSD/stand.hdr new file mode 100644 index 0000000000..9e7df8861f --- /dev/null +++ b/doc/tools/src2html1.4a/FreeBSD/stand.hdr @@ -0,0 +1,14 @@ +The stand directory holds functions that are useful, but cannot be +called from the kernel. For example printf() is great, but if the kernel +called printf() it would generate a TRAP and wind up back in the kernel.

+ +The functions here emulate these functions by dealing directly with the +hardware on the system.

+ +The 4.3BSD Internals book by Leffler, McKusick, Karels and Quarterman +covers stand in: + +

+
Chapter 13.2, pg 394 Bootstrapping. +
+

diff --git a/doc/tools/src2html1.4a/FreeBSD/sys.hdr b/doc/tools/src2html1.4a/FreeBSD/sys.hdr new file mode 100644 index 0000000000..2624741a87 --- /dev/null +++ b/doc/tools/src2html1.4a/FreeBSD/sys.hdr @@ -0,0 +1,6 @@ +The sys directory holds C-language include files that are used +by all parts of the FreeBSD source tree.

+ +The 4.3BSD Internals book by Leffler, McKusick, Karels and Quarterman +doesn't cover these files specifically, but discussion of their contents +crops up everywhere.

diff --git a/doc/tools/src2html1.4a/FreeBSD/ufs.hdr b/doc/tools/src2html1.4a/FreeBSD/ufs.hdr new file mode 100644 index 0000000000..8cec8cddac --- /dev/null +++ b/doc/tools/src2html1.4a/FreeBSD/ufs.hdr @@ -0,0 +1,10 @@ +The ufs directory holds the code for the Berkeley Fast Filesystem, +which is the filesystem used on locally mounted hard and floppy disks.

+ +The 4.3BSD Internals book by Leffler, McKusick, Karels and Quarterman +covers ufs in: + +

+
Chapter 7, pp 187-223 The Filesystem. +
+

diff --git a/doc/tools/src2html1.4a/FreeBSD/vm.hdr b/doc/tools/src2html1.4a/FreeBSD/vm.hdr new file mode 100644 index 0000000000..26205175a8 --- /dev/null +++ b/doc/tools/src2html1.4a/FreeBSD/vm.hdr @@ -0,0 +1,9 @@ +The vm directory holds the virtual memory subsystem used by +FreeBSD. This was derived from the VM system used in the Mach kernel, +with the interface to the rest of the kernel rewritten. As such, it is +not described in the +4.3BSD Internals book by Leffler, McKusick, Karels and Quarterman, +but it is described by Kirk KcKusick and Keith Bostic in their +"UNIX Kernel Internals" +notes, which they have presented in many places in the past few years. +

-- cgit v1.2.3