All of lore.kernel.org
 help / color / mirror / Atom feed
From: Michal Simek <michal.simek@xilinx.com>
To: Michael Tretter <m.tretter@pengutronix.de>,
	<linux-clk@vger.kernel.org>,
	<linux-arm-kernel@lists.infradead.org>
Cc: <kernel@pengutronix.de>,
	Michael Turquette <mturquette@baylibre.com>,
	Stephen Boyd <sboyd@kernel.org>,
	Michal Simek <michal.simek@xilinx.com>,
	Jolly Shah <jolly.shah@xilinx.com>
Subject: Re: [PATCH 2/5] clk: zynqmp: fix doc of __zynqmp_clock_get_parents
Date: Wed, 13 Mar 2019 15:48:02 +0100	[thread overview]
Message-ID: <8fea7830-0d86-1d88-ed12-f5c9ffb907e3@xilinx.com> (raw)
In-Reply-To: <20190312110016.29174-3-m.tretter@pengutronix.de>

On 12. 03. 19 12:00, Michael Tretter wrote:
> The kernel-doc refers to __zynqmp_clock_get_topology(), while it actually
> documents __zynqmp_clock_get_parents(). Fix the documentation to refer
> to the correct function name.
> 
> Signed-off-by: Michael Tretter <m.tretter@pengutronix.de>
> ---
> I think most of the function documentation in this file is pretty
> useless and sometimes misleading. Maybe we should drop the documentation
> entirely, because all functions are static anyway?

Interesting is that kernel-doc is not able to find this issue.

drivers/clk/zynqmp/clkc.c:336: info: Scanning doc for
zynqmp_pm_clock_get_attributes
drivers/clk/zynqmp/clkc.c:360: info: Scanning doc for
__zynqmp_clock_get_topology
drivers/clk/zynqmp/clkc.c:388: info: Scanning doc for
zynqmp_clock_get_topology
drivers/clk/zynqmp/clkc.c:418: info: Scanning doc for
__zynqmp_clock_get_topology
drivers/clk/zynqmp/clkc.c:453: info: Scanning doc for
zynqmp_clock_get_parents
drivers/clk/zynqmp/clkc.c:485: info: Scanning doc for zynqmp_get_parent_list

I think that doc is good because it helps with understanding of code.
If there is something misleading that it should be rather fix then remove.

M

WARNING: multiple messages have this Message-ID (diff)
From: Michal Simek <michal.simek@xilinx.com>
To: Michael Tretter <m.tretter@pengutronix.de>,
	<linux-clk@vger.kernel.org>,
	<linux-arm-kernel@lists.infradead.org>
Cc: Stephen Boyd <sboyd@kernel.org>,
	Jolly Shah <jolly.shah@xilinx.com>,
	Michael Turquette <mturquette@baylibre.com>,
	Michal Simek <michal.simek@xilinx.com>,
	kernel@pengutronix.de
Subject: Re: [PATCH 2/5] clk: zynqmp: fix doc of __zynqmp_clock_get_parents
Date: Wed, 13 Mar 2019 15:48:02 +0100	[thread overview]
Message-ID: <8fea7830-0d86-1d88-ed12-f5c9ffb907e3@xilinx.com> (raw)
In-Reply-To: <20190312110016.29174-3-m.tretter@pengutronix.de>

On 12. 03. 19 12:00, Michael Tretter wrote:
> The kernel-doc refers to __zynqmp_clock_get_topology(), while it actually
> documents __zynqmp_clock_get_parents(). Fix the documentation to refer
> to the correct function name.
> 
> Signed-off-by: Michael Tretter <m.tretter@pengutronix.de>
> ---
> I think most of the function documentation in this file is pretty
> useless and sometimes misleading. Maybe we should drop the documentation
> entirely, because all functions are static anyway?

Interesting is that kernel-doc is not able to find this issue.

