linux-kernel - Re: [PATCH v3 1/4] serial: Convert serial

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] [day] [month] [year] [list]

Message-ID: <f05c437b-db3c-ad3-f393-3ff369d8f1c9@linux.intel.com>
Date:   Thu, 29 Sep 2022 12:25:38 +0300 (EEST)
From:   Ilpo Järvinen <ilpo.jarvinen@...ux.intel.com>
To:     Bagas Sanjaya <bagasdotme@...il.com>
cc:     linux-doc@...r.kernel.org, Jonathan Corbet <corbet@....net>,
        Jiri Slaby <jirislaby@...nel.org>,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        linux-serial <linux-serial@...r.kernel.org>,
        LKML <linux-kernel@...r.kernel.org>,
        Andy Shevchenko <andy.shevchenko@...il.com>,
        Akira Yokosawa <akiyks@...il.com>
Subject: Re: [PATCH v3 1/4] serial: Convert serial_rs485 to kernel doc

On Thu, 29 Sep 2022, Bagas Sanjaya wrote:

> On 9/29/22 15:39, Ilpo Järvinen wrote:
> > On Thu, 29 Sep 2022, Bagas Sanjaya wrote:
> > 
> >> On Wed, Sep 28, 2022 at 02:05:06PM +0300, Ilpo Järvinen wrote:
> >>> diff --git a/include/uapi/linux/serial.h b/include/uapi/linux/serial.h
> >>> index cea06924b295..6e347eb10b1f 100644
> >>> --- a/include/uapi/linux/serial.h
> >>> +++ b/include/uapi/linux/serial.h
> >>> @@ -107,37 +107,57 @@ struct serial_icounter_struct {
> >>>  	int reserved[9];
> >>>  };
> >>>  
> >>> -/*
> >>> +/**
> >>> + * struct serial_rs485 - serial interface for controlling RS485 settings.
> >>> + * @flags:			RS485 feature flags.
> >>> + * @delay_rts_before_send:	Delay before send (milliseconds).
> >>> + * @delay_rts_after_send:	Delay after send (milliseconds).
> >>> + * @addr_recv:			Receive filter for RS485 addressing mode
> >>> + *				(used only when %SER_RS485_ADDR_RECV is set).
> >>> + * @addr_dest:			Destination address for RS485 addressing mode
> >>> + *				(used only when %SER_RS485_ADDR_DEST is set).
> >>> + * @padding0:			Padding (set to zero).
> >>> + * @padding1:			Padding (set to zero).
> >>> + * @padding:			Deprecated, use @padding0 and @padding1 instead.
> >>> + *				Do not use with @addr_recv and @addr_dest (due to
> >>> + *				overlap).
> >>> + *
> >>
> >> I don't see definition of fields after @delay_rts_after_send in the
> >> htmldocs output.
> > 
> > So it seems, this one I had missed. I guess the reason is that those 
> > members are inside anonymous unions. But the formatting follows what 
> > is documented here AFAICT:
> > 
> > https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html#nested-structs-unions
> > 
> > Kerneldoc doesn't seem to live up to what is documented about it. It's a 
> > bit ironic that documentation system fails to document even itself to 
> > sufficient level, and what's worse, seems to be full of faulty examples.
> > 
> > Any suggestions how to make it work?
> > 
> 
> CC'ing Akira.

Nevermind, I figured out where the problem is (my incorrect use of 
private: markers).

-- 
 i.