Re: [U-Boot] [PATCH v3 1/3] misc: docs: Fix comments in misc.h

[Mario Six]

Hi Simon,

On Wed, May 30, 2018 at 9:18 PM, Simon Glass  wrote:
> Hi Mario,
>
> On 28 May 2018 at 07:01, Mario Six  wrote:
>> Hi Simon,
>>
>> On Fri, May 25, 2018 at 4:41 AM, Simon Glass  wrote:
>>> +Marex
>>>
>>> Hi Mario,
>>>
>>> On 23 May 2018 at 08:07, Mario Six  wrote:
 The comments in misc.h are not in kernel-doc format. Correct the format.

 Signed-off-by: Mario Six 

 ---

 v2 -> v3:
 New in v3

 ---
  include/misc.h | 66 
 +++---
  1 file changed, 35 insertions(+), 31 deletions(-)

>>>
>>> Not another format?! I have been following what I thought was docbook
>>> format as proposed by Marek a few years ago.
>>>
>>
>> Well, others seem to think different. Michal pointed out in [1] that the
>> comments were very close to kerneldoc, but not quiet, and proposed to change
>> the format to make them comply. This seems reasonable, since the kerneldoc
>> utility is in the tree after all.
>>
>> As for the docbook format: That was imported from the Linux kernel, and the
>> kernel guys subsequently abandoned the docbook format in favor of 
>> Sphinx-based
>> documentation. So, you could argue that the docbook format is obsolete (also,
>> from what I see there were only ever two docbook documents written in U-Boot,
>> so the success was limited).
>>
>> But that's actually a good question: Is there a preferred or even mandatory 
>> doc
>> format in use? If that's the case, it would certainly be nice if it was
>> documented somewhere (or even if there was an automated linter akin to
>> kerneldoc, for example).
>>
>> [1] http://patchwork.ozlabs.org/patch/905733/#1902178
>
> OK how about adding it to the README then? Also the DocBook scripts
> need to be updated I think.
>

The best way to update the DocBook scripts would probably be to pull in the
sphinx-based scripts, and migrate the DocBook files to sphinx. I'll check how
complicated that would be.

> Regards,
> Simon
>

Best regards,
Mario
___
U-Boot mailing list
U-Boot@lists.denx.de
https://lists.denx.de/listinfo/u-boot

Re: [U-Boot] [PATCH v3 1/3] misc: docs: Fix comments in misc.h

[Simon Glass]

Hi Mario,

On 28 May 2018 at 07:01, Mario Six  wrote:
> Hi Simon,
>
> On Fri, May 25, 2018 at 4:41 AM, Simon Glass  wrote:
>> +Marex
>>
>> Hi Mario,
>>
>> On 23 May 2018 at 08:07, Mario Six  wrote:
>>> The comments in misc.h are not in kernel-doc format. Correct the format.
>>>
>>> Signed-off-by: Mario Six 
>>>
>>> ---
>>>
>>> v2 -> v3:
>>> New in v3
>>>
>>> ---
>>>  include/misc.h | 66 
>>> +++---
>>>  1 file changed, 35 insertions(+), 31 deletions(-)
>>>
>>
>> Not another format?! I have been following what I thought was docbook
>> format as proposed by Marek a few years ago.
>>
>
> Well, others seem to think different. Michal pointed out in [1] that the
> comments were very close to kerneldoc, but not quiet, and proposed to change
> the format to make them comply. This seems reasonable, since the kerneldoc
> utility is in the tree after all.
>
> As for the docbook format: That was imported from the Linux kernel, and the
> kernel guys subsequently abandoned the docbook format in favor of Sphinx-based
> documentation. So, you could argue that the docbook format is obsolete (also,
> from what I see there were only ever two docbook documents written in U-Boot,
> so the success was limited).
>
> But that's actually a good question: Is there a preferred or even mandatory 
> doc
> format in use? If that's the case, it would certainly be nice if it was
> documented somewhere (or even if there was an automated linter akin to
> kerneldoc, for example).
>
> [1] http://patchwork.ozlabs.org/patch/905733/#1902178

OK how about adding it to the README then? Also the DocBook scripts
need to be updated I think.

Regards,
Simon
___
U-Boot mailing list
U-Boot@lists.denx.de
https://lists.denx.de/listinfo/u-boot

Re: [U-Boot] [PATCH v3 1/3] misc: docs: Fix comments in misc.h

[Mario Six]

Hi Simon,

On Fri, May 25, 2018 at 4:41 AM, Simon Glass  wrote:
> +Marex
>
> Hi Mario,
>
> On 23 May 2018 at 08:07, Mario Six  wrote:
>> The comments in misc.h are not in kernel-doc format. Correct the format.
>>
>> Signed-off-by: Mario Six 
>>
>> ---
>>
>> v2 -> v3:
>> New in v3
>>
>> ---
>>  include/misc.h | 66 
>> +++---
>>  1 file changed, 35 insertions(+), 31 deletions(-)
>>
>
> Not another format?! I have been following what I thought was docbook
> format as proposed by Marek a few years ago.
>

Well, others seem to think different. Michal pointed out in [1] that the
comments were very close to kerneldoc, but not quiet, and proposed to change
the format to make them comply. This seems reasonable, since the kerneldoc
utility is in the tree after all.

As for the docbook format: That was imported from the Linux kernel, and the
kernel guys subsequently abandoned the docbook format in favor of Sphinx-based
documentation. So, you could argue that the docbook format is obsolete (also,
from what I see there were only ever two docbook documents written in U-Boot,
so the success was limited).

But that's actually a good question: Is there a preferred or even mandatory doc
format in use? If that's the case, it would certainly be nice if it was
documented somewhere (or even if there was an automated linter akin to
kerneldoc, for example).

