From nobody Mon Dec 5 16:53:26 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 4NQqPL4sH2z4k8hk; Mon, 5 Dec 2022 16:53:26 +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 4NQqPL4RBZz44kM; Mon, 5 Dec 2022 16:53:26 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1670259206; 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=uvMmnjNNjKYidgZASJnFVgNzXpieGbjRe22TGaRGLfU=; b=nXGbKNCsmR+3OahoAzgd6M0na1iKRj+k14Be05kuirPp9L0M2bzmXg9IQiiYwkui0dS+ro 5g43TkMkrzwyhK/qp/SN29BnMwJQobLLfjk09r9Udo0XC05UkK1Cs+Z8pSL6ASMONroEFm T+bRGVkPXvlynx4uzG4efuskTNFnwldcQ8I/ZxJVhwHoyKrQXWpL6ik1HCc4jd+D8CM71j xxPYbDPcM4Xsd41XptdJLx/J3r0fpqkRaTTim5UKgrGahKSBGft62M27tODup1oQrKKZda sFDtzZoAoi9vCdfvPjGVnBbt/ORddjuZ8eUL6zq58ZaTLppyamiYYV88dEeFeQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1670259206; 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=uvMmnjNNjKYidgZASJnFVgNzXpieGbjRe22TGaRGLfU=; b=YUDrBsakq8B5UR4oGM1KsKV3vXvD9fF04XjWWSfwlif3iHwEYnlvmEZu5p1BXifHklxj2w jfYgIEDXXh3W3CCRrjMV0X171lqdKIQgOdi2Tq9/+7zuwsi9FmLAKc6o/k9g5R2746lvzD DINjt7hn+iAA9/pRJrqIraczUJVOJYbLB5RQr9RMYOE+hMo/2NlSw2B90pqyvx+nYes3er RFb7j9JivD4+vSimT4pNqI/YKb8RUZCrIJR9TMhpOF2BVhYEuXr7M2kWw7xSosLeZpo/X7 LFSbnyunAeRAblFvsOY7ltIQdlGp0y63sKpSldLNm7ahLpe7s+IcDfS0/Y8YXw== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1670259206; a=rsa-sha256; cv=none; b=A6ceX1W6BL4xwImtB6bdUD0dt043fmlMsRWX36BbYo/se5Ez+zw4IhCx800Tne/hPteHaM UC8bgw6J0SnU7/0ElqeV/Iz+I5jzaFPf60OWGAPmfvlJeQg4XbxEP+l7a7sONcS7jDV1K/ aGRcQc4oA0LDzNJF/n8+51lVsMLDzkqMxiyGy7dBgLw+5jKHm/JWuxFaV3l3vSDGs74Wv8 b75+bTXMjibWyvcDwHsb/yzpVC2YavLDa/DIMvhhSfZZe8vtKmbCtSybY4sorqj3x+n8OP po1EowSDLWBoWYREHj0tsJYIGXSRXtJo3JtnzJPoGvq4h2IjjyAgVuLwQX4M9g== 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 4NQqPL3Csbz14Zg; Mon, 5 Dec 2022 16:53:26 +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 2B5GrQI8068088; Mon, 5 Dec 2022 16:53:26 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 2B5GrQwm068087; Mon, 5 Dec 2022 16:53:26 GMT (envelope-from git) Date: Mon, 5 Dec 2022 16:53:26 GMT Message-Id: <202212051653.2B5GrQwm068087@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: f030a8320c30 - stable/12 - 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/12 X-Git-Reftype: branch X-Git-Commit: f030a8320c307b9d8e1d90167ec20c7590364c08 Auto-Submitted: auto-generated X-ThisMailContainsUnwantedMimeParts: N The branch stable/12 has been updated by mhorne: URL: https://cgit.FreeBSD.org/src/commit/?id=f030a8320c307b9d8e1d90167ec20c7590364c08 commit f030a8320c307b9d8e1d90167ec20c7590364c08 Author: Mitchell Horne AuthorDate: 2022-11-01 15:12:14 +0000 Commit: Mitchell Horne CommitDate: 2022-12-05 16:50:59 +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 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 |