From nobody Fri Aug 20 09:19:02 2021 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 4265C1777262 for ; Fri, 20 Aug 2021 09:19:02 +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 4Grbft0nsQz55w3 for ; Fri, 20 Aug 2021 09:19:02 +0000 (UTC) (envelope-from bugzilla-noreply@freebsd.org) 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 D123E1681C for ; Fri, 20 Aug 2021 09:19: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 17K9J13l091658 for ; Fri, 20 Aug 2021 09:19:01 GMT (envelope-from bugzilla-noreply@freebsd.org) Received: (from www@localhost) by kenobi.freebsd.org (8.15.2/8.15.2/Submit) id 17K9J1r4091657 for bugs@FreeBSD.org; Fri, 20 Aug 2021 09:19: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: bugs@FreeBSD.org Subject: [Bug 257964] snp(4) manual page is out of sync with the device implementation on 12.2 Date: Fri, 20 Aug 2021 09:19:02 +0000 X-Bugzilla-Reason: AssignedTo 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: bsdpr@phoe.frmug.org X-Bugzilla-Status: New X-Bugzilla-Resolution: X-Bugzilla-Priority: --- X-Bugzilla-Assigned-To: bugs@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 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: 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 X-Spam: Yes X-ThisMailContainsUnwantedMimeParts: N https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=3D257964 Bug ID: 257964 Summary: snp(4) manual page is out of sync with the device implementation on 12.2 Product: Documentation Version: Latest Hardware: Any OS: Any Status: New Severity: Affects Only Me Priority: --- Component: Manual Pages Assignee: bugs@FreeBSD.org Reporter: bsdpr@phoe.frmug.org CC: doc@FreeBSD.org This bug report about the snp(4) manual page is a follow-up to a question I asked in freebsd-hackers: https://lists.freebsd.org/archives/freebsd-hackers/2021-August/000216.html 1. The description of the device is inaccurate: in "allows users to attach = to any tty and watch activities on it", the plural on "activities" led me to t= hink that we could snoop on bidirectional traffic. Instead it should be made cle= ar that we can only snoop on egress streams, ie. data originating from the hos= t. 2. Special values mentioned for the FIONREAD ioctl() are no longer used, in snp.c none of those symbols are actually present. They should be removed fr= om the manual page as well as "This version of snp does not return proper error codes when calling FIONREAD" in the BUGS section. These symbols could howev= er still be mentioned as being obsolete in the HISTORY section. 3. Today, disappearance, closure and detachment of the snooped device are n= ow signaled by an EIO return on read() and by an EIO or ENXIO return on write(= ). This should be documented. 4. There is no handling of overflow as it used to be. Quoting the source co= de: "Right now we don't support any form of flow control". This should be documented. --=20 You are receiving this mail because: You are the assignee for the bug.=