Re: [PATCH 1/1] Document the new fanotify initialization flag FAN_REPORT_PIDFD

["Alejandro Colomar (man-pages)" <alx.manpages@gmail.com>]

Hi Matthew,

On 11/1/21 22:02, Matthew Bobrowski wrote:
> On Wed, Oct 27, 2021 at 01:14:49PM +0300, Amir Goldstein wrote:
>> On Wed, Oct 27, 2021 at 12:28 PM Matthew Bobrowski <repnop@google.com> wrote:
>>> +The
>>> +.I fanotify_event_info_header
>>> +structure also contains a
>>> +.I len
>>> +field.
>>> +The value of the
>>> +.I len
>>> +field is the total size of the
>>> +.I fanotify_event_info_pidfd
>>> +structure, which also includes
>>> +.IR fanotify_event_info_header .
>>
>> It would be a shame if we needed to repeat the same text for every new info_type
>> that we add. There should be no duplicate documentation of the
>> fanotify_event_info_header fields. Perhaps we need to describe those fields
>> before documenting fanotify_event_info_fid fields instead of inline in the
>> documentation of hdr field.
> 
> Right, I see where you're coming from and I do generally agree. If we
> continue repeating the same pattern for each bonus event that is based
> on fanotify_event_info_header, then we'll end up unnecessarily
> polluting the documentation.
> 
> Would you like me to try shuffle things around in a patch that
> precedes this one?

Sure.  Would you consider adding an entry to the system_data_types(7) 
manual page documenting that type?

Thanks,

Alex


-- 
Alejandro Colomar
Linux man-pages comaintainer; https://www.kernel.org/doc/man-pages/
http://www.alejandro-colomar.es/