From nobody Mon Dec 5 16:47:31 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 4NQqGX0n4Nz4k7q4; Mon, 5 Dec 2022 16:47:32 +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 4NQqGX06K6z417F; Mon, 5 Dec 2022 16:47:32 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1670258852; 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=rMKDfcoYTh5ah5Gyc11EsEQZ5xNuL0ymb9/wzt4ssu8=; b=Ay/6xlBlz3rfEicPfF7IopIZsOY+unzrFed4COBlRfiL7/PgiluRq6sGwktrwWx7X283i5 bJVPLfvj07RzjaW+zgvXmXlLvLVX+02hVKjroqpWe4bE03y05CmJi/alsKdQ9bNqzDZlJ+ TekrfNOpDLXpLsdsD5jSnyzpdO5vZffDZVsDN+4ntFait/CjeqkjB4nBFPC89Q+Skouhee j0qtPwcy5mvdY6Zw7+kWfjjurWCVHPa1GMzdbiqVri65+wpnlpIm3BCaVQ0zSfwg5DecQl fleNiWaxZXE2S+rbwsqOlyLbB1VpGfzfjyvpGqUz9ygixBxKXVHwx1P1oDG6Ow== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1670258852; 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=rMKDfcoYTh5ah5Gyc11EsEQZ5xNuL0ymb9/wzt4ssu8=; b=HG6Rnou7LgnNYoEUcKqln7bGkeTPpQvixtQWCo7mnSOon98Aaf68Id4KfQ/DK31K3JaS8B DOkfronq8d6HnrUA3BLrtoGSTJLapch+TTsiJJlSg7i6FvH43Bd7xH5pEQPKoOJOtu7/5k CKwgMBclSXSWAslUdz3IblDcKVsENlq6WXA2yo897vG7n+t6FNcc0OkTb+iCiXijXU5lJv w2hOU8o+hxh4U08HKarvcttkMnOYIqRrmcDAqLwk9634mHXEq0m0TT8cyN73HrocYKX6Rr Nj8cKp6HOn/FAUrORTQSj0EtxMpPkB4yLNs5UJAP014d+YrrfAYDd+UVAWezSg== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1670258852; a=rsa-sha256; cv=none; b=MS/YS8SksYNuxVoRZdectVBuDcew6DPcLpFOMoOMZQyCjklKz7v/QAa3UxOLRB+fL45mca mbyrQrHQX9K30jKp4w60YWWbyIzCCtthZWi2Xe98YdvM8hHkEj/CqB13d4pKaJNLlo2HJx kRjr+ZwTH03HGD2jbMpDkbCkjb2s1gb3seHsGZrusGbrzouujjM33EsbEATs9q392HLpZn i/nF25ryMDVUhupyrlfpN8bP/arBgHBl/BzH8PGprDNYYlsQIcvnsNxzA2ZKIu64pJHzwg UpFMlOnUzCqIbI54EqcqNceIq+yjh8+G67f/H6V2WGGAXzt8VhJeTXBxImZW5A== 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 4NQqGW6H6Bz14j9; Mon, 5 Dec 2022 16:47:31 +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 2B5GlVj5053787; Mon, 5 Dec 2022 16:47:31 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 2B5GlVXa053786; Mon, 5 Dec 2022 16:47:31 GMT (envelope-from git) Date: Mon, 5 Dec 2022 16:47:31 GMT Message-Id: <202212051647.2B5GlVXa053786@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: b548d985de15 - stable/13 - Create sys/README.md 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/13 X-Git-Reftype: branch X-Git-Commit: b548d985de157c03dbdb311b672af13df9ee405b Auto-Submitted: auto-generated X-ThisMailContainsUnwantedMimeParts: N The branch stable/13 has been updated by mhorne: URL: https://cgit.FreeBSD.org/src/commit/?id=b548d985de157c03dbdb311b672af13df9ee405b commit b548d985de157c03dbdb311b672af13df9ee405b Author: Mitchell Horne AuthorDate: 2022-11-01 15:12:14 +0000 Commit: Mitchell Horne CommitDate: 2022-12-05 16:32:19 +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 (cherry picked from commit d1087fe8436dbe369b218854fffe901ccc7602c1) --- README.md | 2 +- sys/README.md | 34 ++++++++++++++++++++++++++++++++++ 2 files changed, 35 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e4c56babb448..cfb292ad9242 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,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 |