From nobody Wed Oct 26 16:07:05 2022 X-Original-To: freebsd-doc@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 4MyDGM3Srrz4gWtD; Wed, 26 Oct 2022 16:07:07 +0000 (UTC) (envelope-from mhorne@freebsd.org) Received: from smtp.freebsd.org (smtp.freebsd.org [IPv6:2610:1c1:1:606c::24b:4]) (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 "smtp.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4MyDGM2p12z3TqT; Wed, 26 Oct 2022 16:07:07 +0000 (UTC) (envelope-from mhorne@freebsd.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1666800427; 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=uEKunhXK9n8kMGX6ExxwLISYT7z5ILTH0/CWYgHyvlQ=; b=N8aqlGNm/7Ua+//zTwYnRhlt4XerR9lNopp02R2NQPpsTBZlh8a3dvqYiNEMz8rH6tH8mS 4kg20OkJHvUnFiJbXn44vJJJjCOdMlNwMZxFPcrikYuqu2qgsrz0iFdbLxJrQa4C5s80/c 2y4NmRr83Ezm3wNYxv51K3kFaeIYiqdyV4us7394rP5veA8Ckx+gVECGrl1ZgqECfFhLEf Ob8cR/3hyeaRITinXElV/2YX/mXNcxcfV0cP9kw+Lobr2Efi7l7he5R60yYuaFIjbN+o/K metQWTYwtgDUyzNAONqbGNJGbrqiIwq6maMfSU2puulu7A9jv3ba4ts0PZhFGQ== Received: from [192.168.1.151] (host-173-212-76-127.public.eastlink.ca [173.212.76.127]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) (Authenticated sender: mhorne) by smtp.freebsd.org (Postfix) with ESMTPSA id 4MyDGM0Z4Qz1RLt; Wed, 26 Oct 2022 16:07:06 +0000 (UTC) (envelope-from mhorne@freebsd.org) Message-ID: Date: Wed, 26 Oct 2022 13:07:05 -0300 List-Id: Documentation project List-Archive: https://lists.freebsd.org/archives/freebsd-doc List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-freebsd-doc@freebsd.org MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; FreeBSD amd64; rv:102.0) Gecko/20100101 Thunderbird/102.4.0 Content-Language: en-CA From: Mitchell Horne Subject: Documentation of /usr/src directory layout To: freebsd-arch@freebsd.org, "freebsd-doc@FreeBSD.org" Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 7bit ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1666800427; 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=uEKunhXK9n8kMGX6ExxwLISYT7z5ILTH0/CWYgHyvlQ=; b=cXDMEPKfu56LzERUDfvRyl2d9gQw02LCPp/p9Xf4UDHOVLThnaIEewxeEoXFje44E6yqbg VvpxUhz95nI71hXll9eU3eDnG8KarOREiNo+e4JJoKJ/nHTqmkEJp9vzjsgnqdVLhdtU7J whv0+WbtFWs3YEMy4v8h4e05V2tm+OMCLwLRCNRBFJUMXXiOpminHB37adodxvnkozuncw e+rmRCPR1nArY1uPjtgu3gN4KbC0LkPq/oD4tug/YL3rgxCFVZne0sEVd6qdxwMEMMINAu +TI4/mxc55fCeHysT4nUlVODxgqvpQb2ET4PPfF0bEKLAY/zhPi/581bmlbcFg== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1666800427; a=rsa-sha256; cv=none; b=UUkv4vc7Q+Jq2Ffxb/hxa/IQUYpNoqCnk5PZ3VQUwoQV0oUdEH4qzchv/XMDCU0wI37OpI tVvzfKmm23OBUWqKWc8lYc6CgAl90TiZp6DyGhXkjGh90sTqfwlV9O50JIjViqsS+lTin6 ///0t20YL+jgP/fuSaXWDi5sh+kHihfbLfwRCw6h+RM79pAhF4sOeGlMNoOg5SdUuiVYR9 guyZ8hII6AS9GGOSTMTvDittTqooWA0VBvv8OZsSuQnrxmpSwQXuxUlkqObcQqCyKA5VaW P9T2C4mXJMGvJifi9uJj6yYH5FndRrk8ODuNiqrpz2W0SqwYqs6bdGQeeQ7WiA== ARC-Authentication-Results: i=1; mx1.freebsd.org; none X-ThisMailContainsUnwantedMimeParts: N Hello, Currently, hier(7) contains detailed but outdated [1] documentation of the directory structure under /usr/src. The src tree's README.md file duplicates much of this information by maintaining a distinctly incomplete table. I propose that we reduce the maintenance overhead by keeping one of these lists as the source of truth. README.md is the more natural option here: being located at the root of the src tree it is more discoverable (especially for those new to the src tree), and the raw markdown text is much more human-readable than mdoc. Of course, the added benefit is that README.md is presented front-and-center when browsing the git repository on GitHub, GitLab, etc. See it on my fork [2]. The list of /usr/src subdirectories will be removed from hier(7) and replaced with a sentence informing the reader they can consult README.md for the details. I have retained and improved the list of directories under sys/ from hier(7), but to avoid polluting the top-level source roadmap I have added a secondary sys/README.md which documents the layout of the kernel sources. I do not expect these changes to be contentious, but I'd like to cast a wider net for review. Productive feedback is welcome by email or directly in the Phabricator reviews: https://reviews.freebsd.org/D37132 https://reviews.freebsd.org/D37133 https://reviews.freebsd.org/D37134 https://reviews.freebsd.org/D37135 https://reviews.freebsd.org/D37136 Also, this information is duplicated in at least one more place: the Developer's Handbook [3]. I intend to address this too after the current series of changes is complete. Most likely, this will be done by replacing the list with a link to the README.md file in cgit. Thanks! Mitchell [1] https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=261349 [2] https://github.com/mhorne/freebsd/tree/hier [3] https://docs.freebsd.org/en/books/developers-handbook/introduction/#introduction-layout