From nobody Sat Nov 12 19:10:30 2022 X-Original-To: dev-commits-src-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4N8lX66Kz1z4ff1f; Sat, 12 Nov 2022 19:10:30 +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 4N8lX65lqcz3Ndx; Sat, 12 Nov 2022 19:10:30 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1668280230; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=zMGpuHAlZIS1DjbvsTt7DQ2J1ChjK2h39dl3bNdRV6w=; b=Nmu54TiP6T2/8NoeCG1nK39nTmxFUwdisHuDQrbHC0Mk9ujO0+Ut8gU3cFbb8MLA8plQ5y 9tB/3okU8iVu3lUdCrzXGZX41TOduyiGWk5IRG+3bpRHmVIxaLJSAwdDbvuEal5n9e0gof wKkf6WASCcFhED7kvf3tnwbjyUe0HVMGSd73pMXnjfE/jtFszihkOYL3uOv+brRjH94+G3 rhE29SduJyB6wZtN5BzB5O4yokjTLLHqOIE1SD2hy2GsmfmfiZoz87sdNeWEaM0VybvVVk XHG2LLZMFsaXRALsL+RGySGaL+8IvYqhBdjvb9gDo5cpcO4PXss5LR/zAlBEmA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1668280230; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=zMGpuHAlZIS1DjbvsTt7DQ2J1ChjK2h39dl3bNdRV6w=; b=qztl+gqsv7K7dygqeC47eZae4YOY3HnU3qcwuh3fS74bAF8MK+8nqkU+vaU/IuwF21JhP0 +TgO0n/ZPQyBAOSStkXqFVxptYMK/FZmvccgvt71Kbi7mexC1CUVR3VEpws0UofllfIiOj jx4fO4AYznrTYQdweGIBoC5Nfqpd+JIVf+RmAj/L6qdpcNZyeQH4nvd7DNK3hQ8GNtBajm TdON3vK+SsNiL+AhYGJ1EXtqUV7kPW0uOrLAmBaGXiHv2Qtd0fcOTRaW8ZAB7+osVF1YDY wyxMQc+wytY/lDxtGEbVFXewPZJWY0TzznpcK2O3fySKZ96SdjNFwZCFquO5vQ== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1668280230; a=rsa-sha256; cv=none; b=QikH7ZzMMEtJTgcTvkiwsudjxdmf1mDUs2DqwAu/N6nrnTtDWATqbRrvp/gGCeV/V+skZy pdiuZtpQSsSNF8m8976eH11Y9yxoow94SkvO5J6HZaK6F8mP4tdP+lsnVE4RpNSSCzyumR POwlOliUCiruWNxfzcmHywuR+dRIaUwgKocwJQo5WQm9MoMa4UHlt/91R38njijnmTR5Us uVWMCCXIXYWP6osNN43sfv4jJIuuimViARplh9ZrKenQVFVaGaGg7mKOXmgayYe4uNvYZz Zg0f1/o+RrCUaVBYciUMXUTZUos8xkCLxoTQi9ldX5APKP+9dAm7ar4gWSEz3Q== ARC-Authentication-Results: i=1; mx1.freebsd.org; none 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 4N8lX64qHLzY6l; Sat, 12 Nov 2022 19:10:30 +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 2ACJAUSr009485; Sat, 12 Nov 2022 19:10:30 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 2ACJAU0l009484; Sat, 12 Nov 2022 19:10:30 GMT (envelope-from git) Date: Sat, 12 Nov 2022 19:10:30 GMT Message-Id: <202211121910.2ACJAU0l009484@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-branches@FreeBSD.org From: Mitchell Horne Subject: git: 8497a86e835f - stable/12 - readme: update style List-Id: Commit messages for all branches of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-src-all@freebsd.org X-BeenThere: dev-commits-src-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: mhorne X-Git-Repository: src X-Git-Refname: refs/heads/stable/12 X-Git-Reftype: branch X-Git-Commit: 8497a86e835f2dc5aad81a84b404595e0c6d35a4 Auto-Submitted: auto-generated X-ThisMailContainsUnwantedMimeParts: N The branch stable/12 has been updated by mhorne: URL: https://cgit.FreeBSD.org/src/commit/?id=8497a86e835f2dc5aad81a84b404595e0c6d35a4 commit 8497a86e835f2dc5aad81a84b404595e0c6d35a4 Author: Warner Losh AuthorDate: 2021-03-12 00:21:16 +0000 Commit: Mitchell Horne CommitDate: 2022-11-12 19:09:20 +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. (cherry picked from commit 2918e9fdb82ffe5e95cab90a754bc6c2b6dd16a2) --- README.md | 109 ++++++++++++++++++++------------------------------------------ 1 file changed, 34 insertions(+), 75 deletions(-) diff --git a/README.md b/README.md index 632b4542c064..5b3aec18d6ed 100644 --- a/README.md +++ b/README.md @@ -1,83 +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 Commands and libraries under the GNU General Public License - (GPL) or Lesser General Public License (LGPL). 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 | Commands and libraries under the GNU General Public License (GPL) or Lesser General Public License (LGPL). 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).