From owner-dev-commits-src-all@freebsd.org Fri Mar 12 00:39:07 2021 Return-Path: Delivered-To: dev-commits-src-all@mailman.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.nyi.freebsd.org (Postfix) with ESMTP id 2714A569007; Fri, 12 Mar 2021 00:39:07 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4DxRlH0g53z4bcl; Fri, 12 Mar 2021 00:39:07 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 09BAE64DA; Fri, 12 Mar 2021 00:39:07 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 12C0d6dS006836; Fri, 12 Mar 2021 00:39:06 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 12C0d6r5006835; Fri, 12 Mar 2021 00:39:06 GMT (envelope-from git) Date: Fri, 12 Mar 2021 00:39:06 GMT Message-Id: <202103120039.12C0d6r5006835@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Warner Losh Subject: git: 2918e9fdb82f - main - readme: update style MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: imp X-Git-Repository: src X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 2918e9fdb82ffe5e95cab90a754bc6c2b6dd16a2 Auto-Submitted: auto-generated X-BeenThere: dev-commits-src-all@freebsd.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: Commit messages for all branches of the src repository List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 12 Mar 2021 00:39:07 -0000 The branch main has been updated by imp: URL: https://cgit.FreeBSD.org/src/commit/?id=2918e9fdb82ffe5e95cab90a754bc6c2b6dd16a2 commit 2918e9fdb82ffe5e95cab90a754bc6c2b6dd16a2 Author: Warner Losh AuthorDate: 2021-03-12 00:21:16 +0000 Commit: Warner Losh CommitDate: 2021-03-12 00:38:30 +0000 readme: update style Update the style to one sentence per line, as is currently used in the FreeBSD document project. Make the links to the handbook clickable. --- README.md | 108 ++++++++++++++++++++------------------------------------------ 1 file changed, 34 insertions(+), 74 deletions(-) diff --git a/README.md b/README.md index 72bd634cd813..9f07ed61647e 100644 --- a/README.md +++ b/README.md @@ -1,82 +1,42 @@ FreeBSD Source: --------------- -This is the top level of the FreeBSD source directory. This file -was last revised on: -$FreeBSD$ +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. +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. +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), -https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/makeworld.html, and -https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/kernelconfig.html -for more information, including setting make(1) variables. +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](https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/makeworld.html), and [Handbook for kernels](https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/kernelconfig.html) for more information, including setting make(1) variables. 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. - -sys//conf Kernel configuration files. GENERIC is the configuration - used in release builds. NOTES contains documentation of - all possible entries. - -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 +| 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](crypto/README)). | +| etc | Template files for /etc. | +| gnu | Various commands and libraries under the GNU Public License. Please see [gnu/COPYING](gnu/COPYING) and [gnu/COPYING.LIB](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. | +| sys//conf | Kernel configuration files. GENERIC is the configuration used in release builds. NOTES contains documentation of all possible entries. | +| tests | Regression tests which can be run by Kyua. See [tests/README](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](https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/current-stable.html).