From nobody Tue Nov 01 15:24:53 2022 X-Original-To: dev-commits-src-main@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 4N1v2t29brz4gZTH; Tue, 1 Nov 2022 15:24:54 +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 4N1v2t1WTPz3sLc; Tue, 1 Nov 2022 15:24:54 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1667316294; 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=t1kWQWVYG26/RRKf31LLZ1dleO5ShLY9m2p/vRGa6PM=; b=j5T/dUZy3PewAVv3ypnA4EkGTNAPNDQ3v2DkvPKgx7q05WdfrH2DLtbZw5WS9LqiMLmodu iayaVUmfviGNDGFU4R7xgt06HNjFCTi3gkviRhZeKDHBk61fagyIZflhg3m3BrRuy198Jy Zjb3p2ovKKqXz3CU8qqeWMTmiKTSRU8YldrqkdahWflqP3UIrrEpRJLhB3N8MY9L+Cmpee U48I7uTs8N/DC2fOFJbJTMM8yJy2XFrSTVZLfdYxgMf4H8oBLs3yEG/J43PyWp7SNNwQdm F6vQIdYOfAGY6EgROTOI9HQL1kHFvFmWMfKEy4WZ114OgC10aHbfKZw6sDSsZw== 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 4N1v2t0WlKzLds; Tue, 1 Nov 2022 15:24:54 +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 2A1FOrns087908; Tue, 1 Nov 2022 15:24:53 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 2A1FOrqj087907; Tue, 1 Nov 2022 15:24:53 GMT (envelope-from git) Date: Tue, 1 Nov 2022 15:24:53 GMT Message-Id: <202211011524.2A1FOrqj087907@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Mitchell Horne Subject: git: 397013385d4b - main - sys/README.md: source roadmap improvements List-Id: Commit messages for the main branch of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-main List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-src-main@freebsd.org X-BeenThere: dev-commits-src-main@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/main X-Git-Reftype: branch X-Git-Commit: 397013385d4b88ee7e6d9b13bd8c017ca9dfdad5 Auto-Submitted: auto-generated ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1667316294; 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=t1kWQWVYG26/RRKf31LLZ1dleO5ShLY9m2p/vRGa6PM=; b=hw8KfRZupCFUP28W1nUx0AgV26xonN5i1U+jke+jjkuNLUZ9UWWnknXQTPxWpw1PZVwok+ ROHh0STmo5if5dP0Fdqr15rz9OcK0jV0FtsFxUbyCVrPRFJRUZQHYw0rVGN5kCoPVcZ5yQ 8fRizSzyFjiaw2cs8373Ch5YRT871BeCFKdZUQ5siGm5TKYsWcSYKHhQb6PBIZckoYROnK HmbMeMifDrOFiKVtU3Q1Cg5wMw+CJf3gcHwB1teL1u7B5c03HWqX0E5ekIJT/l/MfCm/LC ezdhmRXmIdgnBrTnSLgT6RQ7tlvoQ9XUEH3DQowDyAYBjV4VIgeQ20gzuRxrxw== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1667316294; a=rsa-sha256; cv=none; b=RSf0sc0RvLRV7mJeMKUShbCdnVZGoe+y/XQWNSszeiPxToIvi44he5IGtuKA7eCwt56mLm 22EBWDPA2MIk4WqLWPnnUc/vWyEoqLi/siLoonu5sdwlUCcdD+s2f1iqYB0fYY6bAaW3ii 98HGCJ2De+vqGwcSMoc3hjyhdiMW0DlW1kKN4LdzXPIzy8pugeLR0/AeY4sTvSsFLqAL5L PZz81xrV2WQMBDU9yyTrR/ZRxxTQb30ot7Qx9ldM2ynFs2+lPx0deSE8YDTjXaQ5ux35p5 rXxrxEmS9YwbNEl3ouzR8RNpxDIF11wgzOKaqOBpLi22bcmOTcT8zwgorEF4Ag== ARC-Authentication-Results: i=1; mx1.freebsd.org; none X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by mhorne: URL: https://cgit.FreeBSD.org/src/commit/?id=397013385d4b88ee7e6d9b13bd8c017ca9dfdad5 commit 397013385d4b88ee7e6d9b13bd8c017ca9dfdad5 Author: Mitchell Horne AuthorDate: 2022-11-01 15:13:31 +0000 Commit: Mitchell Horne CommitDate: 2022-11-01 15:20:55 +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 --- 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 |