From patchwork Fri Dec 15 15:03:41 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Andy Shevchenko X-Patchwork-Id: 179366 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7300:3b04:b0:fb:cd0c:d3e with SMTP id c4csp9346899dys; Fri, 15 Dec 2023 07:12:56 -0800 (PST) X-Google-Smtp-Source: AGHT+IFTVDTY8f6RiPm+Czp7SSD8h/VfiPnvGV2uwqqzimC/92xQUo2HRhfMSwthsSpoR7c2zd5Q X-Received: by 2002:a05:622a:14c6:b0:425:9e97:b1c6 with SMTP id u6-20020a05622a14c600b004259e97b1c6mr15460153qtx.35.1702653175965; Fri, 15 Dec 2023 07:12:55 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1702653175; cv=none; d=google.com; s=arc-20160816; b=1DGrsNlgfJEiPQFQGIKDN7au4cAwn7QP7mpUpdFY8CCqxIP94uebOHWYrISLRtk8IF 8G3zMV0rCc+lu8aRPTOlIPO6oBNBaoGeS5heKopwdSXwogt9zsbmXOeITPS23dlMkAtn Ad+n0ORGqhX/FNmUnEWaUJWpPBOKJx08KegHqeJlW1T/xdpAogIqTGnBmQZ0ZEEEgEEc DExt1d2phY+TCdUNFQMXe5VlDTsRcnUVHZosgqPcZsoO7kNMAEa0juwjrroDlCHzlJ1O Fo8VxprqFVRLHMOhyzrZ+v/M4XdtG0OTKKzlZPjdhvpRQ7AxcJrfIIDhE5M6ZHbwsyrA 5k9A== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=content-transfer-encoding:mime-version:list-unsubscribe :list-subscribe:list-id:precedence:message-id:date:subject:cc:to :from:dkim-signature; bh=5jAjXJ0OEDXqQUla2CokNkgGILgNk1BYp9m41QrlCJ0=; fh=zliqKv8U3JpkEUIqQckOa+tjgJJrTgJ9RVgc1ZlE7Ws=; b=j3Bh+zbuZTD6+8KwhOFP5xOfhJ0GBO/cOgoWyi09lXvcyCsk/MKI4YAPFKs8zibo4s wwEwNygJGdgG5AQ2LKGC/+mFoNE50+28WKmqw9dUvdm/P+9kNRr/hdeeJgMNT3P9URCB f59cbfhAdg7sIpN+8TZLIGlmfJQ573nEqTbW4S9I/RDGRZN+DwozLbetJs/CJfWQrziL ipvpGT/JqaVRflLl7/BYLE6lFtdiG4pPh9UBmnE3PMao6IYoo23SqPn42s7dFxYfOiYJ Huwlk4HfAoFQoxyPkd/jemeNNl4EpLD+tBVzWaUM68aUtDlnA+Qa50SuW394C05xGs/z acHw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@intel.com header.s=Intel header.b=ePVwHCVA; spf=pass (google.com: domain of linux-kernel+bounces-1177-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) smtp.mailfrom="linux-kernel+bounces-1177-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=intel.com Received: from ny.mirrors.kernel.org (ny.mirrors.kernel.org. [147.75.199.223]) by mx.google.com with ESMTPS id w16-20020ac87e90000000b00425bf805d54si14282056qtj.199.2023.12.15.07.12.55 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 15 Dec 2023 07:12:55 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-1177-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) client-ip=147.75.199.223; Authentication-Results: mx.google.com; dkim=pass header.i=@intel.com header.s=Intel header.b=ePVwHCVA; spf=pass (google.com: domain of linux-kernel+bounces-1177-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) smtp.mailfrom="linux-kernel+bounces-1177-ouuuleilei=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 ny.mirrors.kernel.org (Postfix) with ESMTPS id B85A71C235A4 for ; Fri, 15 Dec 2023 15:12:55 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id B06354186F; Fri, 15 Dec 2023 15:09:32 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=intel.com header.i=@intel.com header.b="ePVwHCVA" X-Original-To: linux-kernel@vger.kernel.org Received: from mgamail.intel.com (mgamail.intel.com [198.175.65.10]) (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 489223C48F; Fri, 15 Dec 2023 15:09:28 +0000 (UTC) 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=1702652969; x=1734188969; h=from:to:cc:subject:date:message-id:mime-version: content-transfer-encoding; bh=ah5mzgotn1mPGg5+aEZRvveESjmnNIS1QhgQDAZlBqY=; b=ePVwHCVAywfcZTOQXZdE7ctsjLicO3OXwnleNM8OnqunfghDjylmwycY 4aHt6FY/DS+fUKAMZaBe6uaEhU07G/a7fdoVbusT8PK0BDOstFkLggHK3 AxoW9nKps6Z1Nf11Vyf3Y0d9NeTG0gJ4tM9aO8FDJWq9Z0ESIOSLdviub 6wptZ8G7c17xxlG9xXMYiiENHvhq4ZUj5YzYJtynbosstx2xLRZM79JqM UpVBq6TbRwclQlr2oT2p3haZYdcW4BAkkLp7ycIsVarEJygpq70Mnj0VN ACPlkt9XJKtwPljFBk3gVSL9vuCOpHXKtMC3VC5914iDYiHc0fWG7EIqg Q==; X-IronPort-AV: E=McAfee;i="6600,9927,10924"; a="8645043" X-IronPort-AV: E=Sophos;i="6.04,279,1695711600"; d="scan'208";a="8645043" Received: from fmsmga008.fm.intel.com ([10.253.24.58]) by orvoesa102.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 15 Dec 2023 07:09:27 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=McAfee;i="6600,9927,10924"; a="840691616" X-IronPort-AV: E=Sophos;i="6.04,279,1695711600"; d="scan'208";a="840691616" Received: from black.fi.intel.com ([10.237.72.28]) by fmsmga008.fm.intel.com with ESMTP; 15 Dec 2023 07:09:23 -0800 Received: by black.fi.intel.com (Postfix, from userid 1003) id 0CD6A3A3; Fri, 15 Dec 2023 17:03:42 +0200 (EET) From: Andy Shevchenko To: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org Cc: Jonathan Corbet , Andy Shevchenko Subject: [PATCH v1 1/1] kernel-doc: Aling quick help and the code Date: Fri, 15 Dec 2023 17:03:41 +0200 Message-ID: <20231215150341.1996720-1-andriy.shevchenko@linux.intel.com> X-Mailer: git-send-email 2.43.0.rc1.1.gbec44491f096 Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1785361256986091279 X-GMAIL-MSGID: 1785361256986091279 The update to the quick help mentions -Wshort-description, but code never supported for that. Align that with the code by allowing both: -Wshort-description and -Wshort-desc. Fixes: 56b0f453db74 ("kernel-doc: don't let V=1 change outcome") Signed-off-by: Andy Shevchenko Reviewed-by: Randy Dunlap --- scripts/kernel-doc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/scripts/kernel-doc b/scripts/kernel-doc index 0a890fe4d22b..7d7ed3e43946 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc @@ -23,7 +23,7 @@ kernel-doc - Print formatted kernel documentation to stdout =head1 SYNOPSIS - kernel-doc [-h] [-v] [-Werror] [-Wall] [-Wreturn] [-Wshort-description] [-Wcontents-before-sections] + kernel-doc [-h] [-v] [-Werror] [-Wall] [-Wreturn] [-Wshort-desc[ription]] [-Wcontents-before-sections] [ -man | -rst [-sphinx-version VERSION] [-enable-lineno] | -none @@ -328,7 +328,7 @@ while ($ARGV[0] =~ m/^--?(.*)/) { $Werror = 1; } elsif ($cmd eq "Wreturn") { $Wreturn = 1; - } elsif ($cmd eq "Wshort-desc") { + } elsif ($cmd eq "Wshort-desc" or $cmd eq "Wshort-description") { $Wshort_desc = 1; } elsif ($cmd eq "Wcontents-before-sections") { $Wcontents_before_sections = 1;