public inbox for gdb-patches@sourceware.org
 help / color / mirror / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Tom de Vries <tdevries@suse.de>
Cc: gdb-patches@sourceware.org
Subject: Re: gdb and sphinx documentation
Date: Sun, 18 Sep 2022 16:20:02 +0300	[thread overview]
Message-ID: <837d20zunx.fsf@gnu.org> (raw)
In-Reply-To: <c37bd31e-1c40-8c2e-cc35-5e9f31930bc4@suse.de> (message from Tom de Vries on Sun, 18 Sep 2022 10:31:43 +0200)

> Date: Sun, 18 Sep 2022 10:31:43 +0200
> Cc: Eli Zaretskii <eliz@gnu.org>
> From: Tom de Vries <tdevries@suse.de>
> 
> Hi,
> 
> at the GNU Cauldron, Martin Liška presented a BOF about migrating GCC 
> documentation to sphinx format ( 
> https://gcc.gnu.org/wiki/cauldron2022#cauldron2022talks.the_sphinx_documentation_bof 
> ).
> 
> I asked him about the gdb documentation, and he ran the migration 
> scripts he used for gcc on it.  The result is obviously a bit rough, but 
> gives a nice idea what it could look like.
> 
> Please take a look if you're interested ( https://splichal.eu/tmp/gdb ).

I also suggest to become familiar with the long discussion of this on
the GCC list:

  https://gcc.gnu.org/pipermail/gcc/2021-June/236172.html
  https://gcc.gnu.org/pipermail/gcc/2021-June/236604.html
  https://gcc.gnu.org/pipermail/gcc/2021-July/236638.html
  https://gcc.gnu.org/pipermail/gcc/2021-July/236731.html

and with the POV of the Texinfo maintainer:

  https://gcc.gnu.org/pipermail/gcc/2021-July/236756.html

From my side, I can just say that if GDB decides to migrate to Sphinx,
I will step down as the person responsible for the GDB documentation,
because it's too late for me to learn yet another incompatible
documentation system (and insufficiently documented on top of that).

  parent reply	other threads:[~2022-09-18 13:20 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-09-18  8:31 Tom de Vries
2022-09-18 13:06 ` Gaius Mulley
2022-09-18 13:20 ` Eli Zaretskii [this message]
2022-09-18 22:25 ` Simon Marchi
2022-09-26  0:03   ` Joel Brobecker

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=837d20zunx.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=gdb-patches@sourceware.org \
    --cc=tdevries@suse.de \
    /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).