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 B861B3835404; Wed, 2 Jun 2021 07:36:01 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org B861B3835404 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 827932193D; Wed, 2 Jun 2021 07:36:00 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=suse.cz; s=susede2_rsa; t=1622619360; 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=T5DWDxK703owbJOVQyx1BJgsabXno0YrX61JUhLbloY=; b=AJ0v51fCLIDBXbZenJBWjf2glRObWNg2e4T63WFHrPUgN/nZO5P8fSY9535gqJPAQ1FM6k QBlBlxz6io+4vT/Ldfp0Xl1JTNdWfJ3JrkFTtnsg1teVCcGilg+tWI7w/RQsi8SQDdAgA9 9HuidB3OPskMJLuSswy/M8fbZBs9V0I= DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=suse.cz; s=susede2_ed25519; t=1622619360; 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=T5DWDxK703owbJOVQyx1BJgsabXno0YrX61JUhLbloY=; b=L9vsv7yPyvb5oKd+6kLth2E2Vu0fda0LgHt2H1My+ZiUm2rt6kGAMXs/TZ/73l8bZ21geK sMyLAWRPZEsUy0BQ== Received: from imap3-int (imap-alt.suse-dmz.suse.de [192.168.254.47]) by imap.suse.de (Postfix) with ESMTP id 58F2D118DD; Wed, 2 Jun 2021 07:36:00 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=suse.cz; s=susede2_rsa; t=1622619360; 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=T5DWDxK703owbJOVQyx1BJgsabXno0YrX61JUhLbloY=; b=AJ0v51fCLIDBXbZenJBWjf2glRObWNg2e4T63WFHrPUgN/nZO5P8fSY9535gqJPAQ1FM6k QBlBlxz6io+4vT/Ldfp0Xl1JTNdWfJ3JrkFTtnsg1teVCcGilg+tWI7w/RQsi8SQDdAgA9 9HuidB3OPskMJLuSswy/M8fbZBs9V0I= DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=suse.cz; s=susede2_ed25519; t=1622619360; 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=T5DWDxK703owbJOVQyx1BJgsabXno0YrX61JUhLbloY=; b=L9vsv7yPyvb5oKd+6kLth2E2Vu0fda0LgHt2H1My+ZiUm2rt6kGAMXs/TZ/73l8bZ21geK sMyLAWRPZEsUy0BQ== Received: from director2.suse.de ([192.168.254.72]) by imap3-int with ESMTPSA id qR21FOA0t2CkYwAALh3uQQ (envelope-from ); Wed, 02 Jun 2021 07:36:00 +0000 Subject: Re: GCC documentation: porting to Sphinx To: Michael Matz Cc: David Malcolm , gcc-patches@gcc.gnu.org, 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: Date: Wed, 2 Jun 2021 09:36:00 +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=-5.1 required=5.0 tests=BAYES_00, 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: Wed, 02 Jun 2021 07:36:12 -0000 On 6/1/21 3:31 PM, Michael Matz wrote: > Hello, > > On Tue, 1 Jun 2021, Martin Liška wrote: > >> On 5/31/21 5:49 PM, Michael Matz wrote: >>> Hello Martin, >>> >>> On Mon, 31 May 2021, Martin Liška wrote: >>> >>>> 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/ >>>> Note the documentation is automatically ([1]) generated from texinfo with >>>> a >>>> GitHub workflow ([2]). >>> >>> One other thing I was recently thinking about, in the Spinx vs. texinfo >>> discussion: locally available documentation browsable/searchable in >>> terminal with info(1) (or equivalents). >> >> Yes, that's handy. >> >>> I think the above (i.e. generating .rst from the texinfo file) would >>> immediately nullify all my worries. So, just to be extra sure: your >>> proposal now is to generate the .rst files, and that .texinfo remains >>> the maintained sources, right? >> >> No, .texinfo files will be gone. However, Sphinx can output to info >> format: >> https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-M > > I see, that's good to hear. > >> And I've just added the generated Info pages here: >> https://splichal.eu/scripts/sphinx/ > > Okay, but there's something amiss, just compare a local gcc.info with > that. The sphinx generated one seems to only contain command line > options, but none of the other topics, in particular it seems to contain > the "Invoking GCC" chapter (and only that) as top-level, and all other > ones are missing (like "C implementation", "C++ implementation", "C > extension", and so on). You are right, I reduced that to 'Invoking GCC', which is simply what 'man gcc' presents. However, I moved that back to the entire GCC manual what you can see now in the info page. > > Looking at gccint.info I also seem quite some confusion, it's unclear to > me if content is missing or not. But e.g. the top-level structure has a > different order (a less logical one, this one is btw. shared with the > order of the HTML generated docu, so it's probably specific to sphinx > setup or such). Yes, the organization was bad and I fixed that. Now it's much better. Martin > > Ignoring that missing content what is there right now does seem somewhat > acceptable for local use, though. > > > Ciao, > Michael. >