netdev - Re: [PATCH man-pages v2] rtnetlink.7: Document struct ifa

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <fvfuejrz36cejk344h646cm2chfnfangqjyq4pzpjeuhaxacq2@6kzmclbqsqg6>
Date: Wed, 13 Nov 2024 00:38:42 +0100
From: Alejandro Colomar <alx@...nel.org>
To: Kuniyuki Iwashima <kuniyu@...zon.com>
Cc: alexhenrie24@...il.com, branden@...ian.org, linux-man@...r.kernel.org, 
	mtk.manpages@...il.com, netdev@...r.kernel.org
Subject: Re: [PATCH man-pages v2] rtnetlink.7: Document struct ifa_cacheinfo

Hi Kuniyuki,

On Tue, Nov 12, 2024 at 03:33:29PM GMT, Kuniyuki Iwashima wrote:
> From: Alejandro Colomar <alx@...nel.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.
> 

Ahh, okay.  Then it's fine.

Thanks!
Alex

> 
> > 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.

-- 
<https://www.alejandro-colomar.es/>

Download attachment "signature.asc" of type "application/pgp-signature" (834 bytes)