From nobody Mon Mar 27 16:16:01 2023 X-Original-To: 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 4PldGT60pkz41k4X for ; Mon, 27 Mar 2023 16:16:01 +0000 (UTC) (envelope-from bugzilla-noreply@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 4PldGT3M3tz4J2q for ; Mon, 27 Mar 2023 16:16:01 +0000 (UTC) (envelope-from bugzilla-noreply@freebsd.org) ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1679933761; 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=TIJn8c6wEkEB2n0zqGloglVG4dh7s4YiGAeT/82AzZs=; b=PLZEv9GuwcX1WGHaKXbzGeZYhxSfPfKAqx/V2rQJtn6doSDyJ6NaBYH6t3s79KaBHpb+JV 1/4kRQqoXZz7NY4jKKGbTeH3+eaj/eU57V4oyTWj6fRsQI4m73emxS08dkSX2Ey3mQuKR4 Ne0qTYeqLYWNwbQp76rYOVKJuWE3scqhW6l/0vweeGjhC3qplThEzH0t2TWxEkt+JSIFce VtfGrwmrKS8Ccd68RVDV6kEJ3aQjiyGJBrv436dysgx/b3jtyjpVftFAwUDAhwmbf0LCTK dETE2sh9e/PINgH2qNLpUlb67azFdpxVDAtQ0/APn44BXTvQ0Sg9p67KpsIhcw== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1679933761; a=rsa-sha256; cv=none; b=h649fhIrjsX/Pg8l2xv9dQU6FDTfZ4vJ0Pw4M0sTTKejx0t8RX2X7TDzwpbeAi57UyBsDU gmgtlr/aEJPNZpYeNWF5Vk4f27tG18psqcJfylDvEEqoJUSkbSrPbsl8tfhJW0Bk8mfj9V 8ePsgcWvcvrbBLvt+5FR/cr+UNxXJiAZj7Nf+d/nEa+YGSrHoq5ae3qpWzi2kYNr2ItNN/ CvkfwjalHetuVobQP2ff7a21iE5it6gfegpQFt8BkGh1iEV4THrj+O1hSUICKiiEqVOY9N EoAZktfpuTyiFHIWiFUzEEY9cKM+xlPXNCzdMUm7T6qQt/tQ+A7xs2BQUZGWxA== Received: from kenobi.freebsd.org (kenobi.freebsd.org [IPv6:2610:1c1:1:606c::50:1d]) (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 4PldGT2RGKzTSd for ; Mon, 27 Mar 2023 16:16:01 +0000 (UTC) (envelope-from bugzilla-noreply@freebsd.org) Received: from kenobi.freebsd.org ([127.0.1.5]) by kenobi.freebsd.org (8.15.2/8.15.2) with ESMTP id 32RGG1Qr013718 for ; Mon, 27 Mar 2023 16:16:01 GMT (envelope-from bugzilla-noreply@freebsd.org) Received: (from www@localhost) by kenobi.freebsd.org (8.15.2/8.15.2/Submit) id 32RGG1HS013717 for doc@FreeBSD.org; Mon, 27 Mar 2023 16:16:01 GMT (envelope-from bugzilla-noreply@freebsd.org) X-Authentication-Warning: kenobi.freebsd.org: www set sender to bugzilla-noreply@freebsd.org using -f From: bugzilla-noreply@freebsd.org To: doc@FreeBSD.org Subject: [Bug 270481] intro(9) needs an update/rewrite Date: Mon, 27 Mar 2023 16:16:01 +0000 X-Bugzilla-Reason: CC X-Bugzilla-Type: new X-Bugzilla-Watch-Reason: None X-Bugzilla-Product: Documentation X-Bugzilla-Component: Manual Pages X-Bugzilla-Version: Latest X-Bugzilla-Keywords: X-Bugzilla-Severity: Affects Only Me X-Bugzilla-Who: mhorne@freebsd.org X-Bugzilla-Status: New X-Bugzilla-Resolution: X-Bugzilla-Priority: --- X-Bugzilla-Assigned-To: mhorne@freebsd.org X-Bugzilla-Flags: X-Bugzilla-Changed-Fields: bug_id short_desc product version rep_platform op_sys bug_status bug_severity priority component assigned_to reporter cc blocked Message-ID: Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable X-Bugzilla-URL: https://bugs.freebsd.org/bugzilla/ Auto-Submitted: auto-generated 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 X-ThisMailContainsUnwantedMimeParts: N https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=3D270481 Bug ID: 270481 Summary: intro(9) needs an update/rewrite Product: Documentation Version: Latest Hardware: Any OS: Any Status: New Severity: Affects Only Me Priority: --- Component: Manual Pages Assignee: mhorne@freebsd.org Reporter: mhorne@freebsd.org CC: arch@FreeBSD.org, doc@FreeBSD.org Blocks: 248562 The intro(9) man page is outdated, with a last modified date of 1995(!). The page contains a few general programming recommendations and a link to style= (9). Beyond this it fails to provide any real introduction to this section of documentation. While imperfect, section 9 is the most comprehensive set of documentation f= or the FreeBSD kernel source code that exists. This man page has the potential= to be a useful landing page for navigating and discovering this resource. A complete rewrite of this page is in order, with the following goals/principles: - Provide more detailed high-level introduction to this documentation set; describe purpose, authors & audience, and expectations regarding coverage, level-of-detail, and accuracy - Include cross-references to as many section 9 pages as reasonable. This improves their discoverability - Group links by subsystem/domain. NetBSD's intro(9) page is a good exampl= e of this [1] I have begun this rewrite, so this PR is self-assigned and mainly for track= ing purposes. Feedback on what should be usefully included in the new page is welcome. [1] https://man.freebsd.org/cgi/man.cgi?query=3Dintro&apropos=3D0&sektion=3D9&m= anpath=3DNetBSD+9.3&arch=3Ddefault&format=3Dhtml Referenced Bugs: https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=3D248562 [Bug 248562] [meta] intro man pages: review, revamp, update --=20 You are receiving this mail because: You are on the CC list for the bug.=