[1] http://patchwork.ozlabs.org/patch/905733/#1902178

> Regards,
> Simon

Best regards,
Mario
___
U-Boot mailing list
U-Boot@lists.denx.de
https://lists.denx.de/listinfo/u-boot

Re: [U-Boot] [PATCH v3 1/3] misc: docs: Fix comments in misc.h

[Simon Glass]

+Marex

Hi Mario,

On 23 May 2018 at 08:07, Mario Six  wrote:
> The comments in misc.h are not in kernel-doc format. Correct the format.
>
> Signed-off-by: Mario Six 
>
> ---
>
> v2 -> v3:
> New in v3
>
> ---
>  include/misc.h | 66 
> +++---
>  1 file changed, 35 insertions(+), 31 deletions(-)
>

Not another format?! I have been following what I thought was docbook
format as proposed by Marek a few years ago.

Regards,
Simon
___
U-Boot mailing list
U-Boot@lists.denx.de
https://lists.denx.de/listinfo/u-boot

[U-Boot] [PATCH v3 1/3] misc: docs: Fix comments in misc.h

[Mario Six]

The comments in misc.h are not in kernel-doc format. Correct the format.

Signed-off-by: Mario Six 

---

v2 -> v3:
New in v3

---
 include/misc.h | 66 +++---
 1 file changed, 35 insertions(+), 31 deletions(-)

diff --git a/include/misc.h b/include/misc.h
index 68f8e64d61a..0acb4c4df64 100644
--- a/include/misc.h
+++ b/include/misc.h
@@ -6,38 +6,40 @@
 #ifndef _MISC_H_
 #define _MISC_H_

-/*
- * Read the device to buffer, optional.
+/**
+ * misc_read() - Read the device to buffer, optional.
  *
  * @dev: the device
  * @offset: offset to read the device
  * @buf: pointer to data buffer
  * @size: data size in bytes to read the device
- * @return: 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 int misc_read(struct udevice *dev, int offset, void *buf, int size);
-/*
- * Write buffer to the device, optional.
+
+/**
+ * misc_write() - Write buffer to the device, optional.
  *
  * @dev: the device
  * @offset: offset to write the device
  * @buf: pointer to data buffer
  * @size: data size in bytes to write the device
- * @return: 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 int misc_write(struct udevice *dev, int offset, void *buf, int size);
-/*
- * Assert command to the device, optional.
+
+/**
+ * misc_ioctl() - Assert command to the device, optional.
  *
  * @dev: the device
  * @request: command to be sent to the device
  * @buf: pointer to buffer related to the request
- * @return: 0 if OK, -ve on error
+ * Return: 0 if OK, -ve on error
  */
 int misc_ioctl(struct udevice *dev, unsigned long request, void *buf);

-/*
- * Send a message to the device and wait for a response.
+/**
+ * misc_call() - Send a message to the device and wait for a response.
  *
  * The caller provides the message type/ID and payload to be sent.
  * The callee constructs any message header required, transmits it to the
@@ -47,64 +49,66 @@ int misc_ioctl(struct udevice *dev, unsigned long request, 
void *buf);
  *
  * @dev: the device.
  * @msgid: the message ID/number to send.
- * tx_msg: the request/transmit message payload.
- * tx_size: the size of the buffer pointed at by tx_msg.
- * rx_msg: the buffer to receive the response message payload. May be NULL if
- * the caller only cares about the error code.
- * rx_size: the size of the buffer pointed at by rx_msg.
- * @return the response message size if OK, -ve on error
+ * @tx_msg: the request/transmit message payload.
+ * @tx_size: the size of the buffer pointed at by tx_msg.
+ * @rx_msg: the buffer to receive the response message payload. May be NULL if
+ *  the caller only cares about the error code.
+ * @rx_size: the size of the buffer pointed at by rx_msg.
+ * Return: the response message size if OK, -ve on error
  */
 int misc_call(struct udevice *dev, int msgid, void *tx_msg, int tx_size,
  void *rx_msg, int rx_size);

-/*
+/**
  * struct misc_ops - Driver model Misc operations
  *
  * The uclass interface is implemented by all miscellaneous devices which
  * use driver model.
  */
 struct misc_ops {
-   /*
+   /**
 * Read the device to buffer, optional.
 *
 * @dev: the device
 * @offset: offset to read the device
 * @buf: pointer to data buffer
 * @size: data size in bytes to read the device
-* @return: 0 if OK, -ve on error
+* Return: 0 if OK, -ve on error
 */
int (*read)(struct udevice *dev, int offset, void *buf, int size);
-   /*
+
+   /**
 * Write buffer to the device, optional.
 *
 * @dev: the device
 * @offset: offset to write the device
 * @buf: pointer to data buffer
 * @size: data size in bytes to write the device
-* @return: 0 if OK, -ve on error
+* Return: 0 if OK, -ve on error
 */
int (*write)(struct udevice *dev, int offset, const void *buf,
 int size);
-   /*
+   /**
 * Assert command to the device, optional.
 *
 * @dev: the device
 * @request: command to be sent to the device
 * @buf: pointer to buffer related to the request
-* @return: 0 if OK, -ve on error
+* Return: 0 if OK, -ve on error
 */
int (*ioctl)(struct udevice *dev, unsigned long request, void *buf);
-   /*
+
+   /**
 * Send a message to the device and wait for a response.
 *
 * @dev: the device
 * @msgid: the message ID/number to send
-* tx_msg: the request/transmit message payload
-* tx_size: the size of the buffer pointed at by tx_msg
-* rx_msg: the buffer to receive the response message payload. May be
-* NULL if the caller only cares about the error code.
-* rx_size: the size of the buffer pointed at by rx_msg
-* @return the response message size if OK, -ve on error
+* @tx_msg: the