From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-qv1-xf2d.google.com (mail-qv1-xf2d.google.com [IPv6:2607:f8b0:4864:20::f2d]) by sourceware.org (Postfix) with ESMTPS id DA28D383E69F for ; Fri, 27 May 2022 06:39:01 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org DA28D383E69F Received: by mail-qv1-xf2d.google.com with SMTP id em1so3051746qvb.7 for ; Thu, 26 May 2022 23:39:01 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=y4Y9p2m+b1mWPZm1l422jjEqDpLS5gUBJ6pDF6A3Z84=; b=SjixbQ529RI+qFZ9lh0FwtAokOg+Krkiu1hc93ZvGjS74aH/iufC1i6HGkesI77J7G B3iRiAzOPfNM+C0d8v0/Tuh0c6QKMQENH/bIfxTz9gXxTVlUS5/PjHD4mOIquY7XJyzH BEJmSt3oJyRA1fNx6Upnhto6EghbC6CEI6UtgstReyoR0XRAeTXxIVz1MREjVP5myXVg TZzyE5EgRCgR0jetFdyCnn00j+Vyk6dGGvitTxzHvjv1pTATFsEMHTB20PBh6FTaatEh vdu3jLUz7L60NKyfT+UqfytXuBivQPB6GCk3zll9vPQDTxxRri+vLKCC3sKCKXyc0xnh 4rtQ== X-Gm-Message-State: AOAM532xYCc0QdObGqWT9V+DAeEswZ0OQKA6GIMKY9OsJCfuAn9uyj9V aKBXWDcphxAiHXFJzdabxsvuVj4LLNKQ5RD48lA= X-Google-Smtp-Source: ABdhPJz1F6mfKAN8YqRx3tBkfBC5YD6axgJfAGMcqCFnr1luenm8e92QCOEORUpATmJ0lrjw05UinygBL9zumflm5/U= X-Received: by 2002:ad4:5ba6:0:b0:462:305c:83a5 with SMTP id 6-20020ad45ba6000000b00462305c83a5mr22340479qvq.34.1653633541238; Thu, 26 May 2022 23:39:01 -0700 (PDT) MIME-Version: 1.0 References: <292db515-f6e7-f733-7ec0-c7a316dec2b5@redhat.com> In-Reply-To: <292db515-f6e7-f733-7ec0-c7a316dec2b5@redhat.com> From: Richard Biener Date: Fri, 27 May 2022 08:38:49 +0200 Message-ID: Subject: Re: Documentation format question To: Andrew MacLeod Cc: GCC , Martin Liska Content-Type: text/plain; charset="UTF-8" X-Spam-Status: No, score=-1.9 required=5.0 tests=BAYES_00, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, FREEMAIL_FROM, RCVD_IN_DNSWL_NONE, 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: Fri, 27 May 2022 06:39:03 -0000 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/ > It would be nice if we had a central plan/direction that we were looking > to adopt. Is there such a thing I'm simply not aware of because I don't > pay enough attention? I heard rumors on a gdb conversation that Marxin > is dabbling/using/trying something for gcc docs? > > Andrew > > >