linux-kernel - Re: [PATCH 2/8] rtc: max77686: convert comments to kernel-doc format

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: <YWm6eHTmG63smTZz@piout.net>
Date:   Fri, 15 Oct 2021 19:29:28 +0200
From:   Alexandre Belloni <alexandre.belloni@...tlin.com>
To:     Luca Ceresoli <luca@...aceresoli.net>
Cc:     linux-kernel@...r.kernel.org, Lee Jones <lee.jones@...aro.org>,
        Rob Herring <robh+dt@...nel.org>,
        Alessandro Zummo <a.zummo@...ertech.it>,
        Chanwoo Choi <cw00.choi@...sung.com>,
        Krzysztof Kozlowski <krzysztof.kozlowski@...onical.com>,
        Bartlomiej Zolnierkiewicz <b.zolnierkie@...sung.com>,
        Wim Van Sebroeck <wim@...ux-watchdog.org>,
        Guenter Roeck <linux@...ck-us.net>, devicetree@...r.kernel.org,
        linux-rtc@...r.kernel.org, linux-watchdog@...r.kernel.org,
        Chiwoong Byun <woong.byun@...sung.com>,
        Laxman Dewangan <ldewangan@...dia.com>
Subject: Re: [PATCH 2/8] rtc: max77686: convert comments to kernel-doc format

On 11/10/2021 17:56:09+0200, Luca Ceresoli wrote:
> Convert the comments documenting this struct to kernel-doc format for
> standardization and readability.
> 
> Signed-off-by: Luca Ceresoli <luca@...aceresoli.net>
Acked-by: Alexandre Belloni <alexandre.belloni@...tlin.com>

> ---
>  drivers/rtc/rtc-max77686.c | 21 ++++++++++++---------
>  1 file changed, 12 insertions(+), 9 deletions(-)
> 
> diff --git a/drivers/rtc/rtc-max77686.c b/drivers/rtc/rtc-max77686.c
> index eae7cb9faf1e..bac52cdea97d 100644
> --- a/drivers/rtc/rtc-max77686.c
> +++ b/drivers/rtc/rtc-max77686.c
> @@ -61,24 +61,27 @@ enum {
>  	RTC_NR_TIME
>  };
>  
> +/**
> + * struct max77686_rtc_driver_data - model-specific configuration
> + * @delay: Minimum usecs needed for a RTC update
> + * @mask: Mask used to read RTC registers value
> + * @map: Registers offset to I2C addresses map
> + * @alarm_enable_reg: Has a separate alarm enable register?
> + * @rtc_i2c_addr: I2C address for RTC block
> + * @rtc_irq_from_platform: RTC interrupt via platform resource
> + * @alarm_pending_status_reg: Pending alarm status register
> + * @rtc_irq_chip: RTC IRQ CHIP for regmap
> + * @regmap_config: regmap configuration for the chip
> + */
>  struct max77686_rtc_driver_data {
> -	/* Minimum usecs needed for a RTC update */
>  	unsigned long		delay;
> -	/* Mask used to read RTC registers value */
>  	u8			mask;
> -	/* Registers offset to I2C addresses map */
>  	const unsigned int	*map;
> -	/* Has a separate alarm enable register? */
>  	bool			alarm_enable_reg;
> -	/* I2C address for RTC block */
>  	int			rtc_i2c_addr;
> -	/* RTC interrupt via platform resource */
>  	bool			rtc_irq_from_platform;
> -	/* Pending alarm status register */
>  	int			alarm_pending_status_reg;
> -	/* RTC IRQ CHIP for regmap */
>  	const struct regmap_irq_chip *rtc_irq_chip;
> -	/* regmap configuration for the chip */
>  	const struct regmap_config *regmap_config;
>  };
>  
> -- 
> 2.25.1
> 

-- 
Alexandre Belloni, co-owner and COO, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com