Received: by 2002:a05:6358:d09b:b0:dc:cd0c:909e with SMTP id jc27csp1633293rwb; Mon, 7 Nov 2022 04:07:26 -0800 (PST) X-Google-Smtp-Source: AMsMyM4x3NpchLXAqyJeQXmldlKh4uPNs9zFRp+CqQAoMnDzeRK548/JbkogmLmBakXgA/qDc+i3 X-Received: by 2002:a05:6402:22a5:b0:462:b393:f281 with SMTP id cx5-20020a05640222a500b00462b393f281mr50524623edb.379.1667822846317; Mon, 07 Nov 2022 04:07:26 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1667822846; cv=none; d=google.com; s=arc-20160816; b=piP1NjJpTEEsFW93l4Z5Oh6h3EfCcTw+EYPfiWGfZ65Ecm1xfJJOMGNEUwDz2BXLkY BsD2W9jYeyMx3yJMGNvzp2BnaFKVubNUgoefG4xiNm5f517ue9l/FOtybXz1qbtMG7nN bZdBvQ/wPIrCZdpAOQu8ucCSfBmnTEGCgKKaBEsEpmJgxUVo/6vOHil9rzSmV1DmaAWd L/V94U1Y1GZMg+6AdWkqw1wgxkN0YSr+8CyUCntFvbNRsjgdn/at0ftsaRB3ExRGRGhk tUfyPjxeeq9pkiRNwfsC6wbvbyFPPvdx1PtcExrRalKktbBm1Bbr19WoSiVhhVVBv3tv xBdg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:in-reply-to:from :content-language:subject:references:cc:to:user-agent:mime-version :date:message-id:dkim-signature; bh=fvr80PkwpQ6hjNpvYYW8IQLkFqmVccni+PUYRawFuvA=; b=nS91qGMKPwMLTY/XqU+nlIq1RlWlgPhJ/IzTOsOQHKXnuOt0TdB2UEO6Ch3esaovkE 1zneKh9T6fxiwKSn47abhullrZ8csdLgIb16zlOw0CXaIpZAxA9qerUvbjm+AhNVimAL c5EA7eInlW5WE0Pzo9r9XhnccTecJFc/izIUpGeg4CNpl0BkZh9H9r3tBR9qaWZ0YEb5 b46l2idg6ASeg4neGi3mGEzioWkno9m8JqWP1uV7mP0KNV2cv92gvZsKWNSuXPwzAK17 PpMjYNfVY6dxn/CQAH8CSJO2ND2itrq23O2nkWc0fGkQ4PxmmagBJpre02qzaruLMCKQ FkEw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@gmail.com header.s=20210112 header.b=fiukTMYT; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Return-Path: Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id x10-20020a170906440a00b0078da42195c2si7664521ejo.547.2022.11.07.04.07.02; Mon, 07 Nov 2022 04:07:26 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@gmail.com header.s=20210112 header.b=fiukTMYT; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231902AbiKGLsl (ORCPT + 93 others); Mon, 7 Nov 2022 06:48:41 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:56346 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231714AbiKGLsa (ORCPT ); Mon, 7 Nov 2022 06:48:30 -0500 Received: from mail-pj1-x102d.google.com (mail-pj1-x102d.google.com [IPv6:2607:f8b0:4864:20::102d]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 2E231F07; Mon, 7 Nov 2022 03:48:29 -0800 (PST) Received: by mail-pj1-x102d.google.com with SMTP id l6so10351580pjj.0; Mon, 07 Nov 2022 03:48:29 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=content-transfer-encoding:in-reply-to:from:content-language:subject :references:cc:to:user-agent:mime-version:date:message-id:from:to:cc :subject:date:message-id:reply-to; bh=fvr80PkwpQ6hjNpvYYW8IQLkFqmVccni+PUYRawFuvA=; b=fiukTMYTyjxWsa8x4fgdJLv5PDFoiEE1XxSRatZoFKxoH7GH1RMZsCkCy2fEwy44mA szrXgMAM/yMVeDAVodGIhhtL4XQU6+L0jSha7dJD0UMEfyZcnJYqAhw+5y/QlQutHlvo bv96oclSReRuS4Yak/ILdzhnjThlv2fOXeNzMrIkoPTH39xEaJHLr0BeJ0nKFi18tRW3 F+ZszIAILyQcyG3AjjcBi4wpnUJGpRATlBNcBVdvpa+DYnxuQgAaJzBxkMAwnflYrDXu TR4YA2N47q3unWbbUaoqxbqL++NRvVwBxxICbhxtXWMJpcYDpSAAIr35de7NwR26VxOV Ko/A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=content-transfer-encoding:in-reply-to:from:content-language:subject :references:cc:to:user-agent:mime-version:date:message-id :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=fvr80PkwpQ6hjNpvYYW8IQLkFqmVccni+PUYRawFuvA=; b=eSNfePrcie8bQJ/b5bZKlnmsOr7cEbQFPuO2tyBx/V3n4yLwBxAl20hC8f/wSUYPbs YDZ64FGeM3Ux1KMj47KadXUXma431CYlCLYXB7Av43xM2b4fU/lMUE+rq0Td84jeBQKZ 9HjOjAIyAg9HsWWA0EAHrHT0BlFXx2VZYbO4/rSW8NPKhGQ6F2hRCV2N2I9QfamVBbAd sMb5vH8HgSJ/PrbfmO9vvmeG6ZRTo6PuwumtmpI1Jhx1ZPwSDGz+wK+wHQgw1VX2KOyf xLGVjzg7nx5k1EPERb9Eb2dAYb4xWR8+n2brQ6nDzg+EY3dPNZ2G5P1HzYsEAnb0hbc+ kfKQ== X-Gm-Message-State: ACrzQf2NB880NH0rLfAcOMcTmyDob3l57F7ZlE8e1XdQWMXxoLBNVJzX gKvfRUWt237Rk4hs+PmRC3Q= X-Received: by 2002:a17:902:ba8d:b0:187:11c7:e878 with SMTP id k13-20020a170902ba8d00b0018711c7e878mr44671991pls.67.1667821708620; Mon, 07 Nov 2022 03:48:28 -0800 (PST) Received: from [192.168.11.9] (KD106167171201.ppp-bb.dion.ne.jp. [106.167.171.201]) by smtp.gmail.com with ESMTPSA id l16-20020a170903121000b00176b3c9693esm4789489plh.299.2022.11.07.03.48.24 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Mon, 07 Nov 2022 03:48:28 -0800 (PST) Message-ID: Date: Mon, 7 Nov 2022 20:48:23 +0900 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101 Thunderbird/102.2.2 To: Bagas Sanjaya Cc: corbet@lwn.net, frederic@kernel.org, jiangshanlai@gmail.com, joel@joelfernandes.org, josh@joshtriplett.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, linux-next@vger.kernel.org, mathieu.desnoyers@efficios.com, paulmck@kernel.org, quic_neeraju@quicinc.com, rcu@vger.kernel.org, rostedt@goodmis.org, sfr@canb.auug.org.au, Akira Yokosawa References: Subject: [PATCH] Documentation: RCU: use code blocks with autogenerated line (was: Re: linux-next: build warning after merge of the rcu tree) Content-Language: en-US From: Akira Yokosawa In-Reply-To: Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 7bit X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,FREEMAIL_FROM, RCVD_IN_DNSWL_NONE,SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Hi Bagas, On Mon, 7 Nov 2022 16:55:13 +0700, Bagas Sanjaya wrote: > On Sun, Nov 06, 2022 at 09:02:12PM -0800, Paul E. McKenney wrote: >> On Mon, Nov 07, 2022 at 02:26:41PM +1100, Stephen Rothwell wrote: >> > Hi all, >> > >> > After merging the rcu tree, today's linux-next build (htmldocs) >> > produced this warning: >> > >> > Documentation/RCU/rcubarrier.rst:205: WARNING: Literal block ends without a blank line; unexpected unindent. >> > >> > Introduced by commit >> > >> > 21c2e3909721 ("doc: Update rcubarrier.rst") >> >> Huh. I guess that numbered code samples are not supposed to have more >> than nine lines? Ah well, easy to fix by going back to left-justified >> numbers. I was wondering about that! >> > > I think the proper fix is just let Sphinx generates line number: That might be true if all you care about were the generated documents, but we need to pay attention to readers of .rst files as plain-text. There are a bunch of references to line numbers in RCU documents. If explicit line numbers are removed from snippets, such readers need to count the lines by themselves, which doesn't sound reasonable to me. If you can put labels to referenced lines within code snippets, auto generation of line numbers might work, but as far as I know, Sphinx doesn't provide such a nice feature. Of course, you can prove me wrong. Thanks, Akira