From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from smtp-out1.suse.de (smtp-out1.suse.de [IPv6:2001:67c:2178:6::1c]) by sourceware.org (Postfix) with ESMTPS id 7A4E73858D3C; Wed, 19 Oct 2022 09:22:48 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org 7A4E73858D3C Authentication-Results: sourceware.org; dmarc=none (p=none dis=none) header.from=suse.cz Authentication-Results: sourceware.org; spf=fail 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-out1.suse.de (Postfix) with ESMTPS id 6CB6322C5F; Wed, 19 Oct 2022 09:22:47 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=suse.cz; s=susede2_rsa; t=1666171367; 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=XgD4QXtMqdMBkW4okUkjDUkdnJfxvVk4ZkUz6n8lRJ8=; b=uBV26CloHoK9rseLzJ035Pw5WViNzwaPOTt8qgzwdWoc+gWuPF3SlXf4gIZ6tZICTJIs9C FP6HS3ZT7V1koQ7xn2zKMWbeJjY1hhJUBJmJ2BbYX7Rolo3pxHfk6hs7JGUXD4ImZX5/OV a8Rlx+BA2VQMADjUTMHpiC9/7a/OHjo= DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=suse.cz; s=susede2_ed25519; t=1666171367; 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=XgD4QXtMqdMBkW4okUkjDUkdnJfxvVk4ZkUz6n8lRJ8=; b=Lf4xKALHYfKSIgGRWUcSnp6i0pvKUDxXuCdgZF7ippdcOwT6T5F9Rmpd51ajQSKQkUSNxJ 4CW5Ebu3X9IfRWDQ== 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 3F11913A36; Wed, 19 Oct 2022 09:22:47 +0000 (UTC) Received: from dovecot-director2.suse.de ([192.168.254.65]) by imap2.suse-dmz.suse.de with ESMTPSA id JWh9DufBT2MSfwAAMHmgww (envelope-from ); Wed, 19 Oct 2022 09:22:47 +0000 Message-ID: Date: Wed, 19 Oct 2022 11:22:46 +0200 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101 Thunderbird/102.3.3 Subject: Re: Announcement: Porting the Docs to Sphinx - 9. November 2022 Content-Language: en-US To: Paul Iannetta Cc: GCC Patches , GCC Development , Sandra Loosemore , "Joseph S. Myers" References: <9975b774-46d7-8870-fd92-498f5ec50ab4@suse.cz> <9ea57a95-fefe-81a3-848e-ede0893f5b61@suse.cz> <8198573b-89e2-a232-3e33-0e5c4153c112@suse.cz> <20221017141610.zaoysaggompepcij@ws2202.lin.mbt.kalray.eu> <20221019081355.mha6ztlc57rraljr@ws2202.lin.mbt.kalray.eu> From: =?UTF-8?Q?Martin_Li=c5=a1ka?= In-Reply-To: <20221019081355.mha6ztlc57rraljr@ws2202.lin.mbt.kalray.eu> Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-Spam-Status: No, score=-5.9 required=5.0 tests=BAYES_00,DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,KAM_EU,KAM_SHORT,NICE_REPLY_A,RCVD_IN_DNSWL_LOW,SPF_HELO_NONE,SPF_SOFTFAIL,TXREP autolearn=no autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org List-Id: On 10/19/22 10:13, Paul Iannetta wrote: > On Wed, Oct 19, 2022 at 09:24:06AM +0200, Martin Liška wrote: >> On 10/17/22 16:16, Paul Iannetta wrote: >>> Hi Martin, >>> >>> Thank you very much for porting the documentation to Sphinx, it is >>> very convenient to use, especially the menu on the left and the >>> search bar. >> >> Thanks, I also like it! >> >>> >>> However, I also regularly browse and search the documentation through >>> info, especially when I want to use regexps to search or need to >>> include a special character (eg.,+,-,_,(; this can happen when I >>> search for '(define' ) for example) in the search string. >>> >>> Does the port to Sphinx means the end of texinfo? Or, will both be >>> available as it is the case now with the official texinfo and your >>> unofficial splichal.eu pages. >> >> It will be still available same as now where manual pages and info pages >> are built if you compile GCC from sources. We haven't been publishing manual >> pages and info pages on our web pages, people typically get these from >> their distribution packages. > > As long as it is possible to build the info manual with "make info", even through > something like rst2texinfo, I would be happy. Would it be possible > to see the rst source of the port so as to try rst2texinfo on it? Well, .rst source files can be seen right now here: https://github.com/marxin/texi2rst-generated And 'texinfo' is created with the standard Sphinx builder: https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-b > >> >> Does it help? Or do you expect any change regarding what we publish at: >> https://gcc.gnu.org/onlinedocs/ >> ? > Currently, there is a tarball with texinfo sources for all the manuals > for each version. Well, then equivalent would be packaging all .rst files together with the corresponding conf.py, logo.* and other files. But I don't see it much useful. Thanks, Martin > > Thanks, > Paul > >> >> Cheers, >> Martin >> >>> >>> Paul >>> >>> On Mon, Oct 17, 2022 at 03:28:34PM +0200, Martin Liška wrote: >>>> Hello. >>>> >>>> Based on the very positive feedback I was given at the Cauldron Sphinx Documentation BoF, >>>> I'm planning migrating the documentation on 9th November. There are still some minor comments >>>> from Sandra when it comes to the PDF output, but we can address that once the conversion is done. >>>> >>>> The reason I'm sending the email now is that I was waiting for latest Sphinx release (5.3.0) that >>>> simplifies reference format for options and results in much simpler Option summary section ([1]) >>>> >>>> The current GCC master (using Sphinx 5.3.0) converted docs can be seen here: >>>> https://splichal.eu/scripts/sphinx/ >>>> >>>> If you see any issues with the converted documentation, or have a feedback about it, >>>> please reply to this email. >>>> >>>> Cheers, >>>> Martin >>>> >>>> [1] https://github.com/sphinx-doc/sphinx/pull/10840 >>>> [1] https://splichal.eu/scripts/sphinx/gcc/_build/html/gcc-command-options/option-summary.html >>>> >>>> >>>> >>>> >>> >>> >>> >>> >> >> >> >> >> > > > >