From nobody Sun Mar 17 17:16:33 2024 X-Original-To: bugs@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 4TyPm20F8Tz5Dm0B 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 4TyPm15KNvz4DxT 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=btzjCPHSjVECentOk3oWd8Ag7pF0pO5QwOj9/l0QoBx5RTewf87N4mbBsqX3gVHYjZI5Oh 43cDtL9oVtkzyHkffn9R9+W8VYoyJyrXMN0kQsEgrW265t6hRCRJIeVKvGkHCd1SC1Ik/V afVTsUXzAbC+6BwA8yzw0y5SXu0iPN9BZ281NlgkznH09PV0QHo6J/xE5rwrHulBtwP/HC yXc82xKkIvyYtC4gwxSHUNDnJ/bvy6XZlP7v3mQPijiKoyd6uF8gwh4zeGB8QyBOT3EgG7 olYJnLWR6rEYcxeyVV+uL7puCk87/BrexkaTHXxTtnqQpyg0ffG7o7jLpjQ/kQ== 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=KwyKSO0cIOAp6YfFOVWQ9Hx70zfEHsxfmaFUYoSaoxI=; b=UR0Y1jHIW0ue/mwa3jjfFY8CSFtyDjLfpflH2ecf34E0aGOT6aoFW/Wj8V5LqCP+gREjRn wF2zKO23DKJ1y5bCnLiMHsmsV4lgyVUe6z0eLokm0Pr20wDXEOH1u3htzqE11MMOasP5Cc C0zry86clPEgsAv8f3n1kzh210XePrTGwkBkM3IKzW1Pb5B5omc1EqKwLCE/mufy69VByh kanPET7YtUhqatXLHmw+odx+U8mprCBmjQyau0FBGYGvb/u+B5i4XcQJlw0iLUSknu2zJs vX0VNScKeVqAeCE6YdUyIY2/XD/9K24MolaHXniHZD4ZirOEoqHbXbZ1gegi0A== 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 4TyPm14xV4znpT 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 42HHGXSC089838 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 42HHGX1G089837 for bugs@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: bugs@FreeBSD.org Subject: [Bug 231574] [IF_BRIDGE(4)] improvements Date: Sun, 17 Mar 2024 17:16:33 +0000 X-Bugzilla-Reason: AssignedTo 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: Bug reports List-Archive: https://lists.freebsd.org/archives/freebsd-bugs List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-freebsd-bugs@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 the assignee for the bug.=