All of lore.kernel.org
 help / color / mirror / Atom feed
From: Joe Perches <joe@perches.com>
To: Julia Lawall <Julia.Lawall@lip6.fr>, linux-metag@vger.kernel.org
Cc: kernel-janitors@vger.kernel.org, linux-tegra@vger.kernel.org,
	linux-pm@vger.kernel.org, drbd-dev@lists.linbit.com,
	linux-kernel@vger.kernel.org, linux-mtd@lists.infradead.org,
	linux-media@vger.kernel.org, dri-devel@lists.freedesktop.org,
	linaro-mm-sig@lists.linaro.org, linux-clk@vger.kernel.org,
	linux-arm-kernel@lists.infradead.org
Subject: Re: [PATCH 00/15] improve function-level documentation
Date: Sat, 01 Oct 2016 20:19:54 +0000	[thread overview]
Message-ID: <1475353194.1996.3.camel@perches.com> (raw)
In-Reply-To: <1475351192-27079-1-git-send-email-Julia.Lawall@lip6.fr>

On Sat, 2016-10-01 at 21:46 +0200, Julia Lawall wrote:
> These patches fix cases where the documentation above a function definition
> is not consistent with the function header.  Issues are detected using the
> semantic patch below (http://coccinelle.lip6.fr/).  Basically, the semantic
> patch parses a file to find comments, then matches each function header,
> and checks that the name and parameter list in the function header are
> compatible with the comment that preceeds it most closely.

Hi Julia.

Would it be possible for a semantic patch to scan for
function definitions where the types do not have
identifiers and update the definitions to match the
declarations?

For instance, given:

<some.h>
int foo(int);

<some.c>
int foo(int bar)
{
	return baz;
}

Could coccinelle output:

diff a/some.h b/some.h
[]
-int foo(int);
+int foo(int bar);

WARNING: multiple messages have this Message-ID (diff)
From: Joe Perches <joe@perches.com>
To: Julia Lawall <Julia.Lawall@lip6.fr>, linux-metag@vger.kernel.org
Cc: kernel-janitors@vger.kernel.org, linux-tegra@vger.kernel.org,
	linux-pm@vger.kernel.org, drbd-dev@lists.linbit.com,
	linux-kernel@vger.kernel.org, linux-mtd@lists.infradead.org,
	linux-media@vger.kernel.org, dri-devel@lists.freedesktop.org,
	linaro-mm-sig@lists.linaro.org, linux-clk@vger.kernel.org,
	linux-arm-kernel@lists.infradead.org
Subject: Re: [PATCH 00/15] improve function-level documentation
Date: Sat, 01 Oct 2016 13:19:54 -0700	[thread overview]
Message-ID: <1475353194.1996.3.camel@perches.com> (raw)
In-Reply-To: <1475351192-27079-1-git-send-email-Julia.Lawall@lip6.fr>

On Sat, 2016-10-01 at 21:46 +0200, Julia Lawall wrote:
> These patches fix cases where the documentation above a function definition
> is not consistent with the function header.  Issues are detected using the
> semantic patch below (http://coccinelle.lip6.fr/).  Basically, the semantic
> patch parses a file to find comments, then matches each function header,
> and checks that the name and parameter list in the function header are
> compatible with the comment that preceeds it most closely.

Hi Julia.

Would it be possible for a semantic patch to scan for
function definitions where the types do not have
identifiers and update the definitions to match the
declarations?

For instance, given:

<some.h>
int foo(int);

<some.c>
int foo(int bar)
{
	return baz;
}

Could coccinelle output:

diff a/some.h b/some.h
[]
-int foo(int);
+int foo(int bar);

WARNING: multiple messages have this Message-ID (diff)
From: Joe Perches <joe@perches.com>
To: Julia Lawall <Julia.Lawall@lip6.fr>, linux-metag@vger.kernel.org
Cc: linux-pm@vger.kernel.org, kernel-janitors@vger.kernel.org,
	linux-kernel@vger.kernel.org, dri-devel@lists.freedesktop.org,
	linaro-mm-sig@lists.linaro.org, linux-mtd@lists.infradead.org,
	linux-tegra@vger.kernel.org, linux-media@vger.kernel.org,
	linux-clk@vger.kernel.org, linux-arm-kernel@lists.infradead.org,
	drbd-dev@lists.linbit.com
Subject: Re: [Drbd-dev] [PATCH 00/15] improve function-level documentation
Date: Sat, 01 Oct 2016 13:19:54 -0700	[thread overview]
Message-ID: <1475353194.1996.3.camel@perches.com> (raw)
In-Reply-To: <1475351192-27079-1-git-send-email-Julia.Lawall@lip6.fr>

On Sat, 2016-10-01 at 21:46 +0200, Julia Lawall wrote:
> These patches fix cases where the documentation above a function definition
> is not consistent with the function header.  Issues are detected using the
> semantic patch below (http://coccinelle.lip6.fr/).  Basically, the semantic
> patch parses a file to find comments, then matches each function header,
> and checks that the name and parameter list in the function header are
> compatible with the comment that preceeds it most closely.

Hi Julia.

Would it be possible for a semantic patch to scan for
function definitions where the types do not have
identifiers and update the definitions to match the
declarations?

For instance, given:

<some.h>
int foo(int);

<some.c>
int foo(int bar)
{
	return baz;
}

Could coccinelle output:

diff a/some.h b/some.h
[]
-int foo(int);
+int foo(int bar);

WARNING: multiple messages have this Message-ID (diff)
From: joe@perches.com (Joe Perches)
To: linux-arm-kernel@lists.infradead.org
Subject: [PATCH 00/15] improve function-level documentation
Date: Sat, 01 Oct 2016 13:19:54 -0700	[thread overview]
Message-ID: <1475353194.1996.3.camel@perches.com> (raw)
In-Reply-To: <1475351192-27079-1-git-send-email-Julia.Lawall@lip6.fr>

On Sat, 2016-10-01 at 21:46 +0200, Julia Lawall wrote:
> These patches fix cases where the documentation above a function definition
> is not consistent with the function header.  Issues are detected using the
> semantic patch below (http://coccinelle.lip6.fr/).  Basically, the semantic
> patch parses a file to find comments, then matches each function header,
> and checks that the name and parameter list in the function header are
> compatible with the comment that preceeds it most closely.

Hi Julia.

Would it be possible for a semantic patch to scan for
function definitions where the types do not have
identifiers and update the definitions to match the
declarations?

For instance, given:

<some.h>
int foo(int);

<some.c>
int foo(int bar)
{
	return baz;
}

Could coccinelle output:

diff a/some.h b/some.h
[]
-int foo(int);
+int foo(int bar);

  parent reply	other threads:[~2016-10-01 20:19 UTC|newest]

Thread overview: 79+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-10-01 19:46 [PATCH 00/15] improve function-level documentation Julia Lawall
2016-10-01 19:46 ` Julia Lawall
2016-10-01 19:46 ` [Drbd-dev] " Julia Lawall
2016-10-01 19:46 ` Julia Lawall
2016-10-01 19:46 ` [PATCH 01/15] UBIFS: " Julia Lawall
2016-10-01 19:46   ` Julia Lawall
2016-10-01 19:46 ` [PATCH 02/15] netlink: " Julia Lawall
2016-10-01 19:46 ` [PATCH 03/15] fscrypto: " Julia Lawall
2016-10-01 19:46 ` [PATCH 04/15] lru_cache: " Julia Lawall
2016-10-01 19:46   ` [Drbd-dev] " Julia Lawall
2016-10-01 19:46 ` [PATCH 05/15] dma-buf/sw_sync: " Julia Lawall
2016-10-01 19:46   ` Julia Lawall
2016-10-01 19:46 ` [PATCH 06/15] mfd: tc3589x: " Julia Lawall
2016-10-26 12:18   ` Lee Jones
2016-10-01 19:46 ` [PATCH 07/15] clk: sunxi: mod0: " Julia Lawall
2016-10-01 19:46   ` Julia Lawall
2016-10-01 19:46   ` Julia Lawall
2016-10-04 21:05   ` Maxime Ripard
2016-10-04 21:05     ` Maxime Ripard
2016-10-04 21:05     ` Maxime Ripard
2016-10-01 19:46 ` [PATCH 08/15] power: " Julia Lawall
2016-10-01 19:46   ` Julia Lawall
2016-10-19  2:59   ` Sebastian Reichel
2016-10-19  2:59     ` Sebastian Reichel
2016-10-01 19:46 ` [PATCH 09/15] gma500: " Julia Lawall
2016-10-01 19:46   ` Julia Lawall
2016-10-01 19:46 ` [PATCH 10/15] clk: keystone: " Julia Lawall
2016-10-01 19:46   ` Julia Lawall
2016-11-02  0:38   ` Stephen Boyd
2016-11-02  0:38     ` Stephen Boyd
2016-10-01 19:46 ` [PATCH 11/15] kobject: " Julia Lawall
2016-10-01 19:46 ` [PATCH 12/15] clk: tegra: dfll: " Julia Lawall
2016-10-01 19:46   ` Julia Lawall
2016-11-02  0:38   ` Stephen Boyd
2016-11-02  0:38     ` Stephen Boyd
2016-10-01 19:46 ` [PATCH 13/15] irqchip: vic: " Julia Lawall
2016-10-01 19:46 ` [PATCH 14/15] irqchip/metag-ext: " Julia Lawall
2016-10-01 19:46   ` Julia Lawall
2016-10-01 20:33   ` James Hogan
2016-10-01 20:33     ` James Hogan
2016-10-01 19:46 ` [PATCH 15/15] drm/omap: " Julia Lawall
2016-10-01 19:46   ` Julia Lawall
2016-10-01 20:19 ` Joe Perches [this message]
2016-10-01 20:19   ` [PATCH 00/15] " Joe Perches
2016-10-01 20:19   ` [Drbd-dev] " Joe Perches
2016-10-01 20:19   ` Joe Perches
2016-10-01 20:39   ` Julia Lawall
2016-10-01 20:39     ` Julia Lawall
2016-10-01 20:39     ` [Drbd-dev] " Julia Lawall
2016-10-01 20:39     ` Julia Lawall
2016-10-01 20:39     ` Julia Lawall
     [not found] ` <1475351192-27079-1-git-send-email-Julia.Lawall-L2FTfq7BK8M@public.gmane.org>
2016-10-05 13:15   ` Daniel Vetter
2016-10-05 13:15     ` Daniel Vetter
2016-10-05 13:15     ` [Drbd-dev] " Daniel Vetter
2016-10-05 13:15     ` Daniel Vetter
2016-10-05 13:15     ` Daniel Vetter
2016-10-05 14:04     ` kernel-doc-rst-lint (was: Re: [PATCH 00/15] improve function-level documentation) Jani Nikula
2016-10-05 14:04       ` Jani Nikula
2016-10-05 14:04       ` [Drbd-dev] " Jani Nikula
2016-10-05 14:04       ` Jani Nikula
2016-10-05 14:04       ` Jani Nikula
2016-10-05 14:04       ` Jani Nikula
2016-10-05 14:04       ` Jani Nikula
2016-10-05 14:04       ` Jani Nikula
2016-10-05 17:27       ` Markus Heiser
2016-10-05 17:27         ` Markus Heiser
2016-10-05 17:27         ` [Drbd-dev] " Markus Heiser
2016-10-05 17:27         ` Markus Heiser
2016-10-05 17:27         ` Markus Heiser
2016-10-05 17:27         ` Markus Heiser
2016-10-05 20:25       ` Julia Lawall
2016-10-05 20:25         ` Julia Lawall
2016-10-05 20:25         ` [Drbd-dev] " Julia Lawall
2016-10-05 20:25         ` Julia Lawall
     [not found]     ` <CAKMK7uHT3FutHQuQQ3iwXmYbidB3AOs7AxnpaJD4MTqy0-QehQ-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
2016-10-05 14:47       ` [PATCH 00/15] improve function-level documentation Julia Lawall
2016-10-05 14:47         ` Julia Lawall
2016-10-05 14:47         ` [Drbd-dev] " Julia Lawall
2016-10-05 14:47         ` Julia Lawall
2016-10-05 14:47         ` Julia Lawall

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1475353194.1996.3.camel@perches.com \
    --to=joe@perches.com \
    --cc=Julia.Lawall@lip6.fr \
    --cc=drbd-dev@lists.linbit.com \
    --cc=dri-devel@lists.freedesktop.org \
    --cc=kernel-janitors@vger.kernel.org \
    --cc=linaro-mm-sig@lists.linaro.org \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-clk@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-media@vger.kernel.org \
    --cc=linux-metag@vger.kernel.org \
    --cc=linux-mtd@lists.infradead.org \
    --cc=linux-pm@vger.kernel.org \
    --cc=linux-tegra@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.