From: Andrew MacLeod <amacleod@redhat.com>
To: GCC <gcc@gcc.gnu.org>
Cc: Aldy Hernandez <aldyh@redhat.com>, Martin Liska <marxin.liska@gmail.com>
Subject: Documentation format question
Date: Wed, 25 May 2022 16:35:22 -0400 [thread overview]
Message-ID: <292db515-f6e7-f733-7ec0-c7a316dec2b5@redhat.com> (raw)
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.
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
next reply other threads:[~2022-05-25 20:35 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-05-25 20:35 Andrew MacLeod [this message]
2022-05-27 6:38 ` Richard Biener
2022-05-27 20:05 ` Andrew MacLeod
2022-05-30 12:43 ` Martin Liška
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=292db515-f6e7-f733-7ec0-c7a316dec2b5@redhat.com \
--to=amacleod@redhat.com \
--cc=aldyh@redhat.com \
--cc=gcc@gcc.gnu.org \
--cc=marxin.liska@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).