FreeBSD src
Go to file
Mitchell Horne c3b611e153 hier(7): drop list of /usr/include subdirectories
It is nice to have, however, the location of this information means that
it will naturally be missed by developers adding or removing directories
to the layout, so it trends out-of-date and it is out-of-date.

The target audience for hier(7) is users and administrators. It is not
expected to be a place that programmers should go to learn about the
purposes of the different C headers provided by FreeBSD.

Program authors needing FreeBSD-specific interfaces or libraries
(#include <sys/queue.h>, for instance) will either be following a more
detailed man page, or consulting the header contents directly. Folks
targeting standardized headers (#include <sys/time.h>) will not need
hier(7) to tell them where those headers are under /usr/include.

In other words, this is more detail than necessary for this document.
I'd go as far as to say that many of the existing entries in this list
do little more than parrot the name of the directory.

With all this in mind, let's drop the maintenance burden.

Reviewed by:	imp, emaste
MFC after:	1 week
Sponsored by:	The FreeBSD Foundation
Differential Revision:	https://reviews.freebsd.org/D40000
2023-05-10 10:17:41 -03:00
.cirrus-ci Cirrus-CI: add some timing info on pkg install failure 2021-08-04 15:02:00 -04:00
.github MAINTAINERS: Add myself to stand 2023-05-07 22:30:10 -06:00
bin dd: Fix SIGINT handling. 2023-05-05 12:42:32 +00:00
cddl dtrace: add register bindings for RISC-V 2023-04-20 13:35:57 -04:00
contrib libfido2: update to 1.10.0 2023-05-05 19:57:34 -04:00
crypto openssh: Update configure for DISABLE_LASTLOG 2023-04-20 18:08:16 -04:00
etc calendar: cleanup obsolete directories 2023-05-09 00:43:12 +02:00
gnu Update/fix Makefile.depend for userland 2023-04-18 17:14:23 -07:00
include includes: avoid installing if_wg.h twice 2023-05-09 21:09:39 -04:00
kerberos5 Update/fix Makefile.depend for userland 2023-04-18 17:14:23 -07:00
lib libfido2: specify OpenSSL 1.1 API 2023-05-09 09:46:09 -04:00
libexec rtld: don't add extraneous -L directory when MK_TOOLCHAIN == no 2023-05-02 18:01:43 -04:00
release release: Report disk image filename 2023-05-03 16:58:22 -04:00
rescue Update/fix Makefile.depend for userland 2023-04-18 17:14:23 -07:00
sbin ifconfig: fix family selection after 982cd5ae8e 2023-05-10 12:40:51 +00:00
secure Update/fix Makefile.depend for userland 2023-04-18 17:14:23 -07:00
share hier(7): drop list of /usr/include subdirectories 2023-05-10 10:17:41 -03:00
stand loader: install help files only once 2023-05-09 20:18:19 -04:00
sys arm64: fix stack unwinding past exception handlers 2023-05-10 12:54:54 +01:00
targets local.dirdeps.mk skip N_host_libs for non-FreeBSD host 2023-05-04 11:58:39 -07:00
tests netlink: temporary skip snl(3) capped test. 2023-05-09 14:59:41 +00:00
tools pkgbase: report error if files are installed multiple times 2023-05-09 21:10:03 -04:00
usr.bin tsort: Error out if writing to stdout failed. 2023-05-04 18:51:11 +00:00
usr.sbin freebsd-update: Fix merging already-updated files 2023-05-09 16:28:09 -07:00
.arcconfig arcanist: use FreeBSD/git project repository instead of FreeBSD/svn 2022-08-23 14:16:41 +00:00
.arclint arc lint: ignore /tests/ in chmod 2017-12-19 03:38:06 +00:00
.cirrus.yml Cirrus-CI: add gcc12 automatic task on primary GitHub mirror 2023-05-09 17:13:44 -04:00
.clang-format clang-format: Add bitset loop macros 2021-09-21 12:08:01 -04:00
.git-blame-ignore-revs Add git-blame ignore file 2023-01-23 15:27:25 -05:00
.gitattributes Add a basic clang-format configuration file 2019-06-07 15:23:52 +00:00
.gitignore .gitignore: Ignore LSP generated .cache 2023-03-07 10:04:18 -05:00
CONTRIBUTING.md CONTRIBUTING: add intro describing the ways we accept contributions 2023-04-27 19:43:56 -04:00
COPYRIGHT Happy New Year 2023! 2023-01-01 13:44:43 +08:00
LOCKS LOCKS: update current locks 2018-06-09 03:08:04 +00:00
MAINTAINERS MAINTAINERS: Add myself to stand 2023-05-07 22:30:10 -06:00
Makefile Add jobs.mk to allow for target-jobs 2023-04-20 09:40:39 -07:00
Makefile.inc1 Makefile.inc1: use make builtin :ts instead of sed 2023-05-05 08:14:35 -04:00
Makefile.libcompat libcompat: avoid installing include files twice 2022-11-16 19:15:20 -05:00
Makefile.sys.inc AUTO_OBJ: For all top-level targets enforce using an OBJDIR. 2017-12-05 21:29:47 +00:00
ObsoleteFiles.inc md5: Improve compatibility. 2023-05-08 06:56:22 +00:00
README.md Vendor import of spleen font 1.9.3 2023-05-04 11:05:42 -04:00
RELNOTES RELNOTES: fix consistency 2023-05-06 23:32:04 -06:00
UPDATING Remove portsnap(8) 2023-04-22 18:12:37 -07:00

FreeBSD Source:

This is the top level of the FreeBSD source directory.

FreeBSD is an operating system used to power modern servers, desktops, and embedded platforms. A large community has continually developed it for more than thirty years. Its advanced networking, security, and storage features have made FreeBSD the platform of choice for many of the busiest web sites and most pervasive embedded networking and storage devices.

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), config(8), FreeBSD handbook on building userland, and Handbook for kernels for more information, including setting make(1) variables.

For information on the CPU architectures and platforms supported by FreeBSD, see the FreeBSD website's Platforms page.

Source Roadmap:

Directory Description
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 Commands and libraries under the GNU General Public License (GPL) or Lesser General Public License (LGPL). Please see gnu/COPYING and gnu/COPYING.LIB 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 (see sys/README.md).
targets Support for experimental DIRDEPS_BUILD
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 FreeBSD Handbook.