freebsd/README

This is the top level of the FreeBSD source directory.  This file
was last revised on:
$FreeBSD$

For copyright information, please see the file COPYRIGHT in this
directory (additional copyright information also exists for some
sources in this tree - please see the specific source directories for
more information).

The Makefile in this directory supports a number of targets for
building components (or all) of the FreeBSD source tree.  See build(7)
and https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/makeworld.html
for more information, including setting make(1) variables.

The `buildkernel` and `installkernel` targets build and install
the kernel and the modules (see below).  Please see the top of
the Makefile in this directory for more information on the
standard build targets and compile-time flags.

Building a kernel is a somewhat more involved process.  See build(7), config(8),
and https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/kernelconfig.html
for more information.

Note: If you want to build and install the kernel with the
`buildkernel` and `installkernel` targets, you might need to build
world before.  More information is available in the handbook.

The kernel configuration files reside in the sys/<arch>/conf
sub-directory.  GENERIC is the default configuration used in release builds.
NOTES contains entries and documentation for all possible
devices, not just those commonly used.


Source Roadmap:
---------------

bin		System/user commands.

cddl		Various commands and libraries under the Common Development
		and Distribution License.

contrib		Packages contributed by 3rd parties.

crypto		Cryptography stuff (see crypto/README).

etc		Template files for /etc.

gnu		Various commands and libraries under the GNU Public License.
		Please see gnu/COPYING* for more information.

include		System include files.

kerberos5	Kerberos5 (Heimdal) package.

lib		System libraries.

libexec		System daemons.

release		Release building Makefile & associated tools.

rescue		Build system for statically linked /rescue utilities.

sbin		System commands.

secure		Cryptographic libraries and commands.

share		Shared resources.

stand		Boot loader sources.

sys		Kernel sources.

tests		Regression tests which can be run by Kyua.  See tests/README
		for additional information.

tools		Utilities for regression testing and miscellaneous tasks.

usr.bin		User commands.

usr.sbin	System administration commands.


For information on synchronizing your source tree with one or more of
the FreeBSD Project's development branches, please see:

  https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/current-stable.html
Bring back the README, this time attempting to be a little more informative about what the user is seeing here. 1997-01-01 14:06:29 +00:00			`This is the top level of the FreeBSD source directory. This file`
$Id$ -> $FreeBSD$ 1999-08-28 01:35:59 +00:00			`was last revised on:`
			$FreeBSD$
Bring back the README, this time attempting to be a little more informative about what the user is seeing here. 1997-01-01 14:06:29 +00:00
			`For copyright information, please see the file COPYRIGHT in this`
			`directory (additional copyright information also exists for some`
			`sources in this tree - please see the specific source directories for`
			`more information).`

			`The Makefile in this directory supports a number of targets for`
README: changes and fixups 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 2015-04-19 07:16:44 +00:00			`building components (or all) of the FreeBSD source tree. See build(7)`
Update several more URLs - Primarily http -> https - Primarily FreeBSD project URLs 2017-10-29 08:17:03 +00:00			`and https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/makeworld.html`
Simply running ``make world'' will bomb unless you dig up the undocumented HISTORICAL_MAKE_WORLD variable and set it. Note it here so the blow up will not really be a surprise to people who read. Link the buildingworld chapter of our handbook in the README while I'm here. 2006-06-07 03:33:48 +00:00			`for more information, including setting make(1) variables.`

README: changes and fixups 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 2015-04-19 07:16:44 +00:00			The `buildkernel` and `installkernel` targets build and install
Point out, that build/installkernel need a built world and that more information can be found in the handbook. Requested by: sheldonh Reviewed by: sheldonh 2000-07-31 12:39:09 +00:00			`the kernel and the modules (see below). Please see the top of`
			`the Makefile in this directory for more information on the`
			`standard build targets and compile-time flags.`
Bring back the README, this time attempting to be a little more informative about what the user is seeing here. 1997-01-01 14:06:29 +00:00
README: changes and fixups 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 2015-04-19 07:16:44 +00:00			`Building a kernel is a somewhat more involved process. See build(7), config(8),`
Update several more URLs - Primarily http -> https - Primarily FreeBSD project URLs 2017-10-29 08:17:03 +00:00			`and https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/kernelconfig.html`
README: changes and fixups 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 2015-04-19 07:16:44 +00:00			`for more information.`

Point out, that build/installkernel need a built world and that more information can be found in the handbook. Requested by: sheldonh Reviewed by: sheldonh 2000-07-31 12:39:09 +00:00			`Note: If you want to build and install the kernel with the`
README: changes and fixups 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 2015-04-19 07:16:44 +00:00			`buildkernel` and `installkernel` targets, you might need to build
Point out, that build/installkernel need a built world and that more information can be found in the handbook. Requested by: sheldonh Reviewed by: sheldonh 2000-07-31 12:39:09 +00:00			`world before. More information is available in the handbook.`
Bring back the README, this time attempting to be a little more informative about what the user is seeing here. 1997-01-01 14:06:29 +00:00
README: changes and fixups 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 2015-04-19 07:16:44 +00:00			`The kernel configuration files reside in the sys/<arch>/conf`
			`sub-directory. GENERIC is the default configuration used in release builds.`
			`NOTES contains entries and documentation for all possible`
