i386 removal, part 70/x: Remove some i386 specific bits in the kernel.
[dragonfly.git] / README
1 This is the top level of the DragonFly source directory.
2
3 For copyright information, please see the file COPYRIGHT in this
4 directory (additional copyright information also exists for some
5 sources in this tree - please see the specific source directories for
6 more information).
7
8 The Makefile in this directory supports a number of targets for
9 building components (or all) of the DragonFly source tree, the most
10 commonly used being ``buildworld'' and ``installworld'', which rebuild
11 and install everything in the DragonFly system from the source tree
12 except the kernel, the kernel-modules and the contents of /etc.  The
13 ``buildkernel'' and ``installkernel'' targets build and install
14 the kernel and the modules (see below).  Please see the top of
15 the Makefile in this directory for more information on the
16 standard build targets and compile-time flags.
17
18 Building a kernel is a somewhat involved process.  Documentation
19 for it can be found at:
20    http://www.dragonflybsd.org/docs/handbook/
21 Also see the build(7) and config(8) man pages.
22
23 Note: If you want to build and install the kernel with the
24 ``buildkernel'' and ``installkernel'' targets, you might need to build
25 world before.  More information is available in the DragonFly handbook.
26
27 The kernel configuration files reside in the sys/config sub-directory.
28 The X86_64_GENERIC is the default x86_64 kernel configuration used in
29 release builds.  The VKERNEL64 is the default 64 bit vkernel(7) kernel
30 configuration file.  The file LINT64 contains entries for all possible
31 devices, not just those commonly used, and is meant more as a general
32 reference than an actual kernel configuration file (a kernel built
33 from it wouldn't even run).  Also see the config(8) man page.
34
35
36 Source Roadmap:
37 ---------------
38 bin             System/user commands.
39
40 contrib         Packages contributed by 3rd parties.
41
42 crypto          Cryptography stuff (see crypto/README).
43
44 doc             Documentation for DragonFly BSD.
45
46 etc             Template files for /etc.
47
48 games           Amusements.
49
50 gnu             Various commands and libraries under the GNU Public License.
51                 Please see gnu/COPYING* for more information.
52
53 include         System include files.
54
55 lib             System libraries.
56
57 libexec         System daemons.
58
59 nrelease        Framework for building the ``live'' CD image.
60
61 initrd          Build system for statically linked /rescue utilities and
62                 initial ramdisk creation.
63
64 sbin            System commands.
65
66 share           Shared resources.
67
68 sys             Kernel sources.
69
70 test            System tests.
71
72 tools           Utilities for regression testing and miscellaneous tasks.
73
74 usr.bin         User commands.
75
76 usr.sbin        System administration commands.