linux-kernel - Re: [PATCH v6 2/4] power: reset: add reboot mode driver

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]

Date:	Tue, 21 Jun 2016 13:39:45 +0200
From:	Krzysztof Kozlowski <k.kozlowski@...sung.com>
To:	Andy Yan <andy.yan@...k-chips.com>
Cc:	robh+dt@...nel.org, sre@...nel.org, heiko@...ech.de,
	john.stultz@...aro.org, arnd@...db.de, galak@...eaurora.org,
	ijc+devicetree@...lion.org.uk, catalin.marinas@....com,
	olof@...om.net, alexandre.belloni@...e-electrons.com,
	dbaryshkov@...il.com, jun.nie@...aro.org, pawel.moll@....com,
	will.deacon@....com, linux-rockchip@...ts.infradead.org,
	matthias.bgg@...il.com, devicetree@...r.kernel.org,
	linux-pm@...r.kernel.org, f.fainelli@...il.com,
	linux@....linux.org.uk, mbrugger@...e.com,
	linux-arm-kernel@...ts.infradead.org, lorenzo.pieralisi@....com,
	moritz.fischer@...us.com, linux-kernel@...r.kernel.org,
	wxt@...k-chips.com, dwmw2@...radead.org, mark.rutland@....com
Subject: Re: [PATCH v6 2/4] power: reset: add reboot mode driver

On 06/21/2016 01:01 PM, Andy Yan wrote:

(...)

>>> +MODULE_AUTHOR("Andy Yan <andy.yan@...k-chips.com");
>>> +MODULE_DESCRIPTION("System reboot mode driver");
>>> +MODULE_LICENSE("GPL v2");
>>> diff --git a/drivers/power/reset/reboot-mode.h
>>> b/drivers/power/reset/reboot-mode.h
>>> new file mode 100644
>>> index 0000000..44ed34f
>>> --- /dev/null
>>> +++ b/drivers/power/reset/reboot-mode.h
>>> @@ -0,0 +1,6 @@
>>> +#ifndef __REBOOT_MODE_H__
>>> +#define __REBOOT_MODE_H__
>>> +
>>> +int reboot_mode_register(struct device *dev, int (*write)(int));
>> Documentation would be appreciated. Although it is local header but
>> you decoupled them and you are exporting the function.
> 
>    You want this driver being a module in V9, so you may also want
>  I document this function when a exporting it. Where I should write the
>  documentation, and would you please give me some example?

Follow kernel-doc (kernel-doc-nano-HOWTO.txt). There is an example. Put
the documentation of functions next to them in source file (not header).

Best regards,
Krzysztof