From owner-dev-commits-src-main@freebsd.org Sun Apr 18 11:58:52 2021 Return-Path: Delivered-To: dev-commits-src-main@mailman.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.nyi.freebsd.org (Postfix) with ESMTP id 625EA5E6B20; Sun, 18 Apr 2021 11:58:52 +0000 (UTC) (envelope-from freebsd@gndrsh.dnsmgr.net) Received: from gndrsh.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 4FNT4X0WZcz3Ll2; Sun, 18 Apr 2021 11:58:51 +0000 (UTC) (envelope-from freebsd@gndrsh.dnsmgr.net) Received: from gndrsh.dnsmgr.net (localhost [127.0.0.1]) by gndrsh.dnsmgr.net (8.13.3/8.13.3) with ESMTP id 13IBwhd2061792; Sun, 18 Apr 2021 04:58:43 -0700 (PDT) (envelope-from freebsd@gndrsh.dnsmgr.net) Received: (from freebsd@localhost) by gndrsh.dnsmgr.net (8.13.3/8.13.3/Submit) id 13IBwhFa061791; Sun, 18 Apr 2021 04:58:43 -0700 (PDT) (envelope-from freebsd) From: "Rodney W. Grimes" Message-Id: <202104181158.13IBwhFa061791@gndrsh.dnsmgr.net> Subject: Re: git: bc54f5f1cd5c - main - route(8): Add an example how to print the routing tables In-Reply-To: To: Gordon Bergling Date: Sun, 18 Apr 2021 04:58:43 -0700 (PDT) CC: rgrimes@freebsd.org, src-committers@freebsd.org, dev-commits-src-all@freebsd.org, dev-commits-src-main@freebsd.org 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-Rspamd-Queue-Id: 4FNT4X0WZcz3Ll2 X-Spamd-Bar: ---- Authentication-Results: mx1.freebsd.org; none X-Spamd-Result: default: False [-4.00 / 15.00]; REPLY(-4.00)[] X-BeenThere: dev-commits-src-main@freebsd.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: Commit messages for the main branch of the src repository List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sun, 18 Apr 2021 11:58:52 -0000 > On Wed, Apr 14, 2021 at 03:31:24AM -0700, Rodney W. Grimes wrote: > > > On Tue, Apr 13, 2021 at 03:36:14AM -0700, Rodney W. Grimes wrote: > > > > > The branch main has been updated by gbe (doc committer): > > > > > > > > > > URL: https://cgit.FreeBSD.org/src/commit/?id=bc54f5f1cd5c01aa5f941234034839fb0b8f54ed > > > > > > > > > > commit bc54f5f1cd5c01aa5f941234034839fb0b8f54ed > > > > > Author: Gordon Bergling > > > > > AuthorDate: 2021-04-13 04:44:04 +0000 > > > > > Commit: Gordon Bergling > > > > > CommitDate: 2021-04-13 04:45:22 +0000 > > > > > > > > > > route(8): Add an example how to print the routing tables > > > > > > > > > > The manual page currently doesn't show an example how to print > > > > > the routing table, so add one and .Xr netstat while here. > > > > > > > > Because the route command does not print the routing table. > > > > > > > > Manual pages should have examples of how to use that command, > > > > not examples of how to do associated things that are done > > > > using another command. > > > > > > > > The add of xref to netstat is long overdue. > > > > > > I know that examples in man pages should be specific for the command > > > the man page is for, but I think we could make an exception for netstat at > > > this point, because many people, who are looking for such an information > > > are coming from the Windows world, where the route command has a print > > > option. > > > > Perhaps add in description of "route get": > > To print the complete routing table refer to the netstat(8) -r flag. > > I am currently working on a 'route show' implementation for FreeBSD. NetBSD and > OpenBSD have this functionality already implemented. I would update the man page > after I have finished the implementation and the review process through phabricator. Be aware that the netstat -r implementation has serious issues when your dealing with full view route tables. The size of that table can change rapid enough that the cycling of calls to try to guess a proper chunk of memory to allocate is a race condition. See: https://reviews.freebsd.org/D15488 for some discussions and attempts at solutions. > --Gordon > > > > > > PR: 231579 > > > > > Reported by: Pekka J?rvinen > > > > > Reviewed by: debdrup > > > > > MFC after: 5 days > > > > > Differential Revision: https://reviews.freebsd.org/D29702 > > > > > --- > > > > > sbin/route/route.8 | 7 ++++++- > > > > > 1 file changed, 6 insertions(+), 1 deletion(-) > > > > > > > > > > diff --git a/sbin/route/route.8 b/sbin/route/route.8 > > > > > index 6f34795ce883..c353bfb73d62 100644 > > > > > --- a/sbin/route/route.8 > > > > > +++ b/sbin/route/route.8 > > > > > @@ -28,7 +28,7 @@ > > > > > .\" @(#)route.8 8.3 (Berkeley) 3/19/94 > > > > > .\" $FreeBSD$ > > > > > .\" > > > > > -.Dd January 9, 2019 > > > > > +.Dd April 11, 2021 > > > > > .Dt ROUTE 8 > > > > > .Os > > > > > .Sh NAME > > > > > @@ -453,6 +453,10 @@ Delete a static route from the routing table: > > > > > Remove all routes from the routing table: > > > > > .Pp > > > > > .Dl route flush > > > > > +.Pp > > > > > +List all routing tables: > > > > > +.Pp > > > > > +.Dl netstat -r > > > > > .Sh DIAGNOSTICS > > > > > .Bl -diag > > > > > .It "add [host \&| network ] %s: gateway %s flags %x" > > > > > @@ -493,6 +497,7 @@ The next-hop gateway should be reachable through a different route. > > > > > .El > > > > > .Sh SEE ALSO > > > > > .\".Xr esis 4 , > > > > > +.Xr netstat 1 , > > > > > .Xr netintro 4 , > > > > > .Xr route 4 , > > > > > .Xr arp 8 , > > > > > > > > > > > > > -- > > > > Rod Grimes rgrimes@freebsd.org > > > > > > -- > > > > > > > -- > > Rod Grimes rgrimes@freebsd.org > > -- > -- Rod Grimes rgrimes@freebsd.org