From owner-freebsd-doc@freebsd.org Mon Jan 30 16:45:12 2017 Return-Path: Delivered-To: freebsd-doc@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:1900:2254:206a::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id 02F5ECC324B for ; Mon, 30 Jan 2017 16:45:12 +0000 (UTC) (envelope-from freebsd@pdx.rh.CN85.dnsmgr.net) Received: from mailman.ysv.freebsd.org (mailman.ysv.freebsd.org [IPv6:2001:1900:2254:206a::50:5]) by mx1.freebsd.org (Postfix) with ESMTP id E14B03C4 for ; Mon, 30 Jan 2017 16:45:11 +0000 (UTC) (envelope-from freebsd@pdx.rh.CN85.dnsmgr.net) Received: by mailman.ysv.freebsd.org (Postfix) id DD4ABCC3249; Mon, 30 Jan 2017 16:45:11 +0000 (UTC) Delivered-To: doc@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:1900:2254:206a::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id DCEC1CC3246 for ; Mon, 30 Jan 2017 16:45:11 +0000 (UTC) (envelope-from freebsd@pdx.rh.CN85.dnsmgr.net) Received: from pdx.rh.CN85.dnsmgr.net (br1.CN84in.dnsmgr.net [69.59.192.140]) (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits)) (Client did not present a certificate) by mx1.freebsd.org (Postfix) with ESMTPS id A20733C3; Mon, 30 Jan 2017 16:45:11 +0000 (UTC) (envelope-from freebsd@pdx.rh.CN85.dnsmgr.net) Received: from pdx.rh.CN85.dnsmgr.net (localhost [127.0.0.1]) by pdx.rh.CN85.dnsmgr.net (8.13.3/8.13.3) with ESMTP id v0UGj1FZ040168; Mon, 30 Jan 2017 08:45:02 -0800 (PST) (envelope-from freebsd@pdx.rh.CN85.dnsmgr.net) Received: (from freebsd@localhost) by pdx.rh.CN85.dnsmgr.net (8.13.3/8.13.3/Submit) id v0UGiupU040164; Mon, 30 Jan 2017 08:44:56 -0800 (PST) (envelope-from freebsd) From: "Rodney W. Grimes" Message-Id: <201701301644.v0UGiupU040164@pdx.rh.CN85.dnsmgr.net> Subject: Re: Mellanox as an HW vendor in FreeBSD 9.x (and above) HW notes In-Reply-To: To: Meny Yossefi Date: Mon, 30 Jan 2017 08:44:56 -0800 (PST) CC: "rgrimes@FreeBSD.org" , Benjamin Kaduk , "doc@FreeBSD.org" , "re@FreeBSD.org" , Hans Petter Selasky Reply-To: rgrimes@FreeBSD.org X-Mailer: ELM [version 2.4ME+ PL121h (25)] MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Content-Type: text/plain; charset=US-ASCII X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 30 Jan 2017 16:45:12 -0000 > We have man page for mlx5en on FreeBSD 10.x, 11.x and 12.x > We also have mlx4en and mlx4ib on 12.x fb-srv-nas1.dnsmgr.net:root {1005}# man mlx4ib No manual entry for mlx4ib fb-srv-nas1.dnsmgr.net:root {1006}# uname -a FreeBSD fb-srv-nas1.dnsmgr.net 12.0-CURRENT FreeBSD 12.0-CURRENT #0 r309361: Thu Dec 22 15:00:44 UTC 2016 root@fb-bld-amd64-current.dnsmgr.net:/usr/src/sys/amd64/compile/CUSTOMAMD64NAS amd64 Is mlx4ib a recent addition ?? > > We'll work on adding the missing man pages. That would be wonderful. > What would be the next step? Insure that your manual pages have the section that man2hwnotes.pl is looking for. I do see what looks correct in mlx4en.4. I think I spotted one problem, much of the infiniband stuff is not built or installed on a system unless WITH_OFED is defined, It could be that since Infiniband does not work out of the box without a buildworld that these items have been opted out of the release notes. I do see that mlx4.ko mlx4en.ko mlx5.ko mlx5en.ko are built on a -current system, so those should show up in the hardware list. The others (mlx4ib, mthca) are hidden behind a MAKE_OFED. As someone else stated a patch to release/doc/en_US.ISO8859-1/hardware/article.xml adding the hwlist. entries well be needed. > -Meny > > > -----Original Message----- > From: Rodney W. Grimes [mailto:freebsd@pdx.rh.CN85.dnsmgr.net] > Sent: Sunday, January 29, 2017 9:19 PM > To: Meny Yossefi > Cc: Benjamin Kaduk ; doc@FreeBSD.org; re@FreeBSD.org; Hans Petter Selasky > Subject: Re: Mellanox as an HW vendor in FreeBSD 9.x (and above) HW notes > > Having just recently started to play with Mellanox HW I can say that most likely the cause of not getting in the release notes are there are NO manual pages for the Mellanox drivers. > > So my guess would be the first step is to write section 4 manual pages for mtcha(4), mlx4(4), mlx5(4), mlx4en(4), mlx4ib(4), ... etc > > > Thanks Ben. > > > > I got no response from re@Freebsd. > > > > Is there a specific person you can refer me to? > > > > -Meny > > > > > > -----Original Message----- > > From: Benjamin Kaduk [mailto:kaduk@mit.edu] > > Sent: Sunday, January 15, 2017 11:42 PM > > To: Meny Yossefi > > Cc: doc@FreeBSD.org; Hans Petter Selasky ; > > re@FreeBSD.org > > Subject: Re: Mellanox as an HW vendor in FreeBSD 9.x (and above) HW > > notes > > > > On Sun, Jan 15, 2017 at 03:38:06PM +0000, Meny Yossefi wrote: > > > Hi, > > > > > > My name is Meny and I'm leading Mellanox's FreeBSD team these days, developing Ethernet and InfiniBand drivers for our ConnectX NICs. > > > > > > We came across the FreeBSD 11.0 hardware notes and found that we were not included in the list although we have an Ethernet and InfiniBand driver since FreeBSD 9.1. > > > > > > https://www.freebsd.org/releases/11.0R/relnotes.html > > > > > > > > > Can you please let me know what is the procedure for adding us as a vendor? > > > > As I understand it, the hardware notes are generated automatically via certain portions of certain manual pages. > > > > It looks like that takes the form of &hwlist.; entities in > > (e.g.) ^/base/head/release/doc/en_US.ISO8859-1/hardware/article.xml, with the hwlist entities being generated by ^/base/head/release/doc/share/misc/man2hwnotes.pl. I don't know offhand whether mlx5en.4 is formatted properly for that script, but it seems that at a minimum, the &hwlist.mlx5en; entity needs to be added to the release notes sources. > > > > I've cc'd re@FreeBSD.org, since they have change control over the release notes and would need to make or approve such a change. > > > > -Ben > > > > > > -- > Rod Grimes rgrimes@freebsd.org > > -- Rod Grimes rgrimes@freebsd.org