From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by sourceware.org (Postfix) with ESMTPS id DE35E383B7B6 for ; Fri, 27 May 2022 20:05:28 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org DE35E383B7B6 Received: from mail-qv1-f69.google.com (mail-qv1-f69.google.com [209.85.219.69]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-518-EJIZLg8aNjyFQpqsdjtEaA-1; Fri, 27 May 2022 16:05:27 -0400 X-MC-Unique: EJIZLg8aNjyFQpqsdjtEaA-1 Received: by mail-qv1-f69.google.com with SMTP id q36-20020a0c9127000000b00461e3828064so4293290qvq.12 for ; Fri, 27 May 2022 13:05:27 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:message-id:date:mime-version:user-agent:subject :content-language:to:cc:references:from:in-reply-to :content-transfer-encoding; bh=9YhWHGMFhQenyVJTmm5on6oQKP/tpBF2cpO8ZWDkN5A=; b=fOk2bQXVDYcFUlI0TFMJxBGOj+VhmoEeIfrxmxgbdUEV+4UfaJjityVEZm3V/6x3Cx FLhfdlISSLc0ycczYFfx7BR3P4sgBfxreGbmrPwet8WqeWZDWi7Y64ZjWsj59p1rHmjq 3vobp2ZvzVN+QcbyyeAx1dTaU4P2J2xZ8gaiYUsICIXV6HXPBjAXAQ2W+lcvAVdDT9jS CaWSoBrNCIUcQgQhfDQVQULogubyFu+oC9GPKsgb3BTY4kqQ73YhCheLbxDUAyYIoHY/ F+W9e28iFH5PmS7SnBcMCoNDKYRWfDA3+xlPYMngQYVckQJcBgKdfUxyntGluG4jvQmI UDEA== X-Gm-Message-State: AOAM533ZeGR6/cZz8lDRF4fqu9itLAjO1OO3K00vlryWY0Lsl80Wfv9t EIE6eSZ3Z/+ZG6LFVGbLXqVeQSKkNgDJeXTfzZ/Z+/hjhagoZJL6bFJMMRplNoX1/1O8g3TZHtn aWUZ1aK8= X-Received: by 2002:ae9:c214:0:b0:6a0:cde4:4a5d with SMTP id j20-20020ae9c214000000b006a0cde44a5dmr29325855qkg.737.1653681926998; Fri, 27 May 2022 13:05:26 -0700 (PDT) X-Google-Smtp-Source: ABdhPJzcuhXJVR4lWruELTpwgPDlsMU82O6283BT0Vb4vNqUxlwsLnFCNIZ6VRGpRJ5FAiT5N1h6fg== X-Received: by 2002:ae9:c214:0:b0:6a0:cde4:4a5d with SMTP id j20-20020ae9c214000000b006a0cde44a5dmr29325842qkg.737.1653681926780; Fri, 27 May 2022 13:05:26 -0700 (PDT) Received: from ?IPV6:2607:fea8:a261:5e00:6701:24de:7b30:568f? ([2607:fea8:a261:5e00:6701:24de:7b30:568f]) by smtp.gmail.com with ESMTPSA id p1-20020a37bf01000000b0069fc13ce1e3sm3352455qkf.20.2022.05.27.13.05.25 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Fri, 27 May 2022 13:05:25 -0700 (PDT) Message-ID: <70210169-c952-d821-6263-4a9a716b0a69@redhat.com> Date: Fri, 27 May 2022 16:05:24 -0400 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 To: Richard Biener Cc: GCC , Martin Liska References: <292db515-f6e7-f733-7ec0-c7a316dec2b5@redhat.com> From: Andrew MacLeod In-Reply-To: X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Language: en-CA Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 8bit X-Spam-Status: No, score=-7.3 required=5.0 tests=BAYES_00, DKIMWL_WL_HIGH, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, NICE_REPLY_A, RCVD_IN_DNSWL_NONE, SPF_HELO_NONE, SPF_NONE, 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 20:05:30 -0000 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?    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. Andrew