drivers/clk/zynqmp/clkc.c:336: info: Scanning doc for
zynqmp_pm_clock_get_attributes
drivers/clk/zynqmp/clkc.c:360: info: Scanning doc for
__zynqmp_clock_get_topology
drivers/clk/zynqmp/clkc.c:388: info: Scanning doc for
zynqmp_clock_get_topology
drivers/clk/zynqmp/clkc.c:418: info: Scanning doc for
__zynqmp_clock_get_topology
drivers/clk/zynqmp/clkc.c:453: info: Scanning doc for
zynqmp_clock_get_parents
drivers/clk/zynqmp/clkc.c:485: info: Scanning doc for zynqmp_get_parent_list

I think that doc is good because it helps with understanding of code.
If there is something misleading that it should be rather fix then remove.

M

_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel

  reply	other threads:[~2019-03-13 14:48 UTC|newest]

Thread overview: 40+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-03-12 11:00 [PATCH 0/5] clk: zynqmp: fix CLK_FRAC and various cleanups Michael Tretter
2019-03-12 11:00 ` Michael Tretter
2019-03-12 11:00 ` [PATCH 1/5] clk: zynqmp: fix check for fractional clock Michael Tretter
2019-03-12 11:00   ` Michael Tretter
2019-03-12 16:49   ` Stephen Boyd
2019-03-12 16:49     ` Stephen Boyd
2019-03-12 17:25     ` Michael Tretter
2019-03-12 17:25       ` Michael Tretter
2019-03-13 16:24       ` Stephen Boyd
2019-03-13 16:24         ` Stephen Boyd
2019-03-14  8:38         ` Michael Tretter
2019-03-14  8:38           ` Michael Tretter
2019-03-14 15:45           ` Stephen Boyd
2019-03-14 15:45             ` Stephen Boyd
2019-03-19  0:56           ` Jolly Shah
2019-03-19  0:56             ` Jolly Shah
2019-03-19 10:19             ` Michael Tretter
2019-03-19 10:19               ` Michael Tretter
2019-03-12 11:00 ` [PATCH 2/5] clk: zynqmp: fix doc of __zynqmp_clock_get_parents Michael Tretter
2019-03-12 11:00   ` Michael Tretter
2019-03-13 14:48   ` Michal Simek [this message]
2019-03-13 14:48     ` Michal Simek
2019-03-12 11:00 ` [PATCH 3/5] clk: zynqmp: do not export zynqmp_clk_register_mux Michael Tretter
2019-03-12 11:00   ` Michael Tretter
2019-03-12 16:52   ` Stephen Boyd
2019-03-12 16:52     ` Stephen Boyd
2019-03-12 17:26     ` Michael Tretter
2019-03-12 17:26       ` Michael Tretter
2019-03-12 11:00 ` [PATCH 4/5] clk: zynqmp: cleanup sizes of firmware responses Michael Tretter
2019-03-12 11:00   ` Michael Tretter
2019-03-13 16:37   ` Stephen Boyd
2019-03-13 16:37     ` Stephen Boyd
2019-03-12 11:00 ` [PATCH 5/5] clk: zynqmp: make field definitions of query responses consistent Michael Tretter
2019-03-12 11:00   ` Michael Tretter
2019-03-12 11:19   ` Michael Tretter
2019-03-12 11:19     ` Michael Tretter
2019-03-19  0:47   ` Jolly Shah
2019-03-19  0:47     ` Jolly Shah
2019-03-13 14:49 ` [PATCH 0/5] clk: zynqmp: fix CLK_FRAC and various cleanups Michal Simek
2019-03-13 14:49   ` Michal Simek

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=8fea7830-0d86-1d88-ed12-f5c9ffb907e3@xilinx.com \
    --to=michal.simek@xilinx.com \
    --cc=jolly.shah@xilinx.com \
    --cc=kernel@pengutronix.de \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-clk@vger.kernel.org \
    --cc=m.tretter@pengutronix.de \
    --cc=mturquette@baylibre.com \
    --cc=sboyd@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.