From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-8.6 required=3.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY, SPF_HELO_NONE,SPF_PASS,USER_AGENT_SANE_2 autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 189F7C2D0EA for ; Wed, 8 Apr 2020 11:41:01 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id D23702083E for ; Wed, 8 Apr 2020 11:41:00 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1586346060; bh=igLuiZn52qB1kj2vKxCTjSGs9/VNYNbdH6sNTlgRisY=; h=Date:From:To:Cc:Subject:In-Reply-To:References:List-ID:From; b=o3XfI6Gq2qmfxhoS/v5b/tgI5PDXR9W96PXq0Gjz1pbawXlgr62anBnI3w/2C6p5y rH6cngMiSdmwctULwWklp2YKOwLerZ4YMnH18jveCT4oaoll1Hhy63zdC79YpQMB2j AQhLIRD6VwVtq48RgAhcu9kK3THlSlReSXG4+nNY= Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1728554AbgDHLlA (ORCPT ); Wed, 8 Apr 2020 07:41:00 -0400 Received: from mail.kernel.org ([198.145.29.99]:37534 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1728497AbgDHLlA (ORCPT ); Wed, 8 Apr 2020 07:41:00 -0400 Received: from coco.lan (ip5f5ad4d8.dynamic.kabel-deutschland.de [95.90.212.216]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id 759AF20747; Wed, 8 Apr 2020 11:40:52 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1586346059; bh=igLuiZn52qB1kj2vKxCTjSGs9/VNYNbdH6sNTlgRisY=; h=Date:From:To:Cc:Subject:In-Reply-To:References:From; b=lNMtsoG3BeTIbawLBoa0nrrwd0el6dj9ixd/wEe67LD2atI1u1lEiKmTJiKJA0hjV FXR8cQCs+m+ksv+uue55PKV997wAUH/UarzRCS6hVK+lXwWdeotoHeiFSlypmHOYoN dm4usj1My3oZ7OaxsoqH8jwAufqemuBwo1R1j8fs= Date: Wed, 8 Apr 2020 13:40:48 +0200 From: Mauro Carvalho Chehab To: Michael Ellerman Cc: Linux Doc Mailing List , linux-kernel@vger.kernel.org, Jonathan Corbet , "Martin K. Petersen" , Paul Mackerras , Madhuparna Bhowmik , "David S. Miller" , Ricardo Ribalda Delgado , Luca Ceresoli , dmaengine@vger.kernel.org, Matthias Maennich , Harry Wei , x86@kernel.org, ecryptfs@vger.kernel.org, Jakub Kicinski , target-devel@vger.kernel.org, "H. Peter Anvin" , Hans Verkuil , Benjamin Herrenschmidt , Johannes Berg , Jacopo Mondi , Tyler Hicks , Vinod Koul , Alex Shi , Thomas Gleixner , Ingo Molnar , linux-scsi@vger.kernel.org, netdev@vger.kernel.org, Greg Kroah-Hartman , linuxppc-dev@lists.ozlabs.org, Borislav Petkov Subject: Re: [PATCH v2 0/2] Don't generate thousands of new warnings when building docs Message-ID: <20200408134048.5329427d@coco.lan> In-Reply-To: <87lfn8klf4.fsf@mpe.ellerman.id.au> References: <87lfn8klf4.fsf@mpe.ellerman.id.au> X-Mailer: Claws Mail 3.17.5 (GTK+ 2.24.32; x86_64-redhat-linux-gnu) MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit Sender: linux-doc-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-doc@vger.kernel.org Em Tue, 07 Apr 2020 13:46:23 +1000 Michael Ellerman escreveu: > Mauro Carvalho Chehab writes: > > This small series address a regression caused by a new patch at > > docs-next (and at linux-next). > > ... > > This solves almost all problems we have. Still, there are a few places > > where we have two chapters at the same document with the > > same name. The first patch addresses this problem. > > I'm still seeing a lot of warnings. Am I doing something wrong? > > cheers > > /linux/Documentation/powerpc/cxl.rst:406: WARNING: duplicate label powerpc/cxl:open, other instance in /linux/Documentation/powerpc/cxl.rst ... > /linux/Documentation/powerpc/syscall64-abi.rst:86: WARNING: duplicate label powerpc/syscall64-abi:parameters and return value, other instance in /linux/Documentation/powerpc/syscall64-abi.rst ... > /linux/Documentation/powerpc/ultravisor.rst:339: WARNING: duplicate label powerpc/ultravisor:syntax, other instance in /linux/Documentation/powerpc/ultravisor.rst ... I can't reproduce your issue here at linux-next (+ my pending doc patches). So, I can only provide you some hints. If you see the logs you posted, all of them are related to duplicated labels inside the same file. - The new Sphinx module we're using (sphinx.ext.autosectionlabel) generates references for two levels, within the same document file (after this patch). Looking at the first document (at linux-next version), it has: 1) A first level document title: Coherent Accelerator Interface (CXL) 2) Several second level titles: Introduction Hardware overview AFU Modes MMIO space Interrupts Work Element Descriptor (WED) User API Sysfs Class Udev rules Right now, there's no duplication, but if someone adds, for example, another first-level or second-level title called "Interrupts", then the file will produce a duplicated label and Sphinx will warn. The same would happen if someone adds another title (either first level or second level) called "Coherent Accelerator Interface (CXL)", as this will conflict with the document title. - Now, if the title "Coherent Accelerator Interface (CXL)" got removed, then "Introduction".."Udev rules" will become first level titles. Then, the sections at the "User API": "open", "ioctl"... will become second level titles and it will produce lots of warnings. - That's said, IMHO, this document needs section titles for the two sections under "User API". Adding it would allow removing the document title. See enclosed. Thanks, Mauro powerpc: docs: cxl.rst: mark two section titles as such The User API chapter contains two sub-chapters. Mark them as such. Signed-off-by: Mauro Carvalho Chehab diff --git a/Documentation/powerpc/cxl.rst b/Documentation/powerpc/cxl.rst index 920546d81326..d2d77057610e 100644 --- a/Documentation/powerpc/cxl.rst +++ b/Documentation/powerpc/cxl.rst @@ -133,6 +133,7 @@ User API ======== 1. AFU character devices +^^^^^^^^^^^^^^^^^^^^^^^^ For AFUs operating in AFU directed mode, two character device files will be created. /dev/cxl/afu0.0m will correspond to a @@ -395,6 +396,7 @@ read 2. Card character device (powerVM guest only) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ In a powerVM guest, an extra character device is created for the card. The device is only used to write (flash) a new image on the