linux-kernel - Re: [PATCH 3/5] staging: typec: pd: Document struct pd

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]

Date:   Mon, 11 Sep 2017 13:09:42 +0300
From:   Sergei Shtylyov <sergei.shtylyov@...entembedded.com>
To:     Guenter Roeck <linux@...ck-us.net>,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>
Cc:     Heikki Krogerus <heikki.krogerus@...ux.intel.com>,
        Yueyao Zhu <yueyao@...gle.com>,
        Badhri Jagan Sridharan <badhri@...gle.com>,
        Hans de Goede <hdegoede@...hat.com>,
        linux-kernel@...r.kernel.org, devel@...verdev.osuosl.org,
        linux-usb@...r.kernel.org
Subject: Re: [PATCH 3/5] staging: typec: pd: Document struct pd_message

Hello.

On 9/10/2017 11:37 PM, Guenter Roeck wrote:

> struct pd_message is the format of a PD message as seen on the wire.
> 
> Signed-off-by: Guenter Roeck <linux@...ck-us.net>
> ---
>   drivers/staging/typec/pd.h | 5 +++++
>   1 file changed, 5 insertions(+)
> 
> diff --git a/drivers/staging/typec/pd.h b/drivers/staging/typec/pd.h
> index 30b32ad72acd..42a10883a2cb 100644
> --- a/drivers/staging/typec/pd.h
> +++ b/drivers/staging/typec/pd.h
> @@ -104,6 +104,11 @@ static inline unsigned int pd_header_msgid_le(__le16 header)
>   
>   #define PD_MAX_PAYLOAD		7
>   
> +/*

    The kernel-doc comments (to which this comment looks alike) should start 
with /**.

> + * struct pd_message - PD message as seen on wire
> + * @header:	PD message header
> + * @payload:	PD message payload
> + */
>   struct pd_message {
>   	__le16 header;
>   	__le32 payload[PD_MAX_PAYLOAD];

MBR, Sergei