From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-5.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI, SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED autolearn=no autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id E3D98C07E94 for ; Fri, 4 Jun 2021 08:47:18 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id C5F3A61208 for ; Fri, 4 Jun 2021 08:47:18 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230127AbhFDItD (ORCPT ); Fri, 4 Jun 2021 04:49:03 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:57382 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230002AbhFDItD (ORCPT ); Fri, 4 Jun 2021 04:49:03 -0400 Received: from mail-wm1-x330.google.com (mail-wm1-x330.google.com [IPv6:2a00:1450:4864:20::330]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id BDC80C061761 for ; Fri, 4 Jun 2021 01:47:17 -0700 (PDT) Received: by mail-wm1-x330.google.com with SMTP id o2-20020a05600c4fc2b029019a0a8f959dso5165886wmq.1 for ; Fri, 04 Jun 2021 01:47:17 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=date:from:to:subject:message-id:references:mime-version :content-disposition:content-transfer-encoding:in-reply-to; bh=/FKlwDtg6Z1tlii4rMQLDyghNbnnLvKNz1TIQNqgqBo=; b=EgM8YszLM1vgbYmSMkftvJOnA8yDgD3REicNnHyLOne3FfUvpjhdm9SIsHD9aFcMgt xaP55nQ6/rSU2Ej4bNklexIgjA1wMRgcthYfWN/JaG5e3J4K7Qexm+Ukk2JmkV+LsUHY vN92j0ZiC8y1Xb7HXayIaop7mZ01lN8JMMOWB0PTQ9pqqsOFBpN099CP+KZAG33lgjvZ Yqtkl2hNRcwZg02Q/tpcIwxlUKQ4Y9E7sIV03AJIlU0cER48bwC5lBiM4MaQLJhAWoNs nmpHmG1tQwK6Q9S9/G32qlAwheHPSOn6+Lli+NFa+agRSJdtCh/Dmr/R9s9BSIv/G3Is RX3Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:subject:message-id:references :mime-version:content-disposition:content-transfer-encoding :in-reply-to; bh=/FKlwDtg6Z1tlii4rMQLDyghNbnnLvKNz1TIQNqgqBo=; b=gOxMYRRHG1xD3xNYU53XDHRVlm3IGwxq+gzMH+gf1i2/c97GGtVPRKgZw5hHDYex6a rKm6XuVI1U9NxeiXDWn0/5ITtlAg3jIfmcx68QZZu+KHo93Wu1vAm5VpLejf+JSRz+jv 6/NJzGBaYWSQyu9mQOmgN2vYiAusgULPqpTdLJhigkJFvBAvO4K2YdELn+CehlHRgPrx fkOoCYM0U4v2fcK0qf9gosNo8TCozCM1joLxbB8Vqud8q5AOCS1Eoeqvkkv62mpz8QKs ac4gWojCjMRb1sf/KJORFxL6ia11vF6Hn/3CMRj4JhTuibEDwhK88V43MX8lejYQaN56 McFQ== X-Gm-Message-State: AOAM5335NSqDYCvym+mEgxSAIIcuoDelznwFdF2OyOQLTfc5wOLvFGlA rw8bvCXCZ9IEFUKE7ZUl7u4VVg== X-Google-Smtp-Source: ABdhPJwyERrKS1FbST/ERIbVBsDwXBv3+isYP3qFsmwNsAz+46MuX7tv4ih6HnPItANwBpX/1os3ow== X-Received: by 2002:a7b:c749:: with SMTP id w9mr2480723wmk.3.1622796434560; Fri, 04 Jun 2021 01:47:14 -0700 (PDT) Received: from dell ([91.110.221.214]) by smtp.gmail.com with ESMTPSA id o22sm7801640wmc.17.2021.06.04.01.47.13 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 04 Jun 2021 01:47:14 -0700 (PDT) Date: Fri, 4 Jun 2021 09:47:10 +0100 From: Lee Jones To: Wolfram Sang , linux-kernel@vger.kernel.org, Shawn Guo , Sascha Hauer , Pengutronix Kernel Team , Fabio Estevam , NXP Linux Team , Marek Vasut , linux-i2c@vger.kernel.org, linux-arm-kernel@lists.infradead.org Subject: Re: [PATCH 09/16] i2c: busses: i2c-mxs: Demote barely half complete kernel-doc header Message-ID: <20210604084710.GG2435141@dell> References: <20210520190105.3772683-1-lee.jones@linaro.org> <20210520190105.3772683-10-lee.jones@linaro.org> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Disposition: inline Content-Transfer-Encoding: 8bit In-Reply-To: Precedence: bulk List-ID: X-Mailing-List: linux-i2c@vger.kernel.org On Thu, 03 Jun 2021, Wolfram Sang wrote: > On Thu, May 20, 2021 at 08:00:58PM +0100, Lee Jones wrote: > > Fixes the following W=1 kernel build warning(s): > > > > drivers/i2c/busses/i2c-mxs.c:131: warning: Function parameter or member 'timing0' not described in 'mxs_i2c_dev' > > drivers/i2c/busses/i2c-mxs.c:131: warning: Function parameter or member 'timing1' not described in 'mxs_i2c_dev' > > drivers/i2c/busses/i2c-mxs.c:131: warning: Function parameter or member 'timing2' not described in 'mxs_i2c_dev' > > drivers/i2c/busses/i2c-mxs.c:131: warning: Function parameter or member 'dmach' not described in 'mxs_i2c_dev' > > drivers/i2c/busses/i2c-mxs.c:131: warning: Function parameter or member 'pio_data' not described in 'mxs_i2c_dev' > > drivers/i2c/busses/i2c-mxs.c:131: warning: Function parameter or member 'addr_data' not described in 'mxs_i2c_dev' > > drivers/i2c/busses/i2c-mxs.c:131: warning: Function parameter or member 'sg_io' not described in 'mxs_i2c_dev' > > drivers/i2c/busses/i2c-mxs.c:131: warning: Function parameter or member 'dma_read' not described in 'mxs_i2c_dev' > > Disabling kernel-doc works around, does not really fix, or? You're right. With cases of genuine oversight or a bit of doc-rot, I tend to help where I can. However issues such as these where documentation has been either severely neglected or half-arsed require either the author or another knowledgeable person so provide fix-ups in the way of additional quality descriptions. IMHO, we wouldn't want to foster the impression that it's okay to provide a non-determined effort, safe in the knowledge that someone will come along later and finish the job for them at a later date. -- Lee Jones [李琼斯] Senior Technical Lead - Developer Services Linaro.org │ Open source software for Arm SoCs Follow Linaro: Facebook | Twitter | Blog