From patchwork Wed Jun 15 10:15:10 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bagas Sanjaya X-Patchwork-Id: 12882034 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 DD9F7C433EF for ; Wed, 15 Jun 2022 10:15:37 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 743A16B0071; Wed, 15 Jun 2022 06:15:37 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 6A4566B0072; Wed, 15 Jun 2022 06:15:37 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 5455D6B0073; Wed, 15 Jun 2022 06:15:37 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0015.hostedemail.com [216.40.44.15]) by kanga.kvack.org (Postfix) with ESMTP id 418886B0071 for ; Wed, 15 Jun 2022 06:15:37 -0400 (EDT) Received: from smtpin28.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay07.hostedemail.com (Postfix) with ESMTP id EA5CB21633 for ; Wed, 15 Jun 2022 10:15:36 +0000 (UTC) X-FDA: 79580063472.28.39AED99 Received: from mail-pj1-f46.google.com (mail-pj1-f46.google.com [209.85.216.46]) by imf11.hostedemail.com (Postfix) with ESMTP id 6856040081 for ; Wed, 15 Jun 2022 10:15:36 +0000 (UTC) Received: by mail-pj1-f46.google.com with SMTP id q12-20020a17090a304c00b001e2d4fb0eb4so1645349pjl.4 for ; Wed, 15 Jun 2022 03:15:36 -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=8Mg3IddV8fqKnhInS4vCQZ7ljmMvEGOBjmrWbtncoys=; b=WTtyjNYuNz6SGgDX2yLb6Uvj+evRZIUmEenoCBK+pENsEY7L4jsgZjdcTtZxn81qVi 3IJoUMLv23y7iWQ33KIIHpMtjx+XCs1v+v07f0dT0DP6VauEJz0faMdRXtuA7U/CzWb3 i4Zqvzn27MxDdWRf7qIAH6BSGhBx1rRgj2i+8yeptixfQUpJZEOZ7Dm1UnTI7UHAquoz 5qw2N83+Z03CuPVIr4hY+i9Xmfk16y1DMZOB5v6FP0upL38IDpdl4Lzy3uHvk2mGe8wY YYdCzRWJzqcm9f1gHIyfe6RwrxydVBO5nmQLtkNsxLoUOryIVIWMJw6sx2z8RAtR8OYB HI/w== 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=8Mg3IddV8fqKnhInS4vCQZ7ljmMvEGOBjmrWbtncoys=; b=aDh7vArHQS51OTofFat5uSDu/0nSxsvPQcFhLhg3TzACD8van9+MmIpp9Q7AiTg+Wu voxwR0aF4LoJUpEtPtWu4n3CqOWXEHb4Zv3bc8O3eNeA9c4z83+PUhl5q/AwigjYZ7bc wrtkGdiEgDEbybxkmHr5r4UtLLGSEgVaojBb5INSR13nEpXXNTPabhLNh929IHZZgwrH 7DxL3PG7SwnFbEOUK7oy/GDnmhZbfeGW5eaGOICdYJMEXQnaxVlOVu9z3vhuVH69R7BF WE3WAiDE2CwgRSTLpUAWfU3fRU7wsvZTFUD8q3YWL5fHyGNT9z6kfNSTBQSd2Ty1kuJL buFQ== X-Gm-Message-State: AJIora8llw5KbtR2OgNCrQjPWb6qec0Sy3uvGupMOzaiwhcJyziCiIVQ rVGq7g9QVbxtikJC54hp70nDVcM1FIg= X-Google-Smtp-Source: AGRyM1sVvh6CZslExlcC7HTPkanuprVYxIw70h7LqP+R229D/XyNr22C/tSMN72XTlGthIsT60N03g== X-Received: by 2002:a17:90a:c7d7:b0:1e8:3d2d:dd67 with SMTP id gf23-20020a17090ac7d700b001e83d2ddd67mr9452119pjb.89.1655288135315; Wed, 15 Jun 2022 03:15:35 -0700 (PDT) Received: from debian.me (subs03-180-214-233-70.three.co.id. [180.214.233.70]) by smtp.gmail.com with ESMTPSA id m26-20020a63941a000000b003fc5b1db26fsm9502035pge.52.2022.06.15.03.15.31 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 15 Jun 2022 03:15:34 -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 v2] Documentation: highmem: Use literal block for *kmap_local_folio() example Date: Wed, 15 Jun 2022 17:15:10 +0700 Message-Id: <20220615101509.516520-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=1655288136; 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=8Mg3IddV8fqKnhInS4vCQZ7ljmMvEGOBjmrWbtncoys=; b=IATHezTs5VF1SoHRoewTptbEzNqtGp7R/ZKYXucP7B0iDHqCduTaPsCb5ilREcAyLXqVuq /8wrVJBgy6PSS9bHNB8B4vhwW/QpTeo1CSW2vBBldeOy1EWQ2shYLBIslrKBUPTrF3IsUF Z/r3UeELn7ELL4ywEHe1VtdXDHsIxFI= ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1655288136; a=rsa-sha256; cv=none; b=ONXungk/5y02a/CYwjYbDC0Wy1REiIZWZhqo5fl6FBZMf+1yCD73UMGv75ss3/YmEX45k7 A9oBT24xPYpt8ti/XUpFiLPHAEsXL+xCBFgw65gTDc1QFdQgx2TYa5TdWe6xHGkqhk9U34 QgbDb+ufmtmj0OPf6mWmUI0zw7FVCFw= ARC-Authentication-Results: i=1; imf11.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=WTtyjNYu; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (imf11.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.216.46 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com Authentication-Results: imf11.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=WTtyjNYu; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (imf11.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.216.46 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com X-Rspamd-Server: rspam12 X-Rspam-User: X-Stat-Signature: ynj8bd7ho9zgjhqcmitcmdydbpxtm3fd X-Rspamd-Queue-Id: 6856040081 X-HE-Tag: 1655288136-410963 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_atomic() inside kernel-doc comment of *kmap_local_folio() are enclosed by double dash (--) instead of prefixed with C comment symbol (//). Fix these warnings by indenting the code example with literal block indentation and prefixing comments inside the example with C comment symbol. 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 Reviewed-by: Ira Weiny Tested-by: Ira Weiny --- Changes since v1 [1]: - Point that the code example is for kmap_atomic() (suggested by Matthew Wilcox) - Use C comments instead of Unix shell comments prefix (suggested by Ira Weiny) [1]: https://lore.kernel.org/linux-doc/20220614123115.522131-1-bagasdotme@gmail.com/ include/linux/highmem.h | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) base-commit: 018ab4fabddd94f1c96f3b59e180691b9e88d5d8 diff --git a/include/linux/highmem.h b/include/linux/highmem.h index 3af34de54330cb..56d6a019653489 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.