From patchwork Wed Jun 22 08:45:46 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bagas Sanjaya X-Patchwork-Id: 12890316 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 1FF85C43334 for ; Wed, 22 Jun 2022 08:48:08 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id B11EC8E009C; Wed, 22 Jun 2022 04:48:07 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id AC15E8E008A; Wed, 22 Jun 2022 04:48:07 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 98A308E009C; Wed, 22 Jun 2022 04:48:07 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0016.hostedemail.com [216.40.44.16]) by kanga.kvack.org (Postfix) with ESMTP id 88A808E008A for ; Wed, 22 Jun 2022 04:48:07 -0400 (EDT) Received: from smtpin13.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay13.hostedemail.com (Postfix) with ESMTP id 5B8046121F for ; Wed, 22 Jun 2022 08:48:07 +0000 (UTC) X-FDA: 79605244614.13.4537E8D Received: from mail-pj1-f49.google.com (mail-pj1-f49.google.com [209.85.216.49]) by imf23.hostedemail.com (Postfix) with ESMTP id ECD8A1400A3 for ; Wed, 22 Jun 2022 08:48:01 +0000 (UTC) Received: by mail-pj1-f49.google.com with SMTP id h9-20020a17090a648900b001ecb8596e43so6931062pjj.5 for ; Wed, 22 Jun 2022 01:48:01 -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=Hs9pVTpUBi42eMdaATCBVLHpAcP7Nw426zvueY8ZwZI=; b=Lw0reKp119fQgW191FyyK0jxb52gIGmRolrrEJan5fK67WbHe6KIeUNsg7pgDoqjtT RzO3qPtfgxrYlG/fRm0u8QBkiO/igrt4hSQwVNHETFmkLoMkwJwaTT7mpeooVbsiN9fL 8I2KrBsqduyUa+VSUxarzQxWslOLClxg5whYaXKY5ZXnOuK8gMQsLEa1DKU8/SxqlH8n JDIBbuDtZGUR1qz4pUDcY0uXn6Pnfk+jzwUo8vRF+Ni0gZrppyu5+G7IElQJbAJFbwn0 NqXSmHspY8OWIBFYtfgkweYjzXgs0aK/59uJPuDKoM/hHkfGSay0c1bnYIx4JIInMCOP 4hDQ== 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=Hs9pVTpUBi42eMdaATCBVLHpAcP7Nw426zvueY8ZwZI=; b=OXsvl8GxXkmtx2xEFCugaTeuzs2RaJfgqrsDe4moc6ZskAULkXORU5mk+1oPfK6q6U 2o1KweMGyG5Z2v0QcKICQM1Entf68MLGGPRdOha6D63Oqdchb2Vvyem7Kw3WJ928mIQR lQUbcNzYgB+gliFpYH5b5yMYVUCTeT1Ic0qkY2ONnbKBpIkAq2tMgbQI1cs2twbQdsZZ yIUQmYA8ZijQev4Vj95kvxXQ9QHObcMS6zyeDbOvnWS0pzwxqqdELk26Wp7veJ9QYnyE Orawzwq3RJEt9hE9ZUY8nymJHiTGCco7qehwbcgiqcOn8ymp8PQMmux+G21EJ5ebGtti EITg== X-Gm-Message-State: AJIora+ihuPpECXHBrRsw8pfvnRIxiwn5l8ZYweIa+AuI/EmtihesHJ2 W677vjI+WCtTQUlrq3CP7t4= X-Google-Smtp-Source: AGRyM1shJvjitaGBPWgz/pdx6BV2OQUPOBwCHk3mBN4tYOSIhFIxvffRnNlgoVtOp/xm7tZgDMdKLQ== X-Received: by 2002:a17:902:d509:b0:167:6ed8:afb5 with SMTP id b9-20020a170902d50900b001676ed8afb5mr33549819plg.137.1655887679517; Wed, 22 Jun 2022 01:47:59 -0700 (PDT) Received: from debian.me (subs02-180-214-232-91.three.co.id. [180.214.232.91]) by smtp.gmail.com with ESMTPSA id a9-20020a170902ecc900b001677fa34a4fsm8199930plh.72.2022.06.22.01.47.55 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 22 Jun 2022 01:47:58 -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 v4] Documentation: highmem: Use literal block for code example in highmem.h comment Date: Wed, 22 Jun 2022 15:45:46 +0700 Message-Id: <20220622084546.17745-1-bagasdotme@gmail.com> X-Mailer: git-send-email 2.36.0 MIME-Version: 1.0 ARC-Authentication-Results: i=1; imf23.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=Lw0reKp1; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (imf23.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.216.49 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1655887682; 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=Hs9pVTpUBi42eMdaATCBVLHpAcP7Nw426zvueY8ZwZI=; b=3eFyDbTbnv5OCTQkacrv+JVSym87hBLZFwBox7nsUyVCC0GetFHO2rJ5EQ7aZGRB9GIQ0Q dVWM7XMS571TT8mWUSFELN/npvgTPy2awNJ7ZRtGanX0Lq2JqO9mIRVf9laPrIBD1qYEJ/ xRAMWKRBN/kCpp8VSAWPzg1Lhf1czQA= ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1655887682; a=rsa-sha256; cv=none; b=Brhv66cAQWo0jQbSpGkfF6RXScUbNK5ESr79lN1U8OCU9CfBqAz5mZARJFKPWIWpp3KK7w vJRiWKZM1scYJCmPVVXrbvWz29t9VVvqPVFf54BxPfhsLp5U21nZWY9NHuFMl5VxO7ZFlR HK7AuyHdZBq0GXjM6VXKjW7ySnwCa+w= X-Rspam-User: Authentication-Results: imf23.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=Lw0reKp1; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (imf23.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.216.49 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com X-Stat-Signature: jhx6kiy3su6ncom48bpxh8bqz9m5nmdx X-Rspamd-Queue-Id: ECD8A1400A3 X-Rspamd-Server: rspam12 X-HE-Tag: 1655887681-172787 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 at the mentioned lines above are enclosed by double dash (--), which confuses Sphinx as inline markup delimiters instead. Fix these warnings by indenting the code example with literal block indentation and making the comments C comments. 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 v3 [1]: - Say "C comments" rephrase (suggested by Ira) [1]: https://lore.kernel.org/linux-doc/20220620083649.18172-1-bagasdotme@gmail.com/ include/linux/highmem.h | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) base-commit: a111daf0c53ae91e71fd2bfe7497862d14132e3e 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.