Received: by 10.192.165.148 with SMTP id m20csp2880317imm; Mon, 7 May 2018 02:47:20 -0700 (PDT) X-Google-Smtp-Source: AB8JxZpGszz3ZZAzF8cDSU740jnfqSsqS9C+AnKPVFeIy3BQAYAG+ttc1yDhDc3IBhgoqts3r5oo X-Received: by 2002:a17:902:680e:: with SMTP id h14-v6mr36503416plk.90.1525686440257; Mon, 07 May 2018 02:47:20 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1525686440; cv=none; d=google.com; s=arc-20160816; b=EDHFMukiAvfn3MnLU8NPXYlvFrgde14JZl5iq1+SfNiE2xlpYNIGiqX99P6r4O/VAM MNTfN/y1UtqdjmPg5dYBa213R/jkARo4Msh5YIuvKm5kYCzhjxWMoHm6w8Hyb88NB2aH B7RjwbBIhMgAtyLssI472k1DeYe8WZk5kXt6XM+fySeI/cHee4dm6ZKPZ885okgYvoFr ZSghTpBpci9AtNXUcauGbsMFfOjZspgBbKRtys0d2sD2pCDDMMwvFUE6HfcvqyWnnDNg c1oiPE2vgmMOExxgWI4r9eUHY1hN6uZ0R1kTp2hh07Y2ynm4e5EvfcI0g3ns9gn7SyMN eBmA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:content-transfer-encoding:mime-version :references:in-reply-to:message-id:subject:cc:to:from:date :arc-authentication-results; bh=cN8XQ3JoamenQD01sVWOa1E0gdjPKOS/3dunZa2ocbc=; b=ogFy99/6t7bz5uD3jWd+HWFRQtSCmCy/IcfH+zXZnda2jrWUD7Q6AjW3NWd2xpM7iN TLplQkRpHMHshGm9DWHVvlotDWdFVRkECTWlZS3xyNEV/k404y7mOmSAH5SStb2E8xw6 NQNIHRYUzj1NQ4qoeVj3T+U0nPSVsqMBT9ef4v9XlJfG0nE2J9HlA5tsW4p9ac3DMXtf Cli0mCUTYVo2kMwWdjPXZPfT4BOsPmVWWvlG6rv3KJDwD9LSJQBq1muowsaxnOWgTNe+ HquryC0wikoFQ1uJIItUcZsLYewzOEepM05kIW2Xe1Jzj/1gUfCWpEgqb+9AuixUYCW1 tQ/Q== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id m9-v6si17665070pgn.665.2018.05.07.02.47.04; Mon, 07 May 2018 02:47:20 -0700 (PDT) Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67; Authentication-Results: mx.google.com; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751932AbeEGJqy (ORCPT + 99 others); Mon, 7 May 2018 05:46:54 -0400 Received: from mail.bootlin.com ([62.4.15.54]:47651 "EHLO mail.bootlin.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751147AbeEGJqx (ORCPT ); Mon, 7 May 2018 05:46:53 -0400 Received: by mail.bootlin.com (Postfix, from userid 110) id CE34720705; Mon, 7 May 2018 11:46:50 +0200 (CEST) X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on mail.bootlin.com X-Spam-Level: X-Spam-Status: No, score=-1.0 required=5.0 tests=ALL_TRUSTED,SHORTCIRCUIT shortcircuit=ham autolearn=disabled version=3.4.0 Received: from bbrezillon (LStLambert-657-1-97-87.w90-63.abo.wanadoo.fr [90.63.216.87]) by mail.bootlin.com (Postfix) with ESMTPSA id 7059120376; Mon, 7 May 2018 11:46:50 +0200 (CEST) Date: Mon, 7 May 2018 11:46:50 +0200 From: Boris Brezillon To: Mauro Carvalho Chehab Cc: Linux Doc Mailing List , Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, Jonathan Corbet , Richard Weinberger , David Woodhouse , Brian Norris , Marek Vasut , linux-mtd@lists.infradead.org Subject: Re: [PATCH 16/18] mtd: rawnand.h: use nested union kernel-doc markups Message-ID: <20180507114650.171edcc2@bbrezillon> In-Reply-To: <39d8d4f0e0ff5a06be0303f7f4f2eac5fb45b9ca.1525684985.git.mchehab+samsung@kernel.org> References: <39d8d4f0e0ff5a06be0303f7f4f2eac5fb45b9ca.1525684985.git.mchehab+samsung@kernel.org> X-Mailer: Claws Mail 3.15.0-dirty (GTK+ 2.24.31; x86_64-pc-linux-gnu) MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Hi Mauro, On Mon, 7 May 2018 06:35:52 -0300 Mauro Carvalho Chehab wrote: > Gets rid of those warnings and better document the parameters. > > ./include/linux/mtd/rawnand.h:752: warning: Function parameter or member 'timings.sdr' not described in 'nand_data_interface' > ./include/linux/mtd/rawnand.h:817: warning: Function parameter or member 'buf' not described in 'nand_op_data_instr' > ./include/linux/mtd/rawnand.h:817: warning: Function parameter or member 'buf.in' not described in 'nand_op_data_instr' > ./include/linux/mtd/rawnand.h:817: warning: Function parameter or member 'buf.out' not described in 'nand_op_data_instr' > ./include/linux/mtd/rawnand.h:863: warning: Function parameter or member 'ctx' not described in 'nand_op_instr' > ./include/linux/mtd/rawnand.h:863: warning: Function parameter or member 'ctx.cmd' not described in 'nand_op_instr' > ./include/linux/mtd/rawnand.h:863: warning: Function parameter or member 'ctx.addr' not described in 'nand_op_instr' > ./include/linux/mtd/rawnand.h:863: warning: Function parameter or member 'ctx.data' not described in 'nand_op_instr' > ./include/linux/mtd/rawnand.h:863: warning: Function parameter or member 'ctx.waitrdy' not described in 'nand_op_instr' > ./include/linux/mtd/rawnand.h:1010: warning: Function parameter or member 'ctx' not described in 'nand_op_parser_pattern_elem' > ./include/linux/mtd/rawnand.h:1010: warning: Function parameter or member 'ctx.addr' not described in 'nand_op_parser_pattern_elem' > ./include/linux/mtd/rawnand.h:1010: warning: Function parameter or member 'ctx.data' not described in 'nand_op_parser_pattern_elem' > ./include/linux/mtd/rawnand.h:1313: warning: Function parameter or member 'manufacturer.desc' not described in 'nand_chip' > ./include/linux/mtd/rawnand.h:1313: warning: Function parameter or member 'manufacturer.priv' not described in 'nand_chip' > > ./include/linux/mtd/rawnand.h:848: WARNING: Unexpected indentation. > > Signed-off-by: Mauro Carvalho Chehab > --- > include/linux/mtd/rawnand.h | 26 ++++++++++++++++++-------- > 1 file changed, 18 insertions(+), 8 deletions(-) > > diff --git a/include/linux/mtd/rawnand.h b/include/linux/mtd/rawnand.h > index 5dad59b31244..b986f94906df 100644 > --- a/include/linux/mtd/rawnand.h > +++ b/include/linux/mtd/rawnand.h > @@ -740,8 +740,9 @@ enum nand_data_interface_type { > > /** > * struct nand_data_interface - NAND interface timing > - * @type: type of the timing > - * @timings: The timing, type according to @type > + * @type: type of the timing > + * @timings: The timing, type according to @type > + * @timings.sdr: Use it when @type is %NAND_SDR_IFACE. Hm, really feels weird to do that. I mean, either we describe timings.sdr or timings, but not both. I this case, I agree that describing timings.sdr would make more sense than generically describing any possible entries in the timings union. Is there a simple way we can get rid of the warning we have when not describing timings but all of its fields? > */ > struct nand_data_interface { > enum nand_data_interface_type type; > @@ -798,8 +799,9 @@ struct nand_op_addr_instr { > /** > * struct nand_op_data_instr - Definition of a data instruction > * @len: number of data bytes to move > - * @in: buffer to fill when reading from the NAND chip > - * @out: buffer to read from when writing to the NAND chip > + * @buf: buffer to fill > + * @buf.in: buffer to fill when reading from the NAND chip > + * @buf.out: buffer to read from when writing to the NAND chip Same here. What we care about is @buf.in and @buf.out, the @buf description is useless... Regards, Boris