README: - the reference to 'ancient' LINT file was added in 2000 [r64047 \| alex \| 2000-07-31]. Remove the reference entirely now. - add the tests directory 2015-04-12 23:43:41 +00:00			`devices, not just those commonly used.`
Bring back the README, this time attempting to be a little more informative about what the user is seeing here. 1997-01-01 14:06:29 +00:00

			`Source Roadmap:`
			`---------------`
README: changes and fixups 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 2015-04-19 07:16:44 +00:00
Spell "FreeBSD" correctly. `buildworld' is no longer a strict prerequisite for `buildkernel' as of Makefile.inc1,v 1.184. Fix kernel configuration files path to look MI. Mention src/kerberos5. 2002-03-26 12:35:49 +00:00			`bin System/user commands.`
Bring back the README, this time attempting to be a little more informative about what the user is seeing here. 1997-01-01 14:06:29 +00:00
Add the cddl/ directory. 2010-11-14 11:32:56 +00:00			`cddl Various commands and libraries under the Common Development`
			`and Distribution License.`

Bring back the README, this time attempting to be a little more informative about what the user is seeing here. 1997-01-01 14:06:29 +00:00			`contrib Packages contributed by 3rd parties.`

Reflect reality: - Make world doesn't build the modules any more. - Mention the buildkernel/installkernel targets as common used targets. - LINT has gone, NOTES is new but cannot be built. It is a pure reference file. However, I still mentioned LINT but pointed out the difference between the ancient LINT and the new NOTES. This should avoid confusion. - crypto/ subdir isn't export controlled any more. 2000-07-31 09:22:50 +00:00			`crypto Cryptography stuff (see crypto/README).`
Bring back the README, this time attempting to be a little more informative about what the user is seeing here. 1997-01-01 14:06:29 +00:00
Spell "FreeBSD" correctly. `buildworld' is no longer a strict prerequisite for `buildkernel' as of Makefile.inc1,v 1.184. Fix kernel configuration files path to look MI. Mention src/kerberos5. 2002-03-26 12:35:49 +00:00			`etc Template files for /etc.`
Bring back the README, this time attempting to be a little more informative about what the user is seeing here. 1997-01-01 14:06:29 +00:00
			`gnu Various commands and libraries under the GNU Public License.`
			`Please see gnu/COPYING* for more information.`

			`include System include files.`

Spell "FreeBSD" correctly. `buildworld' is no longer a strict prerequisite for `buildkernel' as of Makefile.inc1,v 1.184. Fix kernel configuration files path to look MI. Mention src/kerberos5. 2002-03-26 12:35:49 +00:00			`kerberos5 Kerberos5 (Heimdal) package.`

Bring back the README, this time attempting to be a little more informative about what the user is seeing here. 1997-01-01 14:06:29 +00:00			`lib System libraries.`

			`libexec System daemons.`

			`release Release building Makefile & associated tools.`

Add a note explaining what the rescue/ directory is for. PR: docs/93990 Submitted by: Ulf Lilleengen MFC after: 3 days 2006-03-01 20:14:55 +00:00			`rescue Build system for statically linked /rescue utilities.`

Bring back the README, this time attempting to be a little more informative about what the user is seeing here. 1997-01-01 14:06:29 +00:00			`sbin System commands.`

Slightly improve the description of "crypto". "DES" is a subset of what we have in secure/. 2000-08-31 17:59:01 +00:00			`secure Cryptographic libraries and commands.`
Bring back the README, this time attempting to be a little more informative about what the user is seeing here. 1997-01-01 14:06:29 +00:00
			`share Shared resources.`

Document the sys/boot -> stand move in hier.7 and the top-level README. Reviewed by: imp Differential Revision: https://reviews.freebsd.org/D13353 2017-12-03 20:36:36 +00:00			`stand Boot loader sources.`

Bring back the README, this time attempting to be a little more informative about what the user is seeing here. 1997-01-01 14:06:29 +00:00			`sys Kernel sources.`

README: - the reference to 'ancient' LINT file was added in 2000 [r64047 \| alex \| 2000-07-31]. Remove the reference entirely now. - add the tests directory 2015-04-12 23:43:41 +00:00			`tests Regression tests which can be run by Kyua. See tests/README`
			`for additional information.`

Bring back the README, this time attempting to be a little more informative about what the user is seeing here. 1997-01-01 14:06:29 +00:00			`tools Utilities for regression testing and miscellaneous tasks.`

			`usr.bin User commands.`

			`usr.sbin System administration commands.`


			`For information on synchronizing your source tree with one or more of`
			`the FreeBSD Project's development branches, please see:`

Correct the URLs for both READMEs for tracking src Previously there were two different URLs in two different READMEs, neither of which went anywhere. 2017-10-29 20:29:31 +00:00			`https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/current-stable.html`