From nobody Tue Jul 01 21:25:38 2025 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 4bWx055DGMz60vV1 for ; Tue, 01 Jul 2025 21:25:41 +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 "R10" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4bWx0523cCz3m7F for ; Tue, 01 Jul 2025 21:25:41 +0000 (UTC) (envelope-from bugzilla-noreply@freebsd.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1751405141; 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: in-reply-to:in-reply-to:references:references; bh=es0pcg5GyUY5Chm3y7whObvC/s8hEtMGa+ZeMTgzqOs=; b=f3aJgFHQHEnYr9C5eiK+dgUQk/XNp7etW1enmDrYWQ5ngb3jlAmIghRL1xyb71M3mbOXnP 2WNtvBARG5ciyod+NKJikcXgu7yTR3/gEcOwnpGt+GqPfANPn8s7+hQ3FnPEJXRpgbB/DW cHfvSt/1amAUcIY9PnRLWCPE0INHrDsOtryw9tB3ovhDhaFl24tx0bQnHZuC8AS/aDab0D g5VUZfNzcOgShKBTtzw+UZiZFh9vaMH/FNMjyMYab01LztJ3kqvSqsinL90jpkZ/jN5jSk jvNx+ygxluUwluYy+andglQur28oW3exkDjl7Phh4HI0tB5Sl5yfi5sgITlscg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1751405141; 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: in-reply-to:in-reply-to:references:references; bh=es0pcg5GyUY5Chm3y7whObvC/s8hEtMGa+ZeMTgzqOs=; b=VhekqhsqN9KdW9jtkbd0SA0BiZc9KSf7yitflBKYjljC+AYDh0ughXdnRxpsOzyeuz3aF2 X31zw+Iv6Z4VCRj2Ko170XYJ3bkmZO4/LZ5EkBKFyT9QcQ/8JGilKo4BuNO9poMIHcGPqI RbnqUG1Rjz13yU/B43mUf5fo9l4uikMr9qohxZSzPT1gWZSmisOHrBRJ2lGIaKnOxSaC+6 6dlQBXF1YEjcmLaesc8YuwTgITf5qVWDiKwOApyKSeoT9cDF9kQgy4FFpRyQxpcd/Pklr0 CIO+bNNjriRVLPp16YPhdmmV7MlqZ19fzmDXccQOHEfI2+ZaWLdnEbIUJmpkZA== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1751405141; a=rsa-sha256; cv=none; b=EOkFU9xB2HkZLP/PI5iBG2uzYk+PQphOeixd28YgXU49fylNHYApgJkkqqdPjRjgzaDoG4 hlfuMnC1Lxchf7ciqRhI4/Em5trZAUY2qki3WEpd1xY9u+yHDm+PzT8D0InmFVyfdqXaWX Vz1oa84qf40npaiOfhrh4DeHhYNs0evkuRfHIKEo8b45YNda9EUCzJ672iFDR+n7yrwH55 3YBfScK+P+UlDYTsuPVNS3mqVyMBEZ0P8P8iwWwCarlPKA0B722y1LPWwotviw4zW5T43+ 3IKvU2gxoesuka1EjskbwVpp/VrS5X/Arer8mz2DsDIxBKdcQgildS1ntcBswQ== 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 4bWx051cfSzqTV for ; Tue, 01 Jul 2025 21:25:41 +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 561LPf65046991 for ; Tue, 1 Jul 2025 21:25:41 GMT (envelope-from bugzilla-noreply@freebsd.org) Received: (from www@localhost) by kenobi.freebsd.org (8.15.2/8.15.2/Submit) id 561LPfns046987 for doc@FreeBSD.org; Tue, 1 Jul 2025 21:25:41 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 268827] Network-related manual pages: promote use of sysrc(8) to safely edit system rc files Date: Tue, 01 Jul 2025 21:25:38 +0000 X-Bugzilla-Reason: CC X-Bugzilla-Type: changed 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 Some People X-Bugzilla-Who: ziaee@FreeBSD.org X-Bugzilla-Status: Closed X-Bugzilla-Resolution: Not A Bug X-Bugzilla-Priority: --- X-Bugzilla-Assigned-To: wireless@FreeBSD.org X-Bugzilla-Flags: X-Bugzilla-Changed-Fields: resolution cc bug_status Message-ID: In-Reply-To: References: Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="UTF-8" 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 https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=3D268827 Alexander Ziaee changed: What |Removed |Added ---------------------------------------------------------------------------- Resolution|--- |Not A Bug CC| |ziaee@FreeBSD.org Status|Open |Closed --- Comment #3 from Alexander Ziaee --- Section 4 manuals include lines of text for configuration, like section 5. Since this is required for kernel configuration, and tunables, I think the = most predictable approach is to keep the synopsis showing the correct lines of t= ext. sysrc is just one of many tools the administrator can use to put the text i= n, like service, or ansible. I presented a lightning talk at BSDCan 2025 about the format I used in uftdi(4), which I copied from vt(4), and the biggest thing we can do to imp= rove this situation is use that consistently. It reconciles the idea of synopsis= in section four with the rest of the manual sections. --=20 You are receiving this mail because: You are on the CC list for the bug.=