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 F2D9B393AC00; Fri, 11 Jun 2021 14:33:47 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org F2D9B393AC00 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 9940321969; Fri, 11 Jun 2021 14:33:46 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=suse.cz; s=susede2_rsa; t=1623422026; 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=O8GKzCmrvKH19o7Zca6VQ9GF9G6tCtHE2V1QkJ6Df+k=; b=3JXld9bJmDWEa15EJXmlfv5v8dbUHTh2/9Uc7pDWbVP9VqPYpCylxJVkTpq4IYUN3x0Dhx iQDI0thdE5k50Ued1/PqblvckVccdsWMMSHeU3q9wTExa+kqjvcjP07BCWlO0KpLuM1Kvd ccshIGj+YtjGmi+CJQv8VDbpYH5SXy4= DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=suse.cz; s=susede2_ed25519; t=1623422026; 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=O8GKzCmrvKH19o7Zca6VQ9GF9G6tCtHE2V1QkJ6Df+k=; b=iA6rZgIxdpy4ZXxcTpatWeuXcUM05HKxRTjQ9KUiVzkurKNTwycRQX74UrsI+T8+/fIDij ER2H4Yxigzi9T6Dg== Received: from imap3-int (imap-alt.suse-dmz.suse.de [192.168.254.47]) by imap.suse.de (Postfix) with ESMTP id 77030118DD; Fri, 11 Jun 2021 14:33:46 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=suse.cz; s=susede2_rsa; t=1623422026; 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=O8GKzCmrvKH19o7Zca6VQ9GF9G6tCtHE2V1QkJ6Df+k=; b=3JXld9bJmDWEa15EJXmlfv5v8dbUHTh2/9Uc7pDWbVP9VqPYpCylxJVkTpq4IYUN3x0Dhx iQDI0thdE5k50Ued1/PqblvckVccdsWMMSHeU3q9wTExa+kqjvcjP07BCWlO0KpLuM1Kvd ccshIGj+YtjGmi+CJQv8VDbpYH5SXy4= DKIM-Signature: v=1; a=ed25519-sha256; c=relaxed/relaxed; d=suse.cz; s=susede2_ed25519; t=1623422026; 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=O8GKzCmrvKH19o7Zca6VQ9GF9G6tCtHE2V1QkJ6Df+k=; b=iA6rZgIxdpy4ZXxcTpatWeuXcUM05HKxRTjQ9KUiVzkurKNTwycRQX74UrsI+T8+/fIDij ER2H4Yxigzi9T6Dg== Received: from director2.suse.de ([192.168.254.72]) by imap3-int with ESMTPSA id Lz4WHEp0w2CvegAALh3uQQ (envelope-from ); Fri, 11 Jun 2021 14:33:46 +0000 Subject: Re: GCC documentation: porting to Sphinx To: 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> From: =?UTF-8?Q?Martin_Li=c5=a1ka?= Message-ID: Date: Fri, 11 Jun 2021 16:33:46 +0200 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.11.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.7 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 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: Fri, 11 Jun 2021 14:33:49 -0000 On 6/10/21 6:49 PM, Joseph Myers wrote: > On Thu, 10 Jun 2021, Martin Liška wrote: > >> 1) Can we organize the new documentation in $gccroot/doc folder >> similarly to what I have in texi2rst-generated repo? Would be beneficial >> as we can have a single Makefile and shared content will be in a same >> depth to the individual manuals. > > Where languages have their own manuals, I think it's more appropriate for > those to go under the language-specific directories. So it will require the following folder structure: $gccroot/gcc/doc/gcc - for GCC documentation $gccroot/gcc/doc/gccint - for GCC internal documentation $gccroot/gcc/doc/gfortran - for Fortran documentation $gccroot/gcc/doc/gccgo - for GO documentation ... $gccroot/doc/share - shared components $gccroot/libgomp/doc - for libgomp documentation ... Are you fine with that? > > That doesn't stop the use of shared makefile code. Make-lang.in is a > fragment included from gcc/Makefile.in ("-include $(LANG_MAKEFRAGS)"). I > certainly expect it should be possible to write GNU make code in > gcc/Makefile.in for building and installing manuals, such that > subdirectories only need to define a few variables describing what manuals > they have and everything else is handled by common code. > The Sphinx Makefile will be capable of e.g. make html -C $gccroot/gcc/doc/gcc BUILDDIR=`pwd/put_it_somewhere` and the only configure dependency will VERSION_PACKAGE and BUGURL which will be provided in env: https://github.com/marxin/texi2rst-generated/blob/6cfcb7b8ae6497d49ea23a38262dfa26854bdb40/sphinx/baseconf.py#L38-L39 Martin