From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from smtp-out2.suse.de (smtp-out2.suse.de [195.135.220.29]) by sourceware.org (Postfix) with ESMTPS id 405C83858018; Tue, 8 Mar 2022 15:59:28 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org 405C83858018 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 imap2.suse-dmz.suse.de (imap2.suse-dmz.suse.de [192.168.254.74]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-521) server-digest SHA512) (No client certificate requested) by smtp-out2.suse.de (Postfix) with ESMTPS id 143DC1F380; Tue, 8 Mar 2022 15:59:27 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=suse.cz; s=susede2_rsa; t=1646755167; 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=znVHDmk+wATNk4pD8FqT+xx167UtdcEtOrh3TplPu8U=; b=XoqJs2ka8lqjWhu2GMH9WBL/V3pxtDMvYKFjr0hpH85ob31cE2RsY4BEP7SKy5VaBTwikd xUdVp8LtrPVSGz16tcarQnDLiGmP+UFfCiKa+DLmwW4W2JGC4UNrpIt+9NHDX6szvPWs6a 4Oy4lkdrmyplXwkTRZUbh5lqhCbE1PM= DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=suse.cz; s=susede2_ed25519; t=1646755167; 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=znVHDmk+wATNk4pD8FqT+xx167UtdcEtOrh3TplPu8U=; b=irp3hsrb4dhUa9EAU/92s0ODnKjN65XSSoK33coSWJTrY8Um21PclOlgZ5xVuSHQGANkYS HwLK9YuYwjFeI1DQ== Received: from imap2.suse-dmz.suse.de (imap2.suse-dmz.suse.de [192.168.254.74]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-521) server-digest SHA512) (No client certificate requested) by imap2.suse-dmz.suse.de (Postfix) with ESMTPS id E41A013CCE; Tue, 8 Mar 2022 15:59:26 +0000 (UTC) Received: from dovecot-director2.suse.de ([192.168.254.65]) by imap2.suse-dmz.suse.de with ESMTPSA id /+ezNl59J2JVZQAAMHmgww (envelope-from ); Tue, 08 Mar 2022 15:59:26 +0000 Message-ID: <3b761c5c-6df8-52c3-c6b8-36528e2d2d07@suse.cz> Date: Tue, 8 Mar 2022 16:59:26 +0100 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101 Thunderbird/91.6.1 Subject: Re: Porting the Docs to Sphinx - project status Content-Language: en-US To: Matthias Klose , GCC Patches , GCC Development Cc: Sandra Loosemore , "Joseph S. Myers" References: <9975b774-46d7-8870-fd92-498f5ec50ab4@suse.cz> <286a539a-ce4a-e016-bcde-8e9cbf24f793@ubuntu.com> From: =?UTF-8?Q?Martin_Li=c5=a1ka?= In-Reply-To: <286a539a-ce4a-e016-bcde-8e9cbf24f793@ubuntu.com> Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 8bit X-Spam-Status: No, score=-5.6 required=5.0 tests=BAYES_00, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, KAM_EU, KAM_SHORT, NICE_REPLY_A, SPF_HELO_NONE, SPF_PASS, TXREP, T_SCC_BODY_TEXT_LINE autolearn=no autolearn_force=no version=3.4.4 X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) 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: Tue, 08 Mar 2022 15:59:31 -0000 On 2/4/22 14:40, Matthias Klose wrote: > On 1/31/22 15:06, Martin Liška wrote: >> Hello. >> >> It's about 5 months since the last project status update: >> https://gcc.gnu.org/pipermail/gcc-patches/2021-August/577108.html >> Now it's pretty clear that it won't be merged before GCC 12.1 gets released. >> >> So where we are? I contacted documentation maintainers (Gerald, Sandra and >> Joseph) at the >> end of the year in a private email, where I pinged the patches. My take away is >> that both >> Gerald and Joseph are fine with the porting, while Sandra has some concerns. >> Based on her >> feedback, I was able to improve the PDF generated output significantly and I'm >> pleased by the >> provided feedback. That led to the following 2 Sphinx pulls requests that need >> to be merged >> before we can migrate the documentation: [1], [2]. >> >> Since the last time I also made one more round of proofreading and the layout >> was improved >> (mainly for PDF part). Current version of the documentation can be seen here: >> https://splichal.eu/scripts/sphinx/ >> >> I would like to finish the transition once GCC 12.1 gets released in May/June >> this year. >> There are still some minor regressions, but overall the Sphinx-based >> documentation should >> be a significant improvement over what we've got right now. >> >> Please take this email as urgent call for a feedback! > > Please take care about the copyrights. I only checked the D frontend manual, > and this one suddenly has a copyright with invariant sections, compared to the > current gdc.texi which has a copyright *without* the invariant sections. Debian > doesn't allow me to ship documentation with invariant sections ... Oh, thank you very much for the pointer. I didn't notice the Copyright sections differ quite a lot. It should be fixed now. > > I didn't look how much you reorganized the sources, but it would nice to split > the files into those documenting command line options (used to generate the man > pages) and other documentation. Well, the current splitting is done into multiple .rst files and a bunch of them actually constructs command line options. Please check View page source button on each HTML page. > This is already done for gcc/doc, but not for > other frontends. It would allow having manual pages with a copyright requiring > front and back cover texts in the manual pages. How exactly does it work? Does it mean you don't use official GCC tarballs? I would expect you just package built man/info pages and don't distribute PDF/HTML version of a documenation, or? > > It would also be nice to require the latest sphinx version (and probably some > plugins), so that distros can build the docs with older sphinx versions as well. I'm sorry but this would be very difficult. It's mainly caused by fact I've reported quite some changes to upstream, where having them leads to a reasonable HTML/PDF output. Note you can quite easily utilize pip&virtualenv for Sphinx installation. Cheers, Martin > > Matthias