2020-03-17 14:55:25

by Mauro Carvalho Chehab

Subject: [PATCH 06/17] firewire: firewire-cdev.hL get rid of a docs warning

This warning:

./include/uapi/linux/firewire-cdev.h:312: WARNING: Inline literal start-string without end-string.

is because %FOO doesn't work if there's a parenthesis at the
string (as a parenthesis may indicate a function). So, mark
the literal block using the alternate ``FOO`` syntax.

Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
include/uapi/linux/firewire-cdev.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/uapi/linux/firewire-cdev.h b/include/uapi/linux/firewire-cdev.h
index 1acd2b179aef..7e5b5c10a49c 100644
--- a/include/uapi/linux/firewire-cdev.h
+++ b/include/uapi/linux/firewire-cdev.h
@@ -308,7 +308,7 @@ struct fw_cdev_event_iso_interrupt_mc {
/**
* struct fw_cdev_event_iso_resource - Iso resources were allocated or freed
* @closure: See &fw_cdev_event_common;
- * set by %FW_CDEV_IOC_(DE)ALLOCATE_ISO_RESOURCE(_ONCE) ioctl
+ * set by``FW_CDEV_IOC_(DE)ALLOCATE_ISO_RESOURCE(_ONCE)`` ioctl
* @type: %FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED or
* %FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED
* @handle: Reference by which an allocated resource can be deallocated
--
2.24.1

2020-03-17 17:36:52

by Stefan Richter

Subject: Re: [PATCH 06/17] firewire: firewire-cdev.hL get rid of a docs warning

On Mar 17 Mauro Carvalho Chehab wrote:
> This warning:
>
> ./include/uapi/linux/firewire-cdev.h:312: WARNING: Inline literal start-string without end-string.
>
> is because %FOO doesn't work if there's a parenthesis at the
> string (as a parenthesis may indicate a function). So, mark
> the literal block using the alternate ``FOO`` syntax.
>
> Signed-off-by: Mauro Carvalho Chehab <[email protected]>

I figure this is meant to go through the Documentation tree, hence

Acked-by: Stefan Richter <[email protected]>

But if I am to apply it, give me a note.

> ---
> include/uapi/linux/firewire-cdev.h | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/include/uapi/linux/firewire-cdev.h b/include/uapi/linux/firewire-cdev.h
> index 1acd2b179aef..7e5b5c10a49c 100644
> --- a/include/uapi/linux/firewire-cdev.h
> +++ b/include/uapi/linux/firewire-cdev.h
> @@ -308,7 +308,7 @@ struct fw_cdev_event_iso_interrupt_mc {
> /**
> * struct fw_cdev_event_iso_resource - Iso resources were allocated or freed
> * @closure: See &fw_cdev_event_common;
> - * set by %FW_CDEV_IOC_(DE)ALLOCATE_ISO_RESOURCE(_ONCE) ioctl
> + * set by``FW_CDEV_IOC_(DE)ALLOCATE_ISO_RESOURCE(_ONCE)`` ioctl
> * @type: %FW_CDEV_EVENT_ISO_RESOURCE_ALLOCATED or
> * %FW_CDEV_EVENT_ISO_RESOURCE_DEALLOCATED
> * @handle: Reference by which an allocated resource can be deallocated

--
Stefan Richter
-======--=-- --== =---=
http://arcgraph.de/sr/