From patchwork Mon Jun 20 08:36:49 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bagas Sanjaya X-Patchwork-Id: 12887120 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 6E6FAC43334 for ; Mon, 20 Jun 2022 08:37:13 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id D3E9A6B0071; Mon, 20 Jun 2022 04:37:12 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id CEDA16B0073; Mon, 20 Jun 2022 04:37:12 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id BB54E8E0001; Mon, 20 Jun 2022 04:37:12 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0012.hostedemail.com [216.40.44.12]) by kanga.kvack.org (Postfix) with ESMTP id ABFC86B0071 for ; Mon, 20 Jun 2022 04:37:12 -0400 (EDT) Received: from smtpin11.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay01.hostedemail.com (Postfix) with ESMTP id 7200D60341 for ; Mon, 20 Jun 2022 08:37:12 +0000 (UTC) X-FDA: 79597959504.11.E831D38 Received: from mail-pj1-f54.google.com (mail-pj1-f54.google.com [209.85.216.54]) by imf24.hostedemail.com (Postfix) with ESMTP id 1E346180083 for ; Mon, 20 Jun 2022 08:37:11 +0000 (UTC) Received: by mail-pj1-f54.google.com with SMTP id k12-20020a17090a404c00b001eaabc1fe5dso10090367pjg.1 for ; Mon, 20 Jun 2022 01:37:11 -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=5yVoQ0SxXSvnuAGacC2kdFONdFFTdfJJAv2a0z5/PO0=; b=dhw8MT0S+vtcLI7BXU81rHgRCqHaG1FDHc+OxIonEzZ2aCHN/rxNcaD84xAI7ZahNf 8GZqmP6Y0RluwS+4LowO1bL2altpW0RUTaVuvJAnivogsoHqiWptymz8LwgT0aiUaqPS CS+uj3qKguRR/zb64GBnNWsY6/hva3KWkhkXf3on/F+ujnHiC+193ib6Spj7BJGHRPgy Lm79Bk0jjXBAoj8ZK1iXADJjYKaklfKLu/idDJXyvDd+VHQrEYfhJ23gzC77jSDol3y0 u7o0zSDjIPWHVs6R2Eqdmbw0SDjqQ1XOtJ2h5bm0kFsQmQV2AeB4m+ugwBdmjKBhVAao hsbg== 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=5yVoQ0SxXSvnuAGacC2kdFONdFFTdfJJAv2a0z5/PO0=; b=B3e2nwNDFQn374oUGbvafCA1iCMxJvdpvdvlp31csBpCcBF7+NqSA5TaWcb0ZPPVs9 4FlcGOkf6V6rfAeILkKwvybRDyvgiYHFpkEVy9OgpTdwU6Od3z0g6dsz59w6XnpxoPij 2AP2pfyGQd3vXBzwjcTk0ZgGWMFOTi1k8D+P23cbGCS4mN61M3Q7tI5R7DV72w69Y4Xn ws4pBym7LPaUIO1LBFVDOc/hEx0lCOKqstf4FZmwPAUOzXFv/A2XopgsJB8PgqA6vIbq 2zrqD4VADTNsEvyka0WhNRtvX8n+BCMKOw/5k/N2pA9+KiFdVey07T3paHrFmGFo0sT0 ugPg== X-Gm-Message-State: AJIora+xIn1zJRcssG0gLtK8dQtpWMcvutn8nHQUfZWqezeSaEb2GVNC 0kfBqJ4oDHAJphwhv8Vm41M= X-Google-Smtp-Source: AGRyM1sRBbaktKY2lcchpbjnRC7DWal2IsF8bIXeouU3CCZeyJvcoY2hquO+2BAGrLwE8l9OqR9+dQ== X-Received: by 2002:a17:902:c951:b0:163:ed13:7acd with SMTP id i17-20020a170902c95100b00163ed137acdmr22886995pla.51.1655714231053; Mon, 20 Jun 2022 01:37:11 -0700 (PDT) Received: from debian.me (subs32-116-206-28-21.three.co.id. [116.206.28.21]) by smtp.gmail.com with ESMTPSA id e7-20020a17090a9a8700b001eab99a42efsm5594002pjp.31.2022.06.20.01.37.07 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 20 Jun 2022 01:37:10 -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 v3] Documentation: highmem: Use literal block for code example in highmem.h comment Date: Mon, 20 Jun 2022 15:36:49 +0700 Message-Id: <20220620083649.18172-1-bagasdotme@gmail.com> X-Mailer: git-send-email 2.36.0 MIME-Version: 1.0 ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1655714232; a=rsa-sha256; cv=none; b=4ArPpuyReAIEMaiglV+ztKQBkofbOVDyMHfq5inXZwl5b9EAk3Jk0ZozsIKYOkPLjz04OW QTKvKR28MYi38F+LtGzjFtFnBOco39exdLI4oRVQ7sWUfHRSlfLIsO/+KEdw+kEuFI341P 1tM9MUiqpJOgArke87TyJQnfievFzPk= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1655714232; 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=5yVoQ0SxXSvnuAGacC2kdFONdFFTdfJJAv2a0z5/PO0=; b=bj4oAAOSxYzcd+/d+uvS5KsNVo95OGW5jBAghfmmMyOZLC9Pb5CtM+pPYIdj0RGkxjPZY7 nUG6uzAwOLlmqsKrhf28u1n709sXuDd9yZpONz3hamt7cj6zB9PTvc/lM5GyZWEaSVlFjV yyXigl+9ylJGB6v29XHcfx72OBkr/6I= ARC-Authentication-Results: i=1; imf24.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=dhw8MT0S; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (imf24.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.216.54 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com Authentication-Results: imf24.hostedemail.com; dkim=pass header.d=gmail.com header.s=20210112 header.b=dhw8MT0S; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (imf24.hostedemail.com: domain of bagasdotme@gmail.com designates 209.85.216.54 as permitted sender) smtp.mailfrom=bagasdotme@gmail.com X-Rspam-User: X-Rspamd-Server: rspam09 X-Rspamd-Queue-Id: 1E346180083 X-Stat-Signature: e4q7q4rouiua63gpmu3q8zx6iybk9wmn X-HE-Tag: 1655714231-634233 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 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 --- Changes since v2 [1]: - Rebase on v5.19-rc3 - Don't mention any functions [1]: https://lore.kernel.org/linux-doc/20220615101509.516520-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.