From patchwork Thu Apr 2 21:40:35 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Sergei Shtylyov X-Patchwork-Id: 1265823 X-Patchwork-Delegate: tudor.ambarus@gmail.com Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=none (no SPF record) smtp.mailfrom=lists.infradead.org (client-ip=2607:7c80:54:e::133; helo=bombadil.infradead.org; envelope-from=linux-mtd-bounces+incoming=patchwork.ozlabs.org@lists.infradead.org; receiver=) Authentication-Results: ozlabs.org; dmarc=none (p=none dis=none) header.from=cogentembedded.com Authentication-Results: ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=lists.infradead.org header.i=@lists.infradead.org header.a=rsa-sha256 header.s=bombadil.20170209 header.b=tD5jgt4r; dkim=fail reason="signature verification failed" (2048-bit key; unprotected) header.d=cogentembedded-com.20150623.gappssmtp.com header.i=@cogentembedded-com.20150623.gappssmtp.com header.a=rsa-sha256 header.s=20150623 header.b=eqU3dX42; dkim-atps=neutral Received: from bombadil.infradead.org (bombadil.infradead.org [IPv6:2607:7c80:54:e::133]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 48tc2B6VNsz9sRf for ; Fri, 3 Apr 2020 08:41:04 +1100 (AEDT) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20170209; h=Sender: Content-Transfer-Encoding:Content-Type:Cc:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:In-Reply-To:MIME-Version:Date: Message-ID:References:To:From:Subject:Reply-To:Content-ID:Content-Description :Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID: List-Owner; bh=s9nmnfr0wZey45u+Z8iQOK6AFx/iazHgySXyaC/v8mw=; b=tD5jgt4rZAvmRr bF/YoZQrapfEBwrKGkZB+emT/Ryiuciqrjy+zQ43zXLiM3341Ow5g8898w7CbJB4HwdTzqXCi7Tp0 zu3FBisqAZ2K8tR7/fHmy1N2K38pfE/3Sc/l3dQtOWGncCDizeoUdrG6xd3IoXBohKx9WkbEYQnIj rEXD35T3aj9KhwV2Wk/jvjH7W8CkRgLhOh+OJ3OkWNEqjCRLBGr4w2azx69GhY+faKtbmfHdO61fa 7hgddlKrqf9sSDgCVpaA4sWb2Hl0d5dZPmWM+wvlVLWvrEUKM2AGwJGawseFrcXPxcnWLh+avXk6g eYAx0cswdKCGYu0CHJNA==; Received: from localhost ([127.0.0.1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1jK7Zp-0000pQ-OI; Thu, 02 Apr 2020 21:40:41 +0000 Received: from mail-lf1-x144.google.com ([2a00:1450:4864:20::144]) by bombadil.infradead.org with esmtps (Exim 4.92.3 #3 (Red Hat Linux)) id 1jK7Zn-0000oy-Gc for linux-mtd@lists.infradead.org; Thu, 02 Apr 2020 21:40:40 +0000 Received: by mail-lf1-x144.google.com with SMTP id n20so4005919lfl.10 for ; Thu, 02 Apr 2020 14:40:39 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=cogentembedded-com.20150623.gappssmtp.com; s=20150623; h=subject:from:to:cc:references:organization:message-id:date :user-agent:mime-version:in-reply-to:content-language :content-transfer-encoding; bh=+slmtley1jCXhKQLgxF5IMEzSagvlN4ByObQY1GK57A=; b=eqU3dX42VpGBcdgP7uwk9ozTxy8fUQWdYmBOSmTO23pLQ5IfRi1c3iewJ2Kwez0rns QOJL9YntGagKE3fd/ZCcuYpvM4u9rz0RzHf52bTCRTRIDziUce8OMaGI5pRjsxrpt39Q SW/RLwPOv+/dHls94is/UiIGHDLN8tN8xju4HJEYPTwdzK60X/KT0xc3ErY5KLD8wb5F /aIIXdfkmDiiglZmfMbX1a/6cim1+EQIQdnCw6xshg7FmHDHOVSFjI/Dv4az/3VUl+Sy wgCguYhfCSTsfgVuxUn/KpQSzmlsUH48sRprAdD9FWBT1k+U/bkbOpBmdXJyJZu/8FPh uu/A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:subject:from:to:cc:references:organization :message-id:date:user-agent:mime-version:in-reply-to :content-language:content-transfer-encoding; bh=+slmtley1jCXhKQLgxF5IMEzSagvlN4ByObQY1GK57A=; b=o3mmehJn7r5mpOehLfqzhro6Ni4hezgPeLThpApW40bLsCP1WCtWL9LHnu1PPDo0r7 zH/23CTLasiJRyvEPHinFd0PxsL+cP2tsNeob0jg6gG+1TpJSVWIhzkLavPmh8NaGO40 7+dM9VF9kvcuFV4i1Gh3VsyT4jeY7uaYE6Vld95iywmnYyqSlbJ2NBlMVzA85kai6Vwq 4D12gi4COWkogO2EVDT8wOY7CdRcEDDnhRDa7RyntO5IeFbhPmr+8MNLKLiv1Z0hVCy4 gmwsI9odnT9YKB6FmCkeeIorwUuxD4nLNkC9siabstMYQCnOpQLHIWAbW6rn8luFfvU5 oEQg== X-Gm-Message-State: AGi0PubW7KijXd9pKQEzSG6VW4JZNvugElmPUZMe8eofRQPSSnHkeOHZ UjmkzK3F/R9nGHhhlbSoFa9v2Rq2uPQ= X-Google-Smtp-Source: APiQypII6pyT3pOCRNF8KHKGjBsE1Y/NF5pUoUqX5liT3ODCw+u2ilbBOPub/NscA5g0ZB09GqOpTQ== X-Received: by 2002:a19:cb41:: with SMTP id b62mr3405932lfg.21.1585863637620; Thu, 02 Apr 2020 14:40:37 -0700 (PDT) Received: from wasted.cogentembedded.com ([2a00:1fa0:638:9d01:50cb:2c0c:a09a:3ff3]) by smtp.gmail.com with ESMTPSA id d2sm4592454lfj.67.2020.04.02.14.40.36 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Thu, 02 Apr 2020 14:40:37 -0700 (PDT) Subject: [PATCH 1/5] mtd: spi-nor: fix kernel-doc for 'struct spi_nor' From: Sergei Shtylyov To: Tudor Ambarus , "linux-mtd@lists.infradead.org" References: Organization: Cogent Embedded Message-ID: Date: Fri, 3 Apr 2020 00:40:35 +0300 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101 Thunderbird/52.2.1 MIME-Version: 1.0 In-Reply-To: Content-Language: en-MW X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20200402_144039_553699_4A78D8D9 X-CRM114-Status: GOOD ( 14.26 ) X-Spam-Score: 0.0 (/) X-Spam-Report: SpamAssassin version 3.4.4 on bombadil.infradead.org summary: Content analysis details: (0.0 points) pts rule name description ---- ---------------------- -------------------------------------------------- -0.0 RCVD_IN_DNSWL_NONE RBL: Sender listed at https://www.dnswl.org/, no trust [2a00:1450:4864:20:0:0:0:144 listed in] [list.dnswl.org] -0.0 SPF_PASS SPF: sender matches SPF record 0.0 SPF_HELO_NONE SPF: HELO does not publish an SPF Record 0.1 DKIM_SIGNED Message has a DKIM or DK signature, not necessarily valid -0.1 DKIM_VALID Message has at least one valid DKIM or DK signature X-BeenThere: linux-mtd@lists.infradead.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Linux MTD discussion mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Richard Weinberger , Vignesh Raghavendra , Miquel Raynal Sender: "linux-mtd" Errors-To: linux-mtd-bounces+incoming=patchwork.ozlabs.org@lists.infradead.org When introducing 'struct spi_nor', a number of issues was added in its kernel-doc comment: - double article in the heading kernel-doc comment; - "point" instead of "pointer" for the 'mtd' and 'dev' fields; - "a" articles instead of "an" for the 'dev' field; - acronyms in the lower case for the 'dev' field; - missing "pointer to" for the 'priv' field. Fix all of those at once... Fixes: 6e602ef73334 ("mtd: spi-nor: add the basic data structures") Signed-off-by: Sergei Shtylyov --- include/linux/mtd/spi-nor.h | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) Index: linux/include/linux/mtd/spi-nor.h =================================================================== --- linux.orig/include/linux/mtd/spi-nor.h +++ linux/include/linux/mtd/spi-nor.h @@ -327,10 +327,10 @@ struct spi_nor_manufacturer; struct spi_nor_flash_parameter; /** - * struct spi_nor - Structure for defining a the SPI NOR layer - * @mtd: point to a mtd_info structure + * struct spi_nor - Structure for defining the SPI NOR layer + * @mtd: pointer to an mtd_info structure * @lock: the lock for the read/write/erase/lock/unlock operations - * @dev: point to a spi device, or a spi nor controller device. + * @dev: pointer to an SPI device or an SPI NOR controller device * @spimem: point to the spi mem device * @bouncebuf: bounce buffer used when the buffer passed by the MTD * layer is not DMA-able @@ -354,7 +354,7 @@ struct spi_nor_flash_parameter; * settings that can be overwritten by the spi_nor_fixups * hooks, or dynamically when parsing the SFDP tables. * @dirmap: pointers to struct spi_mem_dirmap_desc for reads/writes. - * @priv: the private data + * @priv: pointer to the private data */ struct spi_nor { struct mtd_info mtd;