From patchwork Thu Jul 22 02:18:42 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Matthew Wilcox X-Patchwork-Id: 12392837 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=-16.6 required=3.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_GIT autolearn=ham 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 17CF7C6377B for ; Thu, 22 Jul 2021 02:57:22 +0000 (UTC) Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by mail.kernel.org (Postfix) with ESMTP id 80B576023F for ; Thu, 22 Jul 2021 02:57:21 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 80B576023F Authentication-Results: mail.kernel.org; dmarc=none (p=none dis=none) header.from=infradead.org Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=owner-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix) id 0D0A36B0036; Wed, 21 Jul 2021 22:57:21 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 080376B005D; Wed, 21 Jul 2021 22:57:21 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id ED8A96B006C; Wed, 21 Jul 2021 22:57:20 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from forelay.hostedemail.com (smtprelay0103.hostedemail.com [216.40.44.103]) by kanga.kvack.org (Postfix) with ESMTP id D2B556B0036 for ; Wed, 21 Jul 2021 22:57:20 -0400 (EDT) Received: from smtpin01.hostedemail.com (10.5.19.251.rfc1918.com [10.5.19.251]) by forelay01.hostedemail.com (Postfix) with ESMTP id 83328184D8F8D for ; Thu, 22 Jul 2021 02:57:20 +0000 (UTC) X-FDA: 78388712640.01.A3EA7C1 Received: from casper.infradead.org (casper.infradead.org [90.155.50.34]) by imf16.hostedemail.com (Postfix) with ESMTP id BBD5CF0015A9 for ; Thu, 22 Jul 2021 02:57:19 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=casper.20170209; h=Content-Transfer-Encoding:MIME-Version: Message-Id:Date:Subject:Cc:To:From:Sender:Reply-To:Content-Type:Content-ID: Content-Description:In-Reply-To:References; bh=ZAUM6JsORpXKtfzwUl7e2bOgLpFXq7TN7LD+yIvdhvk=; b=FMiOv7KeBzACwgx99SAkMWD60i ERupB85JGmpDr6YRZLeypz5ORgguEbKl9ZPRcYowzNk4fTnsDMoe8XBF40ihVy0Obi4HwvyayWDor WZMTWEbNY9BRwA95cdM5bw+Ff5xeB/At9x1xDM6J6RKCjAUt4n1nDL6A0dQBeUpvifH3ALeTSBS9z IJH1ND2GvhC2HoXcOihX/eR6sSMYR4yPoUouu0xV03W4r9KjLxRJrniYZymJeWuQnnIzsHaaFOUv0 hmZ1jUB25EBqX8uBU+UYVgxSu34zW5FqFlNxvBNmnmggvReYyzv1Lpv+Zj/y6OylH0CXF8i29TEjU VhdpZRBQ==; Received: from willy by casper.infradead.org with local (Exim 4.94.2 #2 (Red Hat Linux)) id 1m6OIS-009nkq-EC; Thu, 22 Jul 2021 02:18:54 +0000 From: "Matthew Wilcox (Oracle)" To: Andrew Morton , Thomas Gleixner , linux-kernel@vger.kernel.org, linux-mm@kvack.org Cc: "Matthew Wilcox (Oracle)" Subject: [PATCH] mm/doc: Include highmem.h in kernel-doc Date: Thu, 22 Jul 2021 03:18:42 +0100 Message-Id: <20210722021843.2336117-1-willy@infradead.org> X-Mailer: git-send-email 2.31.1 MIME-Version: 1.0 X-Rspamd-Server: rspam06 X-Rspamd-Queue-Id: BBD5CF0015A9 X-Stat-Signature: omy5935yyzto47wfh7pqkbxbh16asw6z Authentication-Results: imf16.hostedemail.com; dkim=pass header.d=infradead.org header.s=casper.20170209 header.b=FMiOv7Ke; spf=none (imf16.hostedemail.com: domain of willy@infradead.org has no SPF policy when checking 90.155.50.34) smtp.mailfrom=willy@infradead.org; dmarc=none X-HE-Tag: 1626922639-441161 X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: There is lots of good documentation in highmem.h that isn't being pulled into the html documentation. Fix up a couple of minor glitches and include it. Signed-off-by: Matthew Wilcox (Oracle) --- Documentation/core-api/mm-api.rst | 1 + include/linux/highmem.h | 17 +++++++++-------- 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/Documentation/core-api/mm-api.rst b/Documentation/core-api/mm-api.rst index 395835f9289f..2027aee5f2d9 100644 --- a/Documentation/core-api/mm-api.rst +++ b/Documentation/core-api/mm-api.rst @@ -54,6 +54,7 @@ Virtually Contiguous Mappings .. kernel-doc:: mm/vmalloc.c :export: +.. kernel-doc:: include/linux/highmem.h File Mapping and Page Cache =========================== diff --git a/include/linux/highmem.h b/include/linux/highmem.h index 861ad00fb32a..fc43e81cf4db 100644 --- a/include/linux/highmem.h +++ b/include/linux/highmem.h @@ -37,8 +37,8 @@ static inline void *kmap(struct page *page); /** - * kunmap - Unmap the virtual address mapped by kmap() - * @addr: Virtual address to be unmapped + * kunmap - Unmap the page mapped by kmap() + * @page: Page to be unmapped * * Counterpart to kmap(). A NOOP for CONFIG_HIGHMEM=n and for mappings of * pages in the low memory area. @@ -69,13 +69,13 @@ static inline void kmap_flush_unused(void); * * Requires careful handling when nesting multiple mappings because the map * management is stack based. The unmap has to be in the reverse order of - * the map operation: + * the map operation:: * - * addr1 = kmap_local_page(page1); - * addr2 = kmap_local_page(page2); - * ... - * kunmap_local(addr2); - * kunmap_local(addr1); + * addr1 = kmap_local_page(page1); + * addr2 = kmap_local_page(page2); + * ... + * kunmap_local(addr2); + * kunmap_local(addr1); * * Unmapping addr1 before addr2 is invalid and causes malfunction. * @@ -156,6 +156,7 @@ static inline void *kmap_atomic(struct page *page); * the side effects of kmap_atomic(), i.e. reenabling pagefaults and * preemption. */ +static inline void kunmap_atomic(void *addr); /* Highmem related interfaces for management code */ static inline unsigned int nr_free_highpages(void);