From nobody Sun Mar 17 17:16:33 2024 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 4TyPm20FFnz5Dm0C for ; Sun, 17 Mar 2024 17:16:34 +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 4TyPm162G3z4F4s for ; Sun, 17 Mar 2024 17:16:33 +0000 (UTC) (envelope-from bugzilla-noreply@freebsd.org) ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1710695793; a=rsa-sha256; cv=none; b=TWP3Ua9Xv2CevoduCH3j4/j/UNtN7Y5M9PfmPo9MBPuZNc13JqmC0DvrxinlMlrXcV9Bl1 SIE/9LTlh7EQwamraodJbg+9ak0arnN1Oqra71CyYp4tkhx9dYpBVQYDAs4QJN8pCCrVhz zJrsRHkGkDVTm+kEO8HRoFR3k7820MxxPTzuvzgSpEJj7r3iiditQ6GmbaK2nbGiAY7bO7 IxwbH+N4yLg9E23oiX5WGvcrAgwC+saBwcPhPuAla0F0x1BIP11M0uSfraf7zUGqs8En15 MdvxoYvxVbnsMMd9pJ95Z2Kv6FJ4ZlNKXk0eZN16OqueLIDNvw57o8zCti+Xwg== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1710695793; 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=BM2gnBSTFWay8V335qG1ujbYa3XH8xG6/HYv0FVNEDM=; b=ZFSgSvIDcYXGWMM4YjBVCZg4LHetRnyVTUOY2TunUWH6w+wzdnnGys4h1XPTUFx8HHJOgf Q4TbpqmviFgLlK26fpuWx+pR3kH00AzttkzuYQq10JkcAoFGVxS5IK/D5iUK0PUw883L4K AHUISzAO28sDgI0mndPtg7bXqGQNsgO9AI5f8JfTxUE8lvMG8ydxw57XCCVQDZQ0Y3SbHP 4S2qHXRJOStxdcu+9XT3YZvKBXYUK2ofAQZaTxsd2fwfiz3lTe7icy/uOJEhT7DrU5o0ZX Cup0q1dNhPFEdWNgGBYQJrH+SAvv1y6lf9vGcBg3l/fNrG3uOB+wkirfZYjYPg== 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 4TyPm15cVjznm6 for ; Sun, 17 Mar 2024 17:16:33 +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 42HHGXeJ089851 for ; Sun, 17 Mar 2024 17:16:33 GMT (envelope-from bugzilla-noreply@freebsd.org) Received: (from www@localhost) by kenobi.freebsd.org (8.15.2/8.15.2/Submit) id 42HHGXaK089845 for doc@FreeBSD.org; Sun, 17 Mar 2024 17:16:33 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 231574] [IF_BRIDGE(4)] improvements Date: Sun, 17 Mar 2024 17:16:33 +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 Only Me X-Bugzilla-Who: Christopher.davidson@gmail.com X-Bugzilla-Status: New X-Bugzilla-Resolution: X-Bugzilla-Priority: --- X-Bugzilla-Assigned-To: bugs@FreeBSD.org X-Bugzilla-Flags: X-Bugzilla-Changed-Fields: Message-ID: In-Reply-To: References: 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 https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=3D231574 --- Comment #2 from Chris Davidson --- After a little further pondering and some feedback, this may be something t= hat can be defined to be more clear and concise. The examples section of a manual page is suppose to help guide the person, https://docs.freebsd.org/en/books/fdp-primer/manual-pages/ Snippet from above url --------- Manual pages, commonly shortened to man pages, were conceived as readily-available reminders for command syntax, device driver details, or configuration file formats. They have become an extremely valuable quick-reference from the command line for users, system administrators, and programmers. Although intended as reference material rather than tutorials, the EXAMPLES sections of manual pages often provide detailed use case. Manual pages are generally shown interactively by the man(1) command. When = the user types man ls, a search is performed for a manual page matching ls. The first matching result is displayed. ----------- Maybe we can take this approach to refining the example section of this man= ual page? (In examples area for clarity) Bridge changes may be conducted with the .Dq Bridge Interface Parameters of .Xr ifconfig 8 Thoughts? --=20 You are receiving this mail because: You are on the CC list for the bug.=