From patchwork Tue Jun 14 12:31:16 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bagas Sanjaya X-Patchwork-Id: 12881089 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 E90B7C433EF for ; Tue, 14 Jun 2022 12:32:07 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 5AE428D0248; Tue, 14 Jun 2022 08:32:07 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 55E308D0005; Tue, 14 Jun 2022 08:32:07 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 3FE538D0248; Tue, 14 Jun 2022 08:32:07 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0011.hostedemail.com [216.40.44.11]) by kanga.kvack.org (Postfix) with ESMTP id 2F06E8D0005 for ; Tue, 14 Jun 2022 08:32:07 -0400 (EDT) Received: from smtpin06.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay07.hostedemail.com (Postfix) with ESMTP id 0881720887 for ; Tue, 14 Jun 2022 12:32:07 +0000 (UTC) X-FDA: 79576778694.06.5A1234D Received: from mail-pg1-f181.google.com (mail-pg1-f181.google.com [209.85.215.181]) by imf03.hostedemail.com (Postfix) with ESMTP id 96629200A0 for ; Tue, 14 Jun 2022 12:32:06 +0000 (UTC) Received: by mail-pg1-f181.google.com with SMTP id h192so8392025pgc.4 for ; Tue, 14 Jun 2022 05:32:06 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=6bWhyj9+Innd6VBvVBk86q4KgboPFIEsoGvupeRdYFM=; b=eFPzFERHaQ3hu76kP/FeGfFvMx+Y+9glglTmjGMriMFNUtCL4MVyyRte8/oPlwTSXV Vm/OXIfmlv4N0Z1qxMO7KsBEeKabN4R/myJwFyfy7uSec2t7LjQ5qskH5kpfQx6DzV6K s1pmDp3DZLm1Y6/gI4XcvuYfUy7z0+KD51B/oYJANJ4wXbmvN4v9bKxOnID8hYKAK7xZ sI61N7VRGcrnpJ44/imB5hFUezPjRMZ1TEJHRxwS20qdTuPWGgxe2Z0+WSFb4YFN12wp OfAna8fs140EQK6qn0ve8ps/Wna5SmhMzUeprtMC8CU4QqhuA18Y4mcly46iviHuBgGp GkGQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=6bWhyj9+Innd6VBvVBk86q4KgboPFIEsoGvupeRdYFM=; b=B7wf6QX/673x2xm9h48Wp34VXegtGFV+MLFwrP9orOhSYFK+tYAsbhBPczlQSpNcFt MOklJ9WGh5+cCsBleoxe3nJ9o9PGnBr6Ef5CHwHgiEAaYpBXS9XfWRVcDMJJVPK60be6 DXgIEYIYnR/dbGofrWeNqLbKAxHOALbEJ4Q6yZE9tUi+SWeUWsDvItOb3myu/m03ViN9 qqCLB/zq7aoeQlhY/nOed4AJzoNCiuXox13gLwh+hUl0eg5r0UxBq87bf0v7sm4Z7i3h Il8hQlIRDhyJQLVxIYGV+/K3uJHnDchuEOq9gj0uWhI5uORgG8B9QZbsLG/WxrgXnIoT hNDw== X-Gm-Message-State: AOAM5310C3zIua2Y6LwGrsz4UYdgdXO721dbb08BjGNLNh1gOA/yf5U0 f7Xt6BBEQPHwFRgukdkZaE8= X-Google-Smtp-Source: ABdhPJwrYy7YJmSFGc1DKopsg3STNIPBTHxc3xMt6QTBGTSlvr94Yd5EHAOEGrP8+RLUeRp1W4J5Ag== X-Received: by 2002:a63:894a:0:b0:3fc:a724:578c with SMTP id v71-20020a63894a000000b003fca724578cmr4402325pgd.499.1655209925358; Tue, 14 Jun 2022 05:32:05 -0700 (PDT) Received: from debian.me (subs02-180-214-232-21.three.co.id. [180.214.232.21]) by smtp.gmail.com with ESMTPSA id w1-20020a62c701000000b0050dc7628148sm7403979pfg.34.2022.06.14.05.32.02 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 14 Jun 2022 05:32:04 -0700 (PDT) From: Bagas Sanjaya To: linux-doc@vger.kernel.org Cc: Bagas Sanjaya , Andrew Morton , Ira Weiny , "Matthew Wilcox (Oracle)" , "Fabio M. De Francesco" , Sebastian Andrzej Siewior , linux-mm@kvack.org, linux-kernel@vger.kernel.org Subject: [PATCH] Documentation: highmem: Use literal block for *kmap_local_folio() example Date: Tue, 14 Jun 2022 19:31:16 +0700 Message-Id: <20220614123115.522131-1-bagasdotme@gmail.com> X-Mailer: git-send-email 2.36.0 MIME-Version: 1.0 ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1655209926; 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=6bWhyj9+Innd6VBvVBk86q4KgboPFIEsoGvupeRdYFM=; b=j5bDnXLVUBa2lyjXgntpXFsQWEF+LqiAWnjMlAJaUXKToWtj7q5ombnf8KcrpHYmYMFNlH YfQrzgeAXN1HW3CNgIZB7pH4ZIkhgzZi9WNcU0f7Gt/lbsh6WSqnqZ5fZg4+mE0ae8Iv1v OaJfOW+aBZIpU64Ux/GzQhuW0RR2Z8k= ARC-Authentication-Results: i=1; imf03.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=eFPzFERH; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (imf03.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.215.181 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1655209926; a=rsa-sha256; cv=none; b=0xiNGvVfSbfZMce44CXJlMu8nnZvBAXlpSh1QHQksSEDcKQ/kAD8lFGmuNWw1L1KecKQwV EAUgyUMvS3445FzSI1kRTBecYsQxElkuryA3J0iSQN51Z+JUCzCpIz6U9lp4jA2N+shXJ6 zyhngQDcaIOPAcpkxsfIAKyQPmhJ2A4= X-Rspamd-Queue-Id: 96629200A0 X-Rspam-User: X-Stat-Signature: ybn46jwsnbsccha9nngia6nbjyudmdks Authentication-Results: imf03.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=eFPzFERH; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (imf03.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.215.181 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com X-Rspamd-Server: rspam04 X-HE-Tag: 1655209926-457709 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: When building htmldocs on Linus' tree, there are inline emphasis warnings on include/linux/highmem.h: Documentation/vm/highmem:166: ./include/linux/highmem.h:154: WARNING: Inline emphasis start-string without end-string. Documentation/vm/highmem:166: ./include/linux/highmem.h:157: WARNING: Inline emphasis start-string without end-string. These warnings above are due to comments in code example of *kmap_local_folio() are enclosed by double dash (--) instead of prefixed with comment symbol (#). Fix these warnings by indenting the code example with literal block indentation and prefixing comments inside the example with #. Fixes: 85a85e7601263f ("Documentation/vm: move "Using kmap-atomic" to highmem.h") Cc: Andrew Morton Cc: Ira Weiny Cc: "Matthew Wilcox (Oracle)" Cc: "Fabio M. De Francesco" Cc: Sebastian Andrzej Siewior Cc: linux-mm@kvack.org Cc: linux-kernel@vger.kernel.org Signed-off-by: Bagas Sanjaya --- include/linux/highmem.h | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) base-commit: b13baccc3850ca8b8cccbf8ed9912dbaa0fdf7f3 diff --git a/include/linux/highmem.h b/include/linux/highmem.h index 3af34de54330cb..a244e0345c87ca 100644 --- a/include/linux/highmem.h +++ b/include/linux/highmem.h @@ -149,19 +149,19 @@ static inline void *kmap_local_folio(struct folio *folio, size_t offset); * It is used in atomic context when code wants to access the contents of a * page that might be allocated from high memory (see __GFP_HIGHMEM), for * example a page in the pagecache. The API has two functions, and they - * can be used in a manner similar to the following: + * can be used in a manner similar to the following:: * - * -- Find the page of interest. -- - * struct page *page = find_get_page(mapping, offset); + * # Find the page of interest. + * struct page *page = find_get_page(mapping, offset); * - * -- Gain access to the contents of that page. -- - * void *vaddr = kmap_atomic(page); + * # Gain access to the contents of that page. + * void *vaddr = kmap_atomic(page); * - * -- Do something to the contents of that page. -- - * memset(vaddr, 0, PAGE_SIZE); + * # Do something to the contents of that page. + * memset(vaddr, 0, PAGE_SIZE); * - * -- Unmap that page. -- - * kunmap_atomic(vaddr); + * # Unmap that page. + * kunmap_atomic(vaddr); * * Note that the kunmap_atomic() call takes the result of the kmap_atomic() * call, not the argument.