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 854693853804 for ; Mon, 30 May 2022 12:43:09 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org 854693853804 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-out1.suse.de (Postfix) with ESMTPS id 76E8E21B00; Mon, 30 May 2022 12:43:08 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=suse.cz; s=susede2_rsa; t=1653914588; 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=60Y4p2Sh3Bh0WWaDFKL0RV3HuLuihl45Ow4LKN6aPLM=; b=EVNnfjgoaL3eF+eX74Qt5RL59kP2uEPlT6JNOA3LqHIXqUw8y01O9hVcuShGHXRzWcHXup N3u1Wy+xiYtRbevPv8syZ/3ba/0TzAuWgUTPjjSV/Nx5OshARPcnhosmn+zzlQBq60Zjjp iYDjcxGbEh7xqMMz5o9gQogMerj42MU= DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=suse.cz; s=susede2_ed25519; t=1653914588; 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=60Y4p2Sh3Bh0WWaDFKL0RV3HuLuihl45Ow4LKN6aPLM=; b=z9uFGb5SbSvcqSnCyKozeBB6voQRd1/rOMZEdnuPV01RdB6Yeyi4xPvyP5ouZcMEaFzdYk pK9l4mRJwatNChBA== 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 5B37713AFD; Mon, 30 May 2022 12:43:08 +0000 (UTC) Received: from dovecot-director2.suse.de ([192.168.254.65]) by imap2.suse-dmz.suse.de with ESMTPSA id g8NlFNy7lGKYHgAAMHmgww (envelope-from ); Mon, 30 May 2022 12:43:08 +0000 Message-ID: <4da66eb8-b54b-f8ca-65c6-0876144f9fcb@suse.cz> Date: Mon, 30 May 2022 14:43:07 +0200 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101 Thunderbird/91.9.1 Subject: Re: Documentation format question Content-Language: en-US To: Andrew MacLeod , Richard Biener Cc: GCC , Martin Liska References: <292db515-f6e7-f733-7ec0-c7a316dec2b5@redhat.com> <70210169-c952-d821-6263-4a9a716b0a69@redhat.com> From: =?UTF-8?Q?Martin_Li=c5=a1ka?= In-Reply-To: <70210169-c952-d821-6263-4a9a716b0a69@redhat.com> Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-Spam-Status: No, score=-6.1 required=5.0 tests=BAYES_00, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, NICE_REPLY_A, SPF_HELO_NONE, SPF_PASS, TXREP, T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) 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: Mon, 30 May 2022 12:43:10 -0000 On 5/27/22 22:05, Andrew MacLeod via Gcc wrote: > On 5/27/22 02:38, Richard Biener wrote: >> On Wed, May 25, 2022 at 10:36 PM Andrew MacLeod via Gcc wrote: >>> I am going to get to some documentation for ranger and its components >>> later this cycle. >>> >>> I use to stick these sorts things on the wiki page, but i find that gets >>> out of date really quickly.  I could add more comments to the top of >>> each file, but that doesnt seem very practical for larger architectural >>> descriptions, nor for APIs/use cases/best practices.   I could use >>> google docs and turn it into a PDF or some other format, but that isnt >>> very flexible. >>> >>> Do we/anyone have any forward looking plans for GCC documentation that I >>> should consider using?  It would be nice to be able to tie some of it >>> into source files/classes in some way, but I am unsure of a decent >>> direction.  It has to be easy to use, or I wont use it :-)  And i >>> presume many others wouldn't either.  Im not too keep an manually >>> marking up text either. >> The appropriate place for this is the internals manual and thus the >> current format in use is texinfo in gcc/doc/ >> > And there is no move to convert it to anything more modern? Hi. Yes, there's plan moving to Sphinx for GCC 13, but I'm currently stuck with Sphinx upsteam where I have a pending pull requests. Hopefully, I'll return to it soon. >    Is there at least a reasonable tool to be able to generate texinfo from?  Otherwise the higher level stuff is likely to end up in a wiki page where I can just visually do it. But as Richi wrote, if you write it in Texinfo, then I can easily convert it (I'll be doing the same for the rest of manuals). In your case, you can experiment with Sphinx (similarly to libgccjit), and then export texinfo, similarly to what libgccjit does. Martin > > Andrew > >