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 35865385B83F; Mon, 9 Aug 2021 13:30:01 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org 35865385B83F 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 imap1.suse-dmz.suse.de (imap1.suse-dmz.suse.de [192.168.254.73]) (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 21B0E21F5C; Mon, 9 Aug 2021 13:30:00 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=suse.cz; s=susede2_rsa; t=1628515800; 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=OqR989jn8p22o2rBpv9Dhg808X/OUap3nVE/4AW/VFg=; b=xFzsWfBhL332tn11eeN00EVJz2ChQ/cZmHRx1EZ8MVayjMM4Lc5idrdcYhUwRy1WKrjAZN EbUctdm4TPOu1ElROs5Dve5xMvMesgaxHmykBCCZQwO+2Da15nRyn5lgvaDUuypqf0alGl z/nRsq5ZijyRSpjE29wW4+LqiHUPogM= DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=suse.cz; s=susede2_ed25519; t=1628515800; 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=OqR989jn8p22o2rBpv9Dhg808X/OUap3nVE/4AW/VFg=; b=YQFJC2EzspJSrHVCEOSJMHyNJa4eZ6BL7AzQoPrf9uBMxCoCDwtOF18PfD33fNedpHxyXf 0k4soBzW4mDqJADg== Received: from imap1.suse-dmz.suse.de (imap1.suse-dmz.suse.de [192.168.254.73]) (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 imap1.suse-dmz.suse.de (Postfix) with ESMTPS id 06883136C1; Mon, 9 Aug 2021 13:30:00 +0000 (UTC) Received: from dovecot-director2.suse.de ([192.168.254.65]) by imap1.suse-dmz.suse.de with ESMTPSA id J6SZANgtEWEhdQAAGKfGzw (envelope-from ); Mon, 09 Aug 2021 13:30:00 +0000 Subject: Re: [PATCH] Port GCC documentation to Sphinx To: Tamar Christina , Joseph Myers Cc: GCC Development , "gcc-patches@gcc.gnu.org" References: <1446990946.2994.192.camel@surprise> <1a22bc37-3d48-132f-a3d5-219471cd443c@suse.cz> <3a2a573b-5185-fff5-f9da-6e5e39953ad6@suse.cz> <8641dc55-5412-fbd7-bafd-13604311f5ad@suse.cz> <5ffe3e32-ece0-a1b4-1fcf-e35177fa80b5@suse.cz> <87489d9a-44e2-411c-3f3a-534d07e78b95@suse.cz> <0866a0ea-c846-ea5e-ac7a-d1c8f106cc45@suse.cz> <5bb9a10d-f3b9-f16a-7430-bbae2d4978e2@suse.cz> <2f60f602-5d88-7674-9620-2172748664c5@suse.cz> From: =?UTF-8?Q?Martin_Li=c5=a1ka?= Message-ID: <1dbb39dc-89c6-c3b6-73eb-55744a89d8d0@suse.cz> Date: Mon, 9 Aug 2021 15:29:59 +0200 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.12.0 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=-4.4 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=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: Mon, 09 Aug 2021 13:30:02 -0000 On 7/13/21 4:54 PM, Tamar Christina wrote: > Hi Martin, > >> -----Original Message----- >> From: Gcc-patches > bounces+tamar.christina=arm.com@gcc.gnu.org> On Behalf Of Martin Liška >> Sent: Tuesday, June 29, 2021 11:09 AM >> To: Joseph Myers >> Cc: GCC Development ; gcc-patches@gcc.gnu.org >> Subject: Re: [PATCH] Port GCC documentation to Sphinx >> >> On 6/28/21 5:33 PM, Joseph Myers wrote: >>> Are formatted manuals (HTML, PDF, man, info) corresponding to this >>> patch version also available for review? >> >> I've just uploaded them here: >> https://splichal.eu/gccsphinx-final/ >> > > Thanks for doing this 😊 > > I'm a primary user of the PDFs (easier to work offline) I do like the look and syntax highlighting of the new PDFs, > But I do prefer the way the current itemized entries are laid out. > > See for instance ` vect_interleave` which before would have the description indented on the next line, vs the new docs which puts it on the same line. Very useful comment. Generally when I look at gccint documentation, majority of documented "terms" are marked as @items in the Texinfo. In Sphinx, we should rather use a proper concrete type, like: :c:member: :c:data: :c:var: :c:func: :c:macro: :c:struct: :c:union: :c:enum: :c:enumerator: :c:type: These would improve the documentation when searching for something. I've got it listed for after migration phase. > > The visual break in my opinion makes it easier to read. It currently looks like a sea of text. Also purely personal I expect, but could the weight of the bold entries be reduced a bit? They look very BOLD to me atm and when there's a lot of them I find it slightly harder to read. That would be about a font selection for Latex, can you please experiment with: https://www.sphinx-doc.org/en/master/latex.html#the-latex-elements-configuration-setting ? Thanks, Martin > > Cheers, > Tamar > >> Martin >