diff mbox

[Quantal,SRU] kernel-doc: bugfix - multi-line macros

Message ID 1378911866-29758-1-git-send-email-luis.henriques@canonical.com
State New
Headers show

Commit Message

Luis Henriques Sept. 11, 2013, 3:04 p.m. UTC
From: Daniel Santos <daniel.santos@pobox.com>

BugLink: http://bugs.launchpad.net/bugs/1223920

Prior to this patch the following code breaks:

/**
 * multiline_example - this breaks kernel-doc
 */
 #define multiline_example( \
myparam)

Producing this error:

Error(somefile.h:983): cannot understand prototype: 'multiline_example( \ '

This patch fixes the issue by appending all lines ending in a blackslash
(optionally followed by whitespace), removing the backslash and any
whitespace after it prior to appending (just like the C pre-processor
would).

This fixes a break in kerel-doc introduced by the additions to rbtree.h.

Signed-off-by: Daniel Santos <daniel.santos@pobox.com>
Cc: Randy Dunlap <rdunlap@xenotime.net>
Cc: Michal Marek <mmarek@suse.cz>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
(cherry picked from commit 654784284430bf2739985914b65e09c7c35a7273)
Signed-off-by: Luis Henriques <luis.henriques@canonical.com>
---
 scripts/kernel-doc | 3 +++
 1 file changed, 3 insertions(+)

Comments

Tim Gardner Sept. 11, 2013, 3:08 p.m. UTC | #1

Steve Conklin Sept. 11, 2013, 3:22 p.m. UTC | #2
On 09/11/2013 10:04 AM, Luis Henriques wrote:
> From: Daniel Santos <daniel.santos@pobox.com>
> 
> BugLink: http://bugs.launchpad.net/bugs/1223920
> 
> Prior to this patch the following code breaks:
> 
> /**
>  * multiline_example - this breaks kernel-doc
>  */
>  #define multiline_example( \
> myparam)
> 
> Producing this error:
> 
> Error(somefile.h:983): cannot understand prototype: 'multiline_example( \ '
> 
> This patch fixes the issue by appending all lines ending in a blackslash
> (optionally followed by whitespace), removing the backslash and any
> whitespace after it prior to appending (just like the C pre-processor
> would).
> 
> This fixes a break in kerel-doc introduced by the additions to rbtree.h.
> 
> Signed-off-by: Daniel Santos <daniel.santos@pobox.com>
> Cc: Randy Dunlap <rdunlap@xenotime.net>
> Cc: Michal Marek <mmarek@suse.cz>
> Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
> (cherry picked from commit 654784284430bf2739985914b65e09c7c35a7273)
> Signed-off-by: Luis Henriques <luis.henriques@canonical.com>
> ---
>  scripts/kernel-doc | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git a/scripts/kernel-doc b/scripts/kernel-doc
> index 9b0c0b8..55ab5e4 100755
> --- a/scripts/kernel-doc
> +++ b/scripts/kernel-doc
> @@ -2045,6 +2045,9 @@ sub process_file($) {
>  
>      $section_counter = 0;
>      while (<IN>) {
> +	while (s/\\\s*$//) {
> +	    $_ .= <IN>;
> +	}
>  	if ($state == 0) {
>  	    if (/$doc_start/o) {
>  		$state = 1;		# next line is always the function name
>
Brad Figg Sept. 11, 2013, 3:26 p.m. UTC | #3
On 09/11/2013 08:04 AM, Luis Henriques wrote:
> From: Daniel Santos <daniel.santos@pobox.com>
> 
> BugLink: http://bugs.launchpad.net/bugs/1223920
> 
> Prior to this patch the following code breaks:
> 
> /**
>  * multiline_example - this breaks kernel-doc
>  */
>  #define multiline_example( \
> myparam)
> 
> Producing this error:
> 
> Error(somefile.h:983): cannot understand prototype: 'multiline_example( \ '
> 
> This patch fixes the issue by appending all lines ending in a blackslash
> (optionally followed by whitespace), removing the backslash and any
> whitespace after it prior to appending (just like the C pre-processor
> would).
> 
> This fixes a break in kerel-doc introduced by the additions to rbtree.h.
> 
> Signed-off-by: Daniel Santos <daniel.santos@pobox.com>
> Cc: Randy Dunlap <rdunlap@xenotime.net>
> Cc: Michal Marek <mmarek@suse.cz>
> Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
> (cherry picked from commit 654784284430bf2739985914b65e09c7c35a7273)
> Signed-off-by: Luis Henriques <luis.henriques@canonical.com>
> ---
>  scripts/kernel-doc | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git a/scripts/kernel-doc b/scripts/kernel-doc
> index 9b0c0b8..55ab5e4 100755
> --- a/scripts/kernel-doc
> +++ b/scripts/kernel-doc
> @@ -2045,6 +2045,9 @@ sub process_file($) {
>  
>      $section_counter = 0;
>      while (<IN>) {
> +	while (s/\\\s*$//) {
> +	    $_ .= <IN>;
> +	}
>  	if ($state == 0) {
>  	    if (/$doc_start/o) {
>  		$state = 1;		# next line is always the function name
>
diff mbox

Patch

diff --git a/scripts/kernel-doc b/scripts/kernel-doc
index 9b0c0b8..55ab5e4 100755
--- a/scripts/kernel-doc
+++ b/scripts/kernel-doc
@@ -2045,6 +2045,9 @@  sub process_file($) {
 
     $section_counter = 0;
     while (<IN>) {
+	while (s/\\\s*$//) {
+	    $_ .= <IN>;
+	}
 	if ($state == 0) {
 	    if (/$doc_start/o) {
 		$state = 1;		# next line is always the function name