From patchwork Wed Nov 13 06:34:23 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: anish kumar X-Patchwork-Id: 13873201 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id D8CD2D41C08 for ; Wed, 13 Nov 2024 06:42:39 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 3EFA26B00A4; Wed, 13 Nov 2024 01:42:39 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 39D8E6B00B5; Wed, 13 Nov 2024 01:42:39 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 23F076B00B7; Wed, 13 Nov 2024 01:42:39 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0013.hostedemail.com [216.40.44.13]) by kanga.kvack.org (Postfix) with ESMTP id 0575D6B00B5 for ; Wed, 13 Nov 2024 01:42:38 -0500 (EST) Received: from smtpin12.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay07.hostedemail.com (Postfix) with ESMTP id A13D716084C for ; Wed, 13 Nov 2024 06:42:38 +0000 (UTC) X-FDA: 82780127178.12.73935A9 Received: from mail-il1-f174.google.com (mail-il1-f174.google.com [209.85.166.174]) by imf08.hostedemail.com (Postfix) with ESMTP id 9B512160006 for ; Wed, 13 Nov 2024 06:42:08 +0000 (UTC) Authentication-Results: imf08.hostedemail.com; dkim=pass header.d=gmail.com header.s=20230601 header.b=IP3OIK0M; spf=pass (imf08.hostedemail.com: domain of yesanishhere@gmail.com designates 209.85.166.174 as permitted sender) smtp.mailfrom=yesanishhere@gmail.com; dmarc=pass (policy=none) header.from=gmail.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1731479922; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-transfer-encoding:content-transfer-encoding: in-reply-to:references:dkim-signature; bh=dvjRZrGcOUQW5mqy7FIUkoTS+9pLckU9+BVxZZoa7DQ=; b=iIb3h0jFAIB4T93x8Mt6nUyW4ghqJrKxK3jkMQJhqRl2aKY8jJn5No4bZSNSsHUW+Y5TO3 BRRivIRo/8Ike6M4VO86YHhodEiLNs0fCYtjAFkrYT6KYcDl1Cq8Ck7kLLrWef+uLu5yf/ QRtJn5rc98BX8Ho6TdFLOL4PY40TqOs= ARC-Authentication-Results: i=1; imf08.hostedemail.com; dkim=pass header.d=gmail.com header.s=20230601 header.b=IP3OIK0M; spf=pass (imf08.hostedemail.com: domain of yesanishhere@gmail.com designates 209.85.166.174 as permitted sender) smtp.mailfrom=yesanishhere@gmail.com; dmarc=pass (policy=none) header.from=gmail.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1731479922; a=rsa-sha256; cv=none; b=unM5GeVXgHNExZ2ijdJoI98oOnMR1RONdX9rk5uKtDM+G6uAyPRCShAEyyoaBJCbYLM3e2 Izu9bobUHOnHTYu2Tzu6HYfHRI4sCQbFLMhbM9EqdQO6ti5OMcYl0uyqkqy6ut//eXT89l R5DkfbHFkdsIfvks7PtqNaBVR1OeIrI= Received: by mail-il1-f174.google.com with SMTP id e9e14a558f8ab-3a4e5a7b026so23196205ab.3 for ; Tue, 12 Nov 2024 22:42:36 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1731480156; x=1732084956; darn=kvack.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=dvjRZrGcOUQW5mqy7FIUkoTS+9pLckU9+BVxZZoa7DQ=; b=IP3OIK0MasLRySLfI8Q3KnIxw6vLcgW6uueqtVwfHR+cgz3XeTqly3UNpyii+YcazO iNA8xynLc2i56UziX3e9DHd8ftaRHOSoccs7YayZz84L9XLlBYFQI5/ZKsEczYzEwQSJ IdO5HgZKjT32cL5h679GcjWLaiEpybQpfBMVyBwP4bT8yQ67b64ekPTuT5XAKpEulBJX 6aMGgOd9bLdCwOYyHbzVK5IL4Tjkuq/ZrMnzwG4u060MRzt8/uwDQP74FO8WnxSd+afE 6VTuK0mVfQtIEstoKNdnZhOzGC7dZcUvVa51bE/Z7MHa4eEDB5nFszh06y8rfvB0/cBq rsjg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1731480156; x=1732084956; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=dvjRZrGcOUQW5mqy7FIUkoTS+9pLckU9+BVxZZoa7DQ=; b=Sr5gbDoJ9Reix2gY2ET9pRsvW1smMysGAsfvopHNEXpW/0HWvb0g+m7za6Dc0dOC4R hUoy9SQxJibnT9yept7oyRP8EkYS8g2IFZ4WwsX4UR/7LrbfNwJNwZwnNfMRZvpM+NEp 16Us+9/fbpnWkSaOt2MTpfuzfjaDVg/9WQjch4F/9OHqS3r8OzOKJ/fB4TzOJFElV0/D /CPKvF/CXqcW23I0KCarG7KjfN1GSWLyKExJiX2Ah8g2JQ4C9ti3bX5O7JuJ8I03qZu6 jNMvcJ+ZHtLzs9zqF+oyYuGjTbwRU2lEL2Z6dnflJ0yaE61sUmN4risyZC3f0IKYqZSW b9/Q== X-Gm-Message-State: AOJu0Yw6X18MS7rYn6inrRcpc06ehrTX0ggKuGY+LdkPluekqG0IrCm2 XF6vrxqYWvjuWxeUItkuTKFkJX4Jd/fF8cU7mV3Dqp5o35mJmFCjNkE2Ow8OJ20= X-Google-Smtp-Source: AGHT+IFPbQXqIv2ar+QII0hQpgBjXdJgL30cR+0I35z0Qeg/jgs8gSfyzyoSkqCRaIGNFonNZHvndA== X-Received: by 2002:a05:6a00:10d2:b0:71e:6f32:df07 with SMTP id d2e1a72fcca58-7245796a213mr2177372b3a.1.1731479669057; Tue, 12 Nov 2024 22:34:29 -0800 (PST) Received: from localhost.localdomain ([2600:1700:3bdc:8c10:a:e04f:e712:3f95]) by smtp.gmail.com with ESMTPSA id d2e1a72fcca58-72458bab30asm747572b3a.190.2024.11.12.22.34.27 (version=TLS1_3 cipher=TLS_CHACHA20_POLY1305_SHA256 bits=256/256); Tue, 12 Nov 2024 22:34:28 -0800 (PST) From: anish kumar To: corbet@lwn.net, tj@kernel.org, akpm@linux-foundation.org, ptesarik@suse.com, xavier_qy@163.com, vbabka@suse.cz, tintinm2017@gmail.com Cc: linux-mm@kvack.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, anish kumar Subject: [RFC PATCH 0/2] modernize DMA api documentation Date: Tue, 12 Nov 2024 22:34:23 -0800 Message-Id: <20241113063425.21042-1-yesanishhere@gmail.com> X-Mailer: git-send-email 2.39.5 (Apple Git-154) MIME-Version: 1.0 X-Rspamd-Server: rspam06 X-Rspamd-Queue-Id: 9B512160006 X-Stat-Signature: twu4tkhk6fi4neoyf9rykagarbngun89 X-Rspam-User: X-HE-Tag: 1731480128-573393 X-HE-Meta: U2FsdGVkX1/PX52aahmDDryXiBG7De0i3Xi4PFYF73hAoHvjvGDD2QUo6GCSnNuGyxca3dpaURACGUFOGYYRNLZlV8oZtsH7wCP4HhlJi+WR4ZUrLx5aADEv9GACFUwv12naDxxwB081mjyZ7rrSi4UgRgvjvSCwmyM92O+VXUOV0pPX6K+0lAtYV1GDAWAom1td2Hp+Ahh6hfg1kwQdQUVpC82ekD8Jk60Xsf4c+QCIKA0PgPuSQHlAyuZVBlofm0/zQz4xBfjWe4yvqekJj8Abv1lQkX0cAbfoPbbP7R2ipAdsBM6r9HzRU6iXNnpRGBTqdKvSrvPaep5MqPEa8MQeoXozEvnT1p9yLisls8NyNc3VDHZdmrzoxnqA98rN865aGPmw6otViNNsAI9PzxETOLzm4GekCUGfcXG3swHrxDIhB7pzzhslFdgWIgWHJCbjTOIbKYKpGZSz2hCiKYi+0Tp0xe7oUAmYbY0jamKO2jf7ZN1lFrBQft6VYplzZPw2tq4Cl2DeHNd+q63EKm++kbCAJktDhMzEJQJQfJ41cKS6WIBOxHSuvkOutzJbA2r4pMoDP4hrb9HEnLxFW+4hFuZCuucNc9cDJFc5h5dnsXoul/zUk8h76AFG78h70tqeNa3wmZ81Kbj7FLSdNt1kzkbdPfiZLwIScU2ki4lY3ufAZw9+r/rgJEH+8GINNda2LNi3pxI/teDRNjzh6HCv+IDf+SQyXak3hofvZ52I0vQh2Bj1YAOT/mHF+N6xX9Slz8ZYggUKukefd3n76bBADfqqTvJFldvn9DEAv+x84VAK7+MG/kzPypF8Wny7K3HxDsM8XwlCVQFAhr6MhTHa7x8dssMcI7pxN7s+tCKTuIV+HlTqOXu7eZRzDmLjPlOljS8lIYISzNXHp88eWptXhV4tMM2Mj7ioN67cp24HrwP5O/dqNWuH764ZRtNF+7SgiKSU1/lPjH+XPT8 1cORqGmg jwoYwFqW175xrwwJ1iny1dCUSXWNSXGnBy2NkJgqcMvYM2sfoikDEy347HgHAIophpY3z614iurxj1kH27qMUqZbNTegwEKXqttP++0K6tuCOOeWUWeZidIAgcqhUTOajKrCt4rHS7DM2RVqYhl6RAZrh2rlfe5tV4GHnlTr3n7DAq6ux9ODmTn1I/Dc5O24AOwfJC/6GY2U1XButvwdoOHHyws+c+oI+X3LkPUHRPHRkA5wMYeF3taMeQtEzdSIZwZK31Ri8j42eICW64eMRWMwze4YdSQRA5Rdcx/yGoYRBaD/GNCt5E9vFxqKI2bayx+An+48Da/DsQ9uRU+hOfS3hgdG3gpjcLAxU9MmaFZBblISchmxtLjiZY7THzK0Hj7GKZxdouHvnAtQBOTkM8CDAong2r2wAPo6xQtDIOycZjw0T8TVFdz1kSeDsLVGR2ciC X-Bogosity: Ham, tests=bogofilter, spamicity=0.000002, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: List-Subscribe: List-Unsubscribe: Dear maintainers, This patch series is inspired by the ongoing discussion in the following thread: https://lore.kernel.org/lkml/20241111063847.GB23992@lst.de/ As part of an effort to modernize the documentation, the first patch in this series converts the relevant document to use kernel-doc comments directly within the source code, replacing the previous method of manually adding documentation. This change will help streamline the documentation workflow and ensure it remains synchronized with the code. I am still getting below errors and wondering if there is a better way to write this patch. /home/ANT.AMAZON.COM/anishkmr/Downloads/linux/Documentation/core-api/dma-api:89: ./mm/dmapool.c:229: WARNING: Duplicate C declaration, also defined at core-api/mm-api:224. Declaration is: '.. c:function:: struct dma_pool *dma_pool_create (const char *name, struct device *dev, size_t size, size_t align, size_t boundary)'. /home/ANT.AMAZON.COM/anishkmr/Downloads/linux/Documentation/core-api/dma-api:92: ./mm/dmapool.c:420: WARNING: Duplicate C declaration, also defined at core-api/mm-api:404. Declaration is: '.. c:function:: void *dma_pool_alloc (struct dma_pool *pool, gfp_t mem_flags, dma_addr_t *handle)'. /home/ANT.AMAZON.COM/anishkmr/Downloads/linux/Documentation/core-api/dma-api:98: ./mm/dmapool.c:229: WARNING: Duplicate C declaration, also defined at core-api/mm-api:224. Declaration is: '.. c:function:: struct dma_pool *dma_pool_create (const char *name, struct device *dev, size_t size, size_t align, size_t boundary)'. /home/ANT.AMAZON.COM/anishkmr/Downloads/linux/Documentation/core-api/dma-api:101: ./mm/dmapool.c:466: WARNING: Duplicate C declaration, also defined at core-api/mm-api:450. Declaration is: '.. c:function:: void dma_pool_free (struct dma_pool *pool, void *vaddr, dma_addr_t dma)'. /home/ANT.AMAZON.COM/anishkmr/Downloads/linux/Documentation/core-api/dma-api:104: ./mm/dmapool.c:366: WARNING: Duplicate C declaration, also defined at core-api/mm-api:360. Thank you for considering this patch. I look forward to your feedback. anish kumar (2): dmapool: Improve dma api kernel-doc comments dmapool: Documentation: use the kernel-doc comment Documentation/core-api/dma-api.rst | 66 ++++++------------------------ mm/dmapool.c | 40 ++++++++++++------ 2 files changed, 40 insertions(+), 66 deletions(-)