public inbox for linux-man@vger.kernel.org
 help / color / mirror / Atom feed
From: Kuniyuki Iwashima <kuniyu@amazon.com>
To: <alx@kernel.org>
Cc: <alexhenrie24@gmail.com>, <branden@debian.org>,
	<kuniyu@amazon.com>, <linux-man@vger.kernel.org>,
	<mtk.manpages@gmail.com>, <netdev@vger.kernel.org>
Subject: Re: [PATCH man-pages v2] rtnetlink.7: Document struct ifa_cacheinfo
Date: Tue, 12 Nov 2024 15:33:29 -0800	[thread overview]
Message-ID: <20241112233329.20660-1-kuniyu@amazon.com> (raw)
In-Reply-To: <udctaxcv6yqjvffgrtzgqo24ee3kr4h4ku66ubohc7l4hqwg3w@6ujhaoyg4kla>

From: Alejandro Colomar <alx@kernel.org>
Date: Wed, 13 Nov 2024 00:26:15 +0100
> > diff --git a/man/man7/rtnetlink.7 b/man/man7/rtnetlink.7
> > index 86ed459bb..ed08834b0 100644
> > --- a/man/man7/rtnetlink.7
> > +++ b/man/man7/rtnetlink.7
> > @@ -176,7 +176,24 @@ IFA_BROADCAST:raw protocol address:broadcast address
> >  IFA_ANYCAST:raw protocol address:anycast address
> >  IFA_CACHEINFO:struct ifa_cacheinfo:Address information
> >  .TE
> > -.\" FIXME Document struct ifa_cacheinfo
> > +.IP
> > +.EX
> 
> I expect users that need to use this struct to also need to include the
> header that defines it, right?

rtnetlink.7 tells #include <linux/rtnetlink.h> is needed in SYNOPSIS
and the header internally includes <linux/if_addr.h>, so users need
not include it explicitly for struct ifa_cacheinfo.


> We should probably specify it by using
> an #include.  What do you think?

So I think we need not mention linux/if_addr.h here.

  reply	other threads:[~2024-11-12 23:33 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-11-05  4:14 [PATCH] rtnetlink.7: Document struct ifa_cacheinfo Alex Henrie
2024-11-05  5:53 ` Kuniyuki Iwashima
2024-11-05 11:33   ` Alejandro Colomar
2024-11-06 17:18     ` Stephen Hemminger
2024-11-06 17:44       ` Alejandro Colomar
2024-11-06 17:48         ` G. Branden Robinson
2024-11-06 17:45       ` G. Branden Robinson
2024-11-06 18:02         ` Alejandro Colomar
2024-11-11  6:17     ` Alex Henrie
2024-11-11  9:34       ` Alejandro Colomar
2024-11-09 16:27 ` Stephen Hemminger
2024-11-11  6:20 ` [PATCH man-pages v2] " Alex Henrie
2024-11-12  1:11   ` Kuniyuki Iwashima
2024-11-12  7:58     ` Alejandro Colomar
2024-11-12 23:26   ` Alejandro Colomar
2024-11-12 23:33     ` Kuniyuki Iwashima [this message]
2024-11-12 23:38       ` Alejandro Colomar
2024-11-12 23:46   ` Alejandro Colomar

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20241112233329.20660-1-kuniyu@amazon.com \
    --to=kuniyu@amazon.com \
    --cc=alexhenrie24@gmail.com \
    --cc=alx@kernel.org \
    --cc=branden@debian.org \
    --cc=linux-man@vger.kernel.org \
    --cc=mtk.manpages@gmail.com \
    --cc=netdev@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox