From nobody Tue Nov 1 15:24:52 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 4N1v2s18fGz4gZjs; Tue, 1 Nov 2022 15:24:53 +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 4N1v2s0bFdz3rxf; Tue, 1 Nov 2022 15:24:53 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1667316293; 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=f6qvVIfq1vXuVG4/hcawydoADhZbtDWGhuo3f5VFTYw=; b=cNOZPBobATXHXdBU6av+GJs1obgCPWIt6OIKcKRJFu/AmixcedF26yEe4dD9QFCWDnRuld Ohu7Ivn3O+m3S4skFmM9+I7M2B6ohkwMi5So7K2Z8HgxlpP8+7KXFDiAddGKdGwM5c3OW2 vAvxeaNi6pB5k2bFDWtH94ANHZeIHDwIZ5rz8jKRAJ4ZuDXUEkuv/cUD4SWlgp1dxLb4HZ fihKt7oJqkJ3c1X7cgw3g1LmRRhUF2+7GD6AzNQpQDa2scaJVsyk0xx84ff4sSItDKpKsp yrgDZdQr/z+iTb/wI2hhx+/61g+bAS3Hn1zRNB7GsIOXHdGKAUGEpOxROoryEA== 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 4N1v2r6Q1qzLH1; Tue, 1 Nov 2022 15:24:52 +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 2A1FOqmJ087884; Tue, 1 Nov 2022 15:24:52 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 2A1FOqcs087883; Tue, 1 Nov 2022 15:24:52 GMT (envelope-from git) Date: Tue, 1 Nov 2022 15:24:52 GMT Message-Id: <202211011524.2A1FOqcs087883@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: d1087fe8436d - main - Create sys/README.md 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: d1087fe8436dbe369b218854fffe901ccc7602c1 Auto-Submitted: auto-generated ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1667316293; 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=f6qvVIfq1vXuVG4/hcawydoADhZbtDWGhuo3f5VFTYw=; b=jwSAQRo3+Imr1KSWka23JI6jl4Waj8OdKrqjzQiPFJBOEN94ylXXS1FrWVC5/cr+VSNwoE ejYsx2kNS2VK5QIpD/x2tg1YIiO9dXB4k0ptG+0yMyPuWJ4gpTQ8+q9eOkdu7LqOr8pk/2 1YIwpXPU2l0Uj8BykObVN5ng4kJeLQtBRaKqiz+NnuRIHincu9ftOSCLYcPRaQTFnuH+2g 9HSVC9Uguq1oa0UIF3kVkUoyzBPD6mO6OSx8yY8aVpHFhB9IIw8juBjV8T+LRl/zDwoOlz 4l6m64DPh73GMGEKw0Qzc37tyF4f7Ph+HkEFKQoO8fPlCvfuUYcRBf3P6BBC9w== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1667316293; a=rsa-sha256; cv=none; b=guQOhyT7IseyEbXLQz+hULzdYLjf/U9xgX5Oo/mUL1h79rWkMQeo+4zLTLNy/vTm0tmxuW a7skB9Yx+vPSMZlojKGEmRyCCJODWHsrsKBaxfGsfv/7FJ2QMFnb+emMiuD2XnOKChNPpC w5nM1R19zV7XLC89YmOm9oKSHQXFM4k/t+/hlb5qeF35v+jbYK0JqtCKIqYPr0hcYtMRuQ Pi3lWt/Plv3rpDbK3EI3LdqW0/Q9Ny7nyoXqZez1tx9bgUVGtJJLRvDozlpMuTOxCv8bDE 5l6XBPRL4P5eqdxJaCdALxCzpdcYlTFK4iWd4Bw/Ay4Ez1PndzlAfQnkgi3dvg== 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=d1087fe8436dbe369b218854fffe901ccc7602c1 commit d1087fe8436dbe369b218854fffe901ccc7602c1 Author: Mitchell Horne AuthorDate: 2022-11-01 15:12:14 +0000 Commit: Mitchell Horne CommitDate: 2022-11-01 15:20:55 +0000 Create sys/README.md Add this primarily to document the sys/ subdirectories of the source tree. This is a straight copy from the contents of hier(7). Improvements will follow in other changes. Reviewed by: imp, emaste MFC after: 1 month Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D37132 --- README.md | 2 +- sys/README.md | 34 ++++++++++++++++++++++++++++++++++ 2 files changed, 35 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index faacd4790c98..31939e2b0fff 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ Source Roadmap: | secure | Cryptographic libraries and commands. | | share | Shared resources. | | stand | Boot loader sources. | -| sys | Kernel sources. | +| sys | Kernel sources (see [sys/README.md](sys/README.md)). | | sys/`arch`/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. | diff --git a/sys/README.md b/sys/README.md new file mode 100644 index 000000000000..398281752cab --- /dev/null +++ b/sys/README.md @@ -0,0 +1,34 @@ +FreeBSD Kernel Source: +---------------------- + +This directory contains the source files and build glue that make up the FreeBSD +kernel and its modules, including both original and contributed software. + +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 | +| dev | device drivers | +| geom | `geom(4)` | +| i386 | i386 (32 bit) 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)` | +| sys | kernel headers | +| ufs | Unix File System | +| x86 | code shared by AMD64 and i386 architectures |