From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from esa1.mentor.iphmx.com (esa1.mentor.iphmx.com [68.232.129.153]) by sourceware.org (Postfix) with ESMTPS id 9AD5438618BB; Fri, 11 Jun 2021 15:50:18 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org 9AD5438618BB Authentication-Results: sourceware.org; dmarc=none (p=none dis=none) header.from=codesourcery.com Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=mentor.com IronPort-SDR: MOgmrKfvNCdOYMlHw8rJgvMYKBQrgOaarMoxQwxX7rHDm/SeIRIv835JAd0vQM7wWkqNJghgOa Dw0988lWPUswWC8qVNReJr0XdybmOYz+MSBsxrK3CKNXHEgAXt297dkcor/pWTS7bhP4mr6lCR 9+b+sYdE4GNOSMlnCjfMljMN6SDEZBkpLHhAHsXUchZPFxdjmlQf8b0bmDRBrIu/g0LGi6LQuw 78xCcK6dssO7/3IQzH2JPhQNGvCoJty7krki4n6bImb6V+9oM5jswVG5m0yIVromvsy3rldvPR JLw= X-IronPort-AV: E=Sophos;i="5.83,265,1616486400"; d="scan'208";a="64725323" Received: from orw-gwy-02-in.mentorg.com ([192.94.38.167]) by esa1.mentor.iphmx.com with ESMTP; 11 Jun 2021 07:50:17 -0800 IronPort-SDR: gS5JKP2VzW5CDZuRph+Lw1hdOWvRaE0bx2oQilBuAI6dfrQxMVTsMNaEcF2/zoIOuIVa51k7bX eFACz5fxGUDZsfsOw3wPZcDx4OM7SmZM0Af65nm1zR3p9wbchbwMlcySJ6KS4dBdVeER1cPCl5 4KldoBpssNMQYd5EE8oRcQ3EhxTcOpb7lZOqn8QMDTwHqkTPp3ItiH38+Da/UP3C34QTU8c/CA KffuxmXjh5b6FGcBZakhTLdZPRccDB7yHNzYYc6rb+FVstWnC3PynoKCcIL/pP/CBt0yHPr4Lq ino= Date: Fri, 11 Jun 2021 15:50:12 +0000 From: Joseph Myers X-X-Sender: jsm28@digraph.polyomino.org.uk To: =?ISO-8859-15?Q?Martin_Li=A8ka?= CC: GCC Development , Subject: Re: GCC documentation: porting to Sphinx In-Reply-To: Message-ID: 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> User-Agent: Alpine 2.22 (DEB 394 2020-01-19) MIME-Version: 1.0 X-Originating-IP: [137.202.0.90] X-ClientProxiedBy: SVR-IES-MBX-07.mgc.mentorg.com (139.181.222.7) To svr-ies-mbx-01.mgc.mentorg.com (139.181.222.1) X-Spam-Status: No, score=-3120.7 required=5.0 tests=BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS, KAM_DMARC_STATUS, SPF_HELO_PASS, SPF_PASS, TXREP autolearn=no autolearn_force=no version=3.4.2 X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on server2.sourceware.org Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 8BIT X-Content-Filtered-By: Mailman/MimeDel 2.1.29 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 15:50:20 -0000 On Fri, 11 Jun 2021, Martin Liška wrote: > > 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 I'm thinking of $gccroot/gcc/fortran/doc $gccroot/gcc/go/doc (or subdirectories thereof if desired) for the Fortran and Go manuals, so they go alongside the front end sources. > The Sphinx Makefile will be capable of e.g. My concern with makefiles is what the main GCC build system does, with "make" run at the top level of the build tree and with the targets defined by the GNU Coding Standards, not with what happens if someone manually does make in a subdirectory of the source or build tree. "make" at top level should build all the info manuals and man pages, as at present (if a suitable Sphinx version is installed), and "make install" should install them, in the same directories as at present. "make html" at top level should build all the HTML manuals, and "make install-html" should install them. "make pdf" and "make install-pdf" at top level should work likewise. "make install-html" and "make install-pdf" should put things under $(DESTDIR)$(htmldir) and $(DESTDIR)$(pdfdir) as at present. -- Joseph S. Myers joseph@codesourcery.com