d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

README: changes and fixups

Browse Source 
Two orthogonal goals:
	- try to make README look a little nicer on phabricator by using
	  Remarkup syntax for commands (using `` instead of using a closing ')
	- try to make README look a little nicer on github.

	- Don't encourage `make world` when the handbook specifies otherwise
	- Change language around documentation to be a bit clearer

MFC After:	2 weeks
This commit is contained in:
Eitan Adler 2015-04-19 07:16:44 +00:00
parent 92f7441328
commit 94ec856683
Notes: svn2git 2020-12-20 02:59:44 +00:00 
svn path=/head/; revision=281727
1 changed files with 12 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README
View File

@ -8,37 +8,32 @@ sources in this tree - please see the specific source directories for
more information). more information).
The Makefile in this directory supports a number of targets for The Makefile in this directory supports a number of targets for
building components (or all) of the FreeBSD source tree, the most building components (or all) of the FreeBSD source tree. See build(7)
commonly used one being ``world'', which rebuilds and installs and http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/makeworld.html
everything in the FreeBSD system from the source tree except the
kernel, the kernel-modules and the contents of /etc. The ``world''
target should only be used in cases where the source tree has not
changed from the currently running version. See:
http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/makeworld.html
for more information, including setting make(1) variables. for more information, including setting make(1) variables.
The ``buildkernel'' and ``installkernel'' targets build and install The `buildkernel` and `installkernel` targets build and install
the kernel and the modules (see below). Please see the top of the kernel and the modules (see below). Please see the top of
the Makefile in this directory for more information on the the Makefile in this directory for more information on the
standard build targets and compile-time flags. standard build targets and compile-time flags.
Building a kernel is a somewhat more involved process, documentation Building a kernel is a somewhat more involved process. See build(7), config(8),
for which can be found at: and http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/kernelconfig.html
http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/kernelconfig.html for more information.
And in the config(8) man page.
Note: If you want to build and install the kernel with the Note: If you want to build and install the kernel with the
``buildkernel'' and ``installkernel'' targets, you might need to build `buildkernel` and `installkernel` targets, you might need to build
world before. More information is available in the handbook. world before. More information is available in the handbook.
The sample kernel configuration files reside in the sys/<arch>/conf The kernel configuration files reside in the sys/<arch>/conf
sub-directory (assuming that you've installed the kernel sources), the sub-directory. GENERIC is the default configuration used in release builds.
file named GENERIC being the one used to build your initial installation NOTES contains entries and documentation for all possible
kernel. The file NOTES contains entries and documentation for all possible
devices, not just those commonly used. devices, not just those commonly used.
Source Roadmap: Source Roadmap:
--------------- ---------------
bin System/user commands. bin System/user commands.
cddl Various commands and libraries under the Common Development cddl Various commands and libraries under the Common Development