Received: by 2002:ab2:3350:0:b0:1f4:6588:b3a7 with SMTP id o16csp2021171lqe; Tue, 9 Apr 2024 07:30:41 -0700 (PDT) X-Forwarded-Encrypted: i=3; AJvYcCWQ1elpX6kWSbknJId4oWfoJc5y47Utpg4sT7c+jIWJwL4RHGLSloOEwqio2Bx563h8EoLb3ktCuVgiTQI+36q1VDmqBV+kcrk3i+lMNA== X-Google-Smtp-Source: AGHT+IEM9mDuHklXzZVfqHg33ifzABftUEiowy6P6heQ8S9JtMSpKJbAu9sxDQ6YtDnfJAOOsM/7 X-Received: by 2002:a50:8acd:0:b0:56b:9b11:9594 with SMTP id k13-20020a508acd000000b0056b9b119594mr9880354edk.2.1712673040877; Tue, 09 Apr 2024 07:30:40 -0700 (PDT) ARC-Seal: i=2; a=rsa-sha256; t=1712673040; cv=pass; d=google.com; s=arc-20160816; b=i1QBRYv6ApA3PxHoNe/UQp+P/+/7qThfCJNLofZZI+cKusuUo0lEulWuZPxDozm+F8 HVvd98i5MM4t2xMg0SA9YohWg77hJbV/ZuBYZj09hs+Svd5feGVzSKxaIoeWZBc6cUGd spG8Vdb9KYlXdbU0VZ4ODMgNV+bPvSTS8URbyksUDO43SMyGXDxCOBxVor3H17PMenDk G1SAl9gHymoEvnFEegmjZuNWfaYHKzffcsvZEnFyDNnwdmT131BFECnavITjAMyWbEG9 m5NouH8d+1GLHwE4C26ctuuMCJ4LTYNcrr763E3aqJRcuI/KOf9bDTwJ5YDTHIqEexWs howg== ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=organization:in-reply-to:content-transfer-encoding :content-disposition:mime-version:list-unsubscribe:list-subscribe :list-id:precedence:references:message-id:subject:cc:to:from:date :dkim-signature; bh=p8uF/66Rs7X3JG7tYudhHKhOf4FxcpEc6CfJq616oJY=; fh=YsAMdgnuUY3htUXSDWCwvGvbokYGDUFm3mzb8bUGn94=; b=ucJN01FCpxSuc9IZRWkQBKPO+rjAX4SlZI7px2P4OltaOpGLzZSlPQl/qWVqK0j9W/ KHk7V94H7z9ofWCBOnjZB2TeLwE8Fx5sP/yCco+RowKfCyJw/nJaCqOGKapKYX9xj2RZ ZbZNzjG7Q9/0/w1ehlZIugXldTGh7nAe1k1yMxi06EmEYu4SSO5NWmmtSABcm+Q/8BFC k646pu/GTC8yrzEoeQbTA101qmSi7ktJHnO8t/pcLOFa0gUvEUuDjAzC0+ElRhF3Yz5s Rje3SxsTddP1RTnYBtGyNPursMlvSVBqICWsfg2DPQAvAMt49kjTA5JZbBkqHgw05cQX 9lvg==; dara=google.com ARC-Authentication-Results: i=2; mx.google.com; dkim=pass header.i=@intel.com header.s=Intel header.b=d8yN6uRp; arc=pass (i=1 dkim=pass dkdomain=intel.com dmarc=pass fromdomain=linux.intel.com); spf=pass (google.com: domain of linux-wireless+bounces-6028-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) smtp.mailfrom="linux-wireless+bounces-6028-linux.lists.archive=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=intel.com Return-Path: Received: from am.mirrors.kernel.org (am.mirrors.kernel.org. [147.75.80.249]) by mx.google.com with ESMTPS id b16-20020a50b410000000b0056e24934908si4737168edh.366.2024.04.09.07.30.40 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 09 Apr 2024 07:30:40 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-wireless+bounces-6028-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) client-ip=147.75.80.249; Authentication-Results: mx.google.com; dkim=pass header.i=@intel.com header.s=Intel header.b=d8yN6uRp; arc=pass (i=1 dkim=pass dkdomain=intel.com dmarc=pass fromdomain=linux.intel.com); spf=pass (google.com: domain of linux-wireless+bounces-6028-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) smtp.mailfrom="linux-wireless+bounces-6028-linux.lists.archive=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=intel.com Received: from smtp.subspace.kernel.org (wormhole.subspace.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by am.mirrors.kernel.org (Postfix) with ESMTPS id 98E351F26048 for ; Tue, 9 Apr 2024 14:30:40 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id 800C61304A5; Tue, 9 Apr 2024 14:29:47 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=intel.com header.i=@intel.com header.b="d8yN6uRp" X-Original-To: linux-wireless@vger.kernel.org Received: from mgamail.intel.com (mgamail.intel.com [198.175.65.14]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id B3A3612FF65; Tue, 9 Apr 2024 14:29:45 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=198.175.65.14 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1712672987; cv=none; b=ghdvR9p67ty3Pc7XsvT+9xOZPnhiKCjW3FTa3DL8FSEsdm8ZCOKbAjISCRb4u+E/9NoWpyCjqVk50CVYMIINPgrusI0car3qwhhaBipI7LO2D7cIQq5qVvCclFWwe9wRtDU6vKn3znfJtiGp0FKv1Q4LrnuttMgywDw03m8MFMQ= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1712672987; c=relaxed/simple; bh=Y8bgT3Mgnddc7ZwsZVd6eKFtCdR1CtVYYgKNg/kledY=; h=Date:From:To:Cc:Subject:Message-ID:References:MIME-Version: Content-Type:Content-Disposition:In-Reply-To; b=tuX75BGY8AHMhLE2BUJYsx2ykucqJmBcwhy35XFGoptpMPy6qsFkx7UdMhEAz6v++5yUtffuvAuss6uXsrk4vUgS4PMtXWrKNNi9QI3StGSbAG5B00Si13WB8T4TcRuYhrvysSPEOviTzWQepE8L4R1Ku2rZVJq81xBHmhvqVfQ= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=linux.intel.com; spf=none smtp.mailfrom=linux.intel.com; dkim=pass (2048-bit key) header.d=intel.com header.i=@intel.com header.b=d8yN6uRp; arc=none smtp.client-ip=198.175.65.14 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=linux.intel.com Authentication-Results: smtp.subspace.kernel.org; spf=none smtp.mailfrom=linux.intel.com DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1712672986; x=1744208986; h=date:from:to:cc:subject:message-id:references: mime-version:content-transfer-encoding:in-reply-to; bh=Y8bgT3Mgnddc7ZwsZVd6eKFtCdR1CtVYYgKNg/kledY=; b=d8yN6uRpFEDkGq0JdMKahnXynTjRli+mmmZ0+jZ57FVKyS+1tcGkYBwu jY2cUbDxGwYNjU7jJYv+651DUf2BIN8rMPZvi3jdFN/QTXqVM5WiUfYFg L+jmPZRo/XuXjWWdI5d4y8fxY41EvI5y++IoBrTZ9UsZJknwGqS1R3pK+ k8p1zQhSxuqrcOwWRtB2wV0WhQSidum2+5F4FS0lgGo3t2MF+AVVUK/bN W4dXic8RFiXAHkC69ChwX30r5ypYixBxaixcOai0M6AXdEBBTPduWd5B/ eY2fdNaSth+lR20Sv5scH56bhvAi4ZAOu3+3USEeM5n6YOmnIO3hlhpAA Q==; X-CSE-ConnectionGUID: jVb3WtQsRyiS3CMtsjHopw== X-CSE-MsgGUID: xKZBwl6LT0Gxggjfikaswg== X-IronPort-AV: E=McAfee;i="6600,9927,11039"; a="11828767" X-IronPort-AV: E=Sophos;i="6.07,189,1708416000"; d="scan'208";a="11828767" Received: from fmsmga002.fm.intel.com ([10.253.24.26]) by orvoesa106.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 09 Apr 2024 07:29:45 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=McAfee;i="6600,9927,11039"; a="915401236" X-IronPort-AV: E=Sophos;i="6.07,189,1708416000"; d="scan'208";a="915401236" Received: from smile.fi.intel.com (HELO smile) ([10.237.72.54]) by fmsmga002.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 09 Apr 2024 07:29:41 -0700 Received: from andy by smile with local (Exim 4.97) (envelope-from ) id 1ruCTi-00000002pQ9-2wX7; Tue, 09 Apr 2024 17:29:38 +0300 Date: Tue, 9 Apr 2024 17:29:38 +0300 From: Andy Shevchenko To: Bartosz Golaszewski Cc: Bartosz Golaszewski , Kent Gibson , Linus Walleij , linux-gpio@vger.kernel.org, linux-acpi@vger.kernel.org, linux-kernel@vger.kernel.org, linux-wireless@vger.kernel.org, brcm80211@lists.linux.dev, brcm80211-dev-list.pdl@broadcom.com, Mika Westerberg , Arend van Spriel , Kalle Valo , Charles Keepax , Randy Dunlap Subject: Re: [PATCH v2 2/2] gpiolib: Update the kernel documentation - add Return sections Message-ID: References: <20240408231727.396452-1-andriy.shevchenko@linux.intel.com> <20240408231727.396452-3-andriy.shevchenko@linux.intel.com> Precedence: bulk X-Mailing-List: linux-wireless@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Disposition: inline Content-Transfer-Encoding: 8bit In-Reply-To: Organization: Intel Finland Oy - BIC 0357606-4 - Westendinkatu 7, 02160 Espoo On Tue, Apr 09, 2024 at 04:18:46PM +0200, Bartosz Golaszewski wrote: > On Tue, Apr 9, 2024 at 4:06 PM Andy Shevchenko > wrote: > > On Tue, Apr 09, 2024 at 04:01:43PM +0200, Bartosz Golaszewski wrote: > > > On Tue, Apr 9, 2024 at 2:52 PM Andy Shevchenko > > > wrote: > > > > On Tue, Apr 09, 2024 at 02:12:51AM +0300, Andy Shevchenko wrote: > > > > > $ scripts/kernel-doc -v -none -Wall drivers/gpio/gpiolib* 2>&1 | grep -w warning | wc -l > > > > > 67 > > > > > > > > > > Fix these by adding Return sections. While at it, make sure all of > > > > > Return sections use the same style. > > > > > > > > Since there shouldn't be hard dependency to the first one, can you consider > > > > applying this one, so it unblocks me? > > > > > > I'm not sure what the resolution is for % and HTML tags in the end? > > > > Most of the constants are without %, so less churn now is to drop %. > > If you think otherwise, please, fix it and I will rebase my patches later. > > > > I'm not sure I get the logic of it. If the kernel-wide standard is to > use %, then we should work towards using it across the GPIO code even > if we do it a few lines at a time instead of going backwards just for > consistency in drivers/gpio/, no? We don't need to fix everything now > but if you're touching this code, then I'd go with %. > > Also: what about the s/error-code/error code/g issue? While we should > always say "active-low", I think error code looks better as two words. I also have no much time for these details. :( Let's drop this series then. Feel free to consider this as a problem report. -- With Best Regards, Andy Shevchenko