From nobody Thu Oct 27 02:26:03 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 4MyV0Z0LZHz4gn4q for ; Thu, 27 Oct 2022 02:26:06 +0000 (UTC) (envelope-from pauamma@freebsd.org) Received: from mail.gundo.com (gibson.gundo.com [75.145.166.65]) by mx1.freebsd.org (Postfix) with ESMTP id 4MyV0Y30QTz3Nhg; Thu, 27 Oct 2022 02:26:05 +0000 (UTC) (envelope-from pauamma@freebsd.org) Received: from webmail.gundo.com (variax.gundo.com [75.145.166.70]) by mail.gundo.com (Postfix) with ESMTP id C13634C0366; Wed, 26 Oct 2022 21:26:03 -0500 (CDT) 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 Date: Thu, 27 Oct 2022 02:26:03 +0000 From: Pau Amma To: Mitchell Horne Cc: "freebsd-doc@FreeBSD.org" Subject: Re: Documentation of /usr/src directory layout In-Reply-To: References: User-Agent: Roundcube Webmail/1.4.8 Message-ID: X-Sender: pauamma@freebsd.org Organization: The FreeBSD Project Content-Type: text/plain; charset=US-ASCII; format=flowed Content-Transfer-Encoding: 7bit X-Rspamd-Queue-Id: 4MyV0Y30QTz3Nhg X-Spamd-Bar: / Authentication-Results: mx1.freebsd.org; dkim=none; dmarc=none; spf=softfail (mx1.freebsd.org: 75.145.166.65 is neither permitted nor denied by domain of pauamma@freebsd.org) smtp.mailfrom=pauamma@freebsd.org X-Spamd-Result: default: False [0.20 / 15.00]; VIOLATED_DIRECT_SPF(3.50)[]; NEURAL_HAM_LONG(-1.00)[-1.000]; NEURAL_HAM_MEDIUM(-1.00)[-1.000]; NEURAL_HAM_SHORT(-1.00)[-1.000]; RCVD_IN_DNSWL_MED(-0.20)[75.145.166.65:from]; RWL_MAILSPIKE_GOOD(-0.10)[75.145.166.65:from]; MIME_GOOD(-0.10)[text/plain]; RCVD_NO_TLS_LAST(0.10)[]; RCPT_COUNT_TWO(0.00)[2]; ASN(0.00)[asn:7922, ipnet:75.144.0.0/13, country:US]; R_DKIM_NA(0.00)[]; MLMMJ_DEST(0.00)[freebsd-doc@freebsd.org]; FROM_EQ_ENVFROM(0.00)[]; MIME_TRACE(0.00)[0:+]; TO_DN_EQ_ADDR_SOME(0.00)[]; HAS_ORG_HEADER(0.00)[]; FROM_HAS_DN(0.00)[]; FREEFALL_USER(0.00)[pauamma]; ARC_NA(0.00)[]; RCVD_COUNT_TWO(0.00)[2]; TO_DN_SOME(0.00)[]; DMARC_NA(0.00)[freebsd.org]; TO_MATCH_ENVRCPT_ALL(0.00)[]; R_SPF_SOFTFAIL(0.00)[~all]; MID_RHS_MATCH_FROM(0.00)[] X-ThisMailContainsUnwantedMimeParts: N On 2022-10-26 16:07, Mitchell Horne wrote: > 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. Noting that (on 13.1 at least) README.md is a lightly markdownized version of README. If they're not going to be kept consistent going forward, one should be removed. (As mentioned elsethread, keeping README.md makes sense given GitHub and others display it by default.) Re removing that info from hier(7) instead of updating it, a possible disadvantage I see to that is people without source losing access to it. I'm not familiar with the audience: how likely is it that people without source installed will have a need for (a more current version of) that part of it? -- #BlackLivesMatter #TransWomenAreWomen #AccessibilityMatters #StandWithUkrainians English: he/him/his (singular they/them/their/theirs OK) French: il/le/lui (iel/iel and ielle/ielle OK) Tagalog: siya/niya/kaniya (please avoid sila/nila/kanila)