Fix a memory leak I introduced when I changed the vtb_buffer from
[dragonfly.git] / README
CommitLineData
b515e798 1This is the top level of the DragonFly source directory. This file
984263bc
MD
2was last revised on:
3$FreeBSD: src/README,v 1.15.2.4 2002/04/26 16:01:35 bmah Exp $
4d190911 4$DragonFly: src/README,v 1.6 2005/09/23 19:47:49 swildner Exp $
984263bc
MD
5
6For copyright information, please see the file COPYRIGHT in this
7directory (additional copyright information also exists for some
8sources in this tree - please see the specific source directories for
9more information).
10
11The Makefile in this directory supports a number of targets for
b515e798 12building components (or all) of the DragonFly source tree, the most
984263bc 13commonly used one being ``world'', which rebuilds and installs
b515e798 14everything in the DragonFly system from the source tree except the
984263bc
MD
15kernel, the kernel-modules and the contents of /etc. The
16``buildkernel'' and ``installkernel'' targets build and install
17the kernel and the modules (see below). Please see the top of
18the Makefile in this directory for more information on the
19standard build targets and compile-time flags.
20
b515e798
JR
21Building a kernel is a somewhat involved process. Documentation
22for it can be found at:
984263bc 23 http://www.FreeBSD.org/handbook/kernelconfig.html
b515e798
JR
24Although the above reference is FreeBSD-specific, it is also generally
25applicable to DragonFly. Also see the the config(8) man page.
26
984263bc
MD
27Note: If you want to build and install the kernel with the
28``buildkernel'' and ``installkernel'' targets, you might need to build
b515e798 29world before. More information is available in the FreeBSD handbook.
984263bc
MD
30
31The sample kernel configuration files reside in the sys/<arch>/conf
32sub-directory (assuming that you've installed the kernel sources), the
33file named GENERIC being the one used to build your initial installation
34kernel. The file LINT contains entries for all possible devices, not
35just those commonly used, and is meant more as a general reference
36than an actual kernel configuration file (a kernel built from it
37wouldn't even run).
38
39
40Source Roadmap:
41---------------
42bin System/user commands.
43
44contrib Packages contributed by 3rd parties.
45
46crypto Cryptography stuff (see crypto/README).
47
48etc Template files for /etc.
49
50games Amusements.
51
52gnu Various commands and libraries under the GNU Public License.
53 Please see gnu/COPYING* for more information.
54
55include System include files.
56
57kerberos5 Kerberos5 (Heimdal) package.
58
984263bc
MD
59lib System libraries.
60
61libexec System daemons.
62
b515e798
JR
63nrelease Framework for building the ``live'' CD image.
64
984263bc
MD
65sbin System commands.
66
67secure Cryptographic libraries and commands.
68
69share Shared resources.
70
71sys Kernel sources.
72
b515e798
JR
73test System tests.
74
984263bc
MD
75tools Utilities for regression testing and miscellaneous tasks.
76
77usr.bin User commands.
78
79usr.sbin System administration commands.