From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from smtp-out1.suse.de (smtp-out1.suse.de [195.135.220.28]) by sourceware.org (Postfix) with ESMTPS id 436C63839C67; Thu, 3 Jun 2021 10:56:27 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org 436C63839C67 Authentication-Results: sourceware.org; dmarc=none (p=none dis=none) header.from=suse.cz Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=suse.cz Received: from imap.suse.de (imap-alt.suse-dmz.suse.de [192.168.254.47]) (using TLSv1.2 with cipher ECDHE-ECDSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp-out1.suse.de (Postfix) with ESMTPS id 7CDC8219D9; Thu, 3 Jun 2021 10:56:25 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=suse.cz; s=susede2_rsa; t=1622717785; h=from:from:reply-to:date:date:message-id:message-id:to:to:cc:cc: mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=ulmU4167qEfbdl4HJ/zxnGtqWW4nyXaRhJGMUncfJUA=; b=nrKnRD2ysadkDK+nkfrfh2ea7lpqglXuNwb7nFxBKCgKlw6xgxJqdGqoPKcfe91Ngdtd+e mpHQskwBNFboNAeU1/iXyPJvwqYtY0wnGWeJUEfHYqyPvrKodF+qx8BquKsvRKZoCRtL43 Ozr3M0IR3fEnxP3EQ1uvAo5fhX3KYx8= DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=suse.cz; s=susede2_ed25519; t=1622717785; h=from:from:reply-to:date:date:message-id:message-id:to:to:cc:cc: mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=ulmU4167qEfbdl4HJ/zxnGtqWW4nyXaRhJGMUncfJUA=; b=O9FwvYiWVBFkloHlMh051fA28yIX3Sb0ZmuFh0j1b0YbXmArv11fxm47lDtJVLXtllSpTu UWkHRfeT/rogdwCg== Received: from imap3-int (imap-alt.suse-dmz.suse.de [192.168.254.47]) by imap.suse.de (Postfix) with ESMTP id 3AA17118DD; Thu, 3 Jun 2021 10:56:25 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=suse.cz; s=susede2_rsa; t=1622717785; h=from:from:reply-to:date:date:message-id:message-id:to:to:cc:cc: mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=ulmU4167qEfbdl4HJ/zxnGtqWW4nyXaRhJGMUncfJUA=; b=nrKnRD2ysadkDK+nkfrfh2ea7lpqglXuNwb7nFxBKCgKlw6xgxJqdGqoPKcfe91Ngdtd+e mpHQskwBNFboNAeU1/iXyPJvwqYtY0wnGWeJUEfHYqyPvrKodF+qx8BquKsvRKZoCRtL43 Ozr3M0IR3fEnxP3EQ1uvAo5fhX3KYx8= DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=suse.cz; s=susede2_ed25519; t=1622717785; h=from:from:reply-to:date:date:message-id:message-id:to:to:cc:cc: mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=ulmU4167qEfbdl4HJ/zxnGtqWW4nyXaRhJGMUncfJUA=; b=O9FwvYiWVBFkloHlMh051fA28yIX3Sb0ZmuFh0j1b0YbXmArv11fxm47lDtJVLXtllSpTu UWkHRfeT/rogdwCg== Received: from director2.suse.de ([192.168.254.72]) by imap3-int with ESMTPSA id 45LpDFm1uGDjbAAALh3uQQ (envelope-from ); Thu, 03 Jun 2021 10:56:25 +0000 Subject: Re: GCC documentation: porting to Sphinx To: Martin Sebor , David Malcolm , gcc-patches@gcc.gnu.org Cc: GCC Development , "Joseph S. Myers" References: <1446990946.2994.192.camel@surprise> <1a22bc37-3d48-132f-a3d5-219471cd443c@suse.cz> <3a2a573b-5185-fff5-f9da-6e5e39953ad6@suse.cz> From: =?UTF-8?Q?Martin_Li=c5=a1ka?= Message-ID: <298e21f2-7d04-7a28-1827-e87f2e70d187@suse.cz> Date: Thu, 3 Jun 2021 12:56:24 +0200 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.10.2 MIME-Version: 1.0 In-Reply-To: Content-Type: text/plain; charset=utf-8; format=flowed Content-Language: en-US Content-Transfer-Encoding: 8bit X-Spam-Status: No, score=-3.5 required=5.0 tests=BAYES_00, BODY_8BITS, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, KAM_EU, NICE_REPLY_A, SPF_HELO_NONE, SPF_PASS, TXREP autolearn=ham autolearn_force=no version=3.4.2 X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on server2.sourceware.org X-BeenThere: gcc@gcc.gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Gcc mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 03 Jun 2021 10:56:29 -0000 On 6/2/21 10:41 PM, Martin Sebor wrote: > On 5/31/21 7:25 AM, Martin Liška wrote: >> Hello. >> >> I've made quite some progress with the porting of the documentation and >> I would like to present it to the community now: >> https://splichal.eu/scripts/sphinx/ > Hello. Thank you for the review. > Just a few issues I noticed in the warnings section: > > The headings of some warnings mention the same option twice (e.g., > -Wabi, -Wabi, -Wno-abi;  -Wdouble-promotion, -Wdouble-promotion, > -Wno-double-promotion;  -Winit-self, -Winit-self, -Wno-init-self). > This looks like a pretty pervasive problem. You are right, I fixed that. > > Mentioning the -Wno-xxx option is redundant in a heading for -Wxxx. Yes. Good reason for that is that Sphinx can then generated properly links to the current non-documented version of the option. Hope it's improvement over the current situation? > > The headings of some other warnings also mention options that are > only remotely related to them.  E.g., -Wformat has all these: > >   -Wformat, -Wno-format, -ffreestanding, -fno-builtin, -Wformat= > > (I see the same problem in the attributes section where the headings > for some attributes include option names). > > That seems quite puzzling.  I assume it's a consequence of having > index entries for the related options, but I don't think making > them visible in the headings is helfpful. Oh, you are right. It was consequence of wrong parsing of index entries. It should be fixed now. > > Headings that in the manual today include a level like > >   -Wformat-overflow >   -Wformat-overflow=level > > don't mention the level in the Spinx manual: > >   -Wformat-overflow, -Wno-format-overflow > > When the /level/ is then discussed in the rest of the text it's > not clear what it refers to. Should be also fixed now. Can you please take a look at the current output and give me a feedback? Thanks, Martin > > Martin > >> >> Note the documentation is automatically ([1]) generated from texinfo with a GitHub workflow ([2]). >> It's built on the devel/sphinx GCC branch which I periodically with the master branch. One can >> see the current source .rst files here: [3]. >> >> Changes made since the last time: >> - a shared content is factored out ([4]) >> - conditional build is fully supported (even for shared parts) >> - manual pages look reasonable well >> - folders are created for files which have >= 5 TOC tree entries >> - various formatting issues were resolved >> - baseconf.py reads BASE-VER, DEV-PHASE, .. files >> >> I've got couple of questions: >> >> 1) Do we have to you the following cover text? >>         Copyright (c) 1988-2020 Free Software Foundation, Inc. >> >>         Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with the Invariant Sections being "GNU General Public >>         License" and "Funding Free Software", the Front-Cover texts being (a) (see below), and with the Back-Cover Texts being (b) (see below).  A copy of the license is included in the gfdl(7) man page. >> >>         (a) The FSF's Front-Cover Text is: >> >>              A GNU Manual >> >>         (b) The FSF's Back-Cover Text is: >> >>              You have freedom to copy and modify this GNU Manual, like GNU >>              software.  Copies published by the Free Software Foundation raise >>              funds for GNU development. >> >> 2) Do we want to generate fsf-funding, gpl and gfdl manual pages? >> 3) Do we want to preserve the current strange copy mechanism for ./gcc/doc/tm.texi.in ? >> 4) Do we want a copyright header for the created .rst files? >> >> Thoughts? >> Thanks, >> Martin >> >> [1] https://github.com/davidmalcolm/texi2rst >> [2] https://github.com/davidmalcolm/texi2rst/actions >> [3] https://github.com/marxin/texi2rst-generated/tree/master/sphinx >> [4] https://github.com/marxin/texi2rst-generated/tree/master/sphinx/share >