From nobody Mon Dec 5 16:53:27 2022 X-Original-To: dev-commits-src-branches@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 4NQqPM5npPz4k8md; Mon, 5 Dec 2022 16:53:27 +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 4NQqPM54Lxz453v; Mon, 5 Dec 2022 16:53:27 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1670259207; 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=5miEdubvL3SqHbQGolrnpwQrHTarMTiiAsYsV97lqnY=; b=IwEUyc1wAzFHG+W6CVIQC3WPus9IkN2lMHaUiDx1H30RTS5s3odNalqqqoZ7bVCC8FOP+o 1bU/7d2DqJ5efg2Xv+vywxyjxK/vsDsHcZYisWySFk9gieGeVwhwwXRnwQPQG6wDt1vQvk 3LwC4cjad27Sd7tvpiYHsdVE/Eh4XiRRCghHVGvn3Vs9vPn3i2mmkA95hmaa/NJHpB32XK SgiuZgOMvVFktm+F/sAb8VA39ta6NpStpp5SViseOcfiCrVZ5bwhfNDUnItxLOtaXWJAHO TOgnXjD6W8pixbch1QaNScJ9cIJ7WaoxyE40wqopqgAprBcFE6kWMlHz4sR8mA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1670259207; 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=5miEdubvL3SqHbQGolrnpwQrHTarMTiiAsYsV97lqnY=; b=Z52TZvXSoDBPjeIOvFRZsBljxr40G0b4Kbs71Bfu5eLrjV9IlKA+u19mht1UKKa8aMF4Io 6HiJJ+6bStEnDYzFpI7OTwK3GR0f4Vz/kF0gn/dr8RTHPLxbSAgNN8476ft9/gSA0envL3 AaEpwEj7p20nb8oNY6c1xrWYyvc5VbZTP+sWDpXHhYguZzqbr3U5k4k6eQ0lVMrB0VIfTa wOH7DLdz/9Ue36V1e/ZJWqJp3YvNwqM7WKric87KVZquBn1UjwF3if73on6xkYfpX74+tp fSr5fnDMYBQHLKFhg2omGFbzK8eYsOoU5iWUdKpWvewpOG91XCGVTtyPRiZ1Zw== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1670259207; a=rsa-sha256; cv=none; b=HRXSLaaz6P/5Q4tklafbBKLUeaoxmZLTWn9kYbTVnpjacYMwgeL/9xoI/XJ+yGJFqPJsvd 4PyxGnI5nVlp+CIMHgciPXpYdEZR1wcNNWd/UQBd5peRRDc5Y5flevk6j2990yTLRyAFlG ZzZfcgc786XL/eAEM+W/8JFUnqGU61DRmgjfEXZWEuB0ip98NfGc4ksLZrxs3X4SIE5l3g W5RYXa+a1F1C3P7TYljBgci3DvnAaT9GD4985zabzF6ZtCGPieWsetkqhH3jFvJiAOlwpF lUpPtwQRFfSCoSQdaOHI8shRuLsTgNbvo2zZBspmAVzSBwUPzV2N2CeQHzNrRA== 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 4NQqPM4877z14rF; Mon, 5 Dec 2022 16:53:27 +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 2B5GrRQT068112; Mon, 5 Dec 2022 16:53:27 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 2B5GrRxo068111; Mon, 5 Dec 2022 16:53:27 GMT (envelope-from git) Date: Mon, 5 Dec 2022 16:53:27 GMT Message-Id: <202212051653.2B5GrRxo068111@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: bb010ef56ca6 - stable/12 - sys/README.md: source roadmap improvements List-Id: Commits to the stable branches of the FreeBSD src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-branches List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-src-branches@freebsd.org X-BeenThere: dev-commits-src-branches@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: bb010ef56ca61082b7824bfa792ed901d6b14916 Auto-Submitted: auto-generated X-ThisMailContainsUnwantedMimeParts: N The branch stable/12 has been updated by mhorne: URL: https://cgit.FreeBSD.org/src/commit/?id=bb010ef56ca61082b7824bfa792ed901d6b14916 commit bb010ef56ca61082b7824bfa792ed901d6b14916 Author: Mitchell Horne AuthorDate: 2022-11-01 15:13:31 +0000 Commit: Mitchell Horne CommitDate: 2022-12-05 16:50:59 +0000 sys/README.md: source roadmap improvements Tweak the existing descriptions slightly. Add entries for several directories which are not yet documented, but not exhaustively. Reviewed by: imp (previous version), emaste MFC after: 1 month Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D37133 (cherry picked from commit 397013385d4b88ee7e6d9b13bd8c017ca9dfdad5) --- sys/README.md | 50 ++++++++++++++++++++++++++++++-------------------- 1 file changed, 30 insertions(+), 20 deletions(-) diff --git a/sys/README.md b/sys/README.md index 398281752cab..edd30f39d313 100644 --- a/sys/README.md +++ b/sys/README.md @@ -8,27 +8,37 @@ Source Roadmap: --------------- | Directory | Description | | --------- | ----------- | -| amd64 | AMD64 architecture support | -| arm | ARM architecture support | -| arm64 | ARMv8 architecture support | -| cam | `cam(4)` and `ctl(4)` | -| cddl | CDDL-licensed optional sources, including ZFS and DTrace | -| ddb | `ddb(4)` | -| fs | most filesystems | +| amd64 | AMD64 (64-bit x86) architecture support | +| arm | 32-bit ARM architecture support | +| arm64 | 64-bit ARM (AArch64) architecture support | +| cam | Common Access Method storage subsystem - `cam(4)` and `ctl(4)` | +| cddl | CDDL-licensed optional sources such as DTrace | +| conf | kernel build glue | +| compat | Linux compatibility layer, FreeBSD 32-bit compatibility | +| contrib | 3rd-party imported software such as OpenZFS | +| crypto | crypto drivers | +| ddb | interactive kernel debugger - `ddb(4)` | +| fs | most filesystems, excluding UFS, NFS, and ZFS | | dev | device drivers | -| geom | `geom(4)` | -| i386 | i386 (32 bit) architecture support | +| gdb | kernel remote GDB stub - `gdb(4)` | +| geom | GEOM framework - `geom(4)` | +| i386 | i386 (32-bit x86) architecture support | | kern | main part of the kernel | -| net80211 | `net80211(4)` | -| netgraph | `netgraph(4)` | -| netinet | `inet(4)` | -| netinet6 | `inet6(4)` | -| netipsec | `ipsec(4)` | -| netpfil | `ipfw(4)` and `pf(4)` | -| opencrypto | `crypto(7)` | -| powerpc | PowerPC/POWER architecture support | -| riscv | RISC-V architecture support | -| security | `audit(4)` and `mac(4)` | +| libkern | libc-like and other support functions for kernel use | +| modules | kernel module infrastructure | +| net | core networking code | +| net80211 | wireless networking (IEEE 802.11) - `net80211(4)` | +| netgraph | graph-based networking subsystem - `netgraph(4)` | +| netinet | IPv4 protocol implementation - `inet(4)` | +| netinet6 | IPv6 protocol implementation - `inet6(4)` | +| netipsec | IPsec protocol implementation - `ipsec(4)` | +| netpfil | packet filters - `ipfw(4)`, `pf(4)`, and `ipfilter(4)` | +| opencrypto | OpenCrypto framework - `crypto(7)` | +| powerpc | PowerPC/POWER (32 and 64-bit) architecture support | +| riscv | 64-bit RISC-V architecture support | +| security | security facilities - `audit(4)` and `mac(4)` | | sys | kernel headers | -| ufs | Unix File System | +| tests | kernel unit tests | +| ufs | Unix File System - `ffs(7)` | +| vm | virtual memory system | | x86 | code shared by AMD64 and i386 architectures |