public inbox for binutils@sourceware.org
 help / color / mirror / Atom feed
From: Tom Tromey <tom@tromey.com>
To: Nick Clifton <nickc@redhat.com>
Cc: Tom Tromey <tom@tromey.com>,  binutils@sourceware.org
Subject: Re: [PATCH 0/8] Make the BFD info manual a bit prettier
Date: Wed, 15 Feb 2023 14:51:07 -0700	[thread overview]
Message-ID: <87ttzmbnsk.fsf@tromey.com> (raw)
In-Reply-To: <0b385324-e721-e6f5-d3df-aba0153da1c6@redhat.com> (Nick Clifton's message of "Wed, 15 Feb 2023 09:54:40 +0000")

>> I noticed some oddities in the BFD info manual (see patch 7 and patch
>> 8 for details).  While trying to fix these, I found a number of other
>> things that could be cleaned up a bit, and this series is the result.
>> I tested this by rebuilding with --enable-maintainer-mode and diffing
>> the header files to make sure they didn't change.  Then I inspected
>> the manual, well, manually.

Nick> Patch series approved - please apply.

Nick> Thanks for fixing these issues.

Thanks for the review.  I've checked these in now.

There are still a few other issues to solve here.  Those don't look so
difficult, but I was wondering about making bigger changes here.  I have
a few queries in case you have a moment to respond.

While I like FORTH well enough, I suspect it might be nicer to just
rewrite chew in Python.  Over in gdb, we've standardized on that for all
our maintainer scripts; the main benefits are that a lot of people know
it and there are plenty of libraries, etc, to use.  What do you think of
this?

(Another option here would be to change the syntax a bit so it's more
FORTH-like... it'd be nice to be able to use some pre-existing Emacs
mode for this code, but chew is FORTH-ish without really following FORTH
syntax.)

Finally, it seems to me that it would be nicer if chew were merely a
documentation extractor.  Having it also generate source files seems
unfortunate.  For example, things like 'tags' don't work, because the
primary source code is actually in some comment somewhere.  It seems
like this could be changed so that code is just code, comments (and
maybe snippets of code) are extracted into the manual, and some of the
generated headers are turned into ordinary headers.  WDYT?

thanks,
Tom

  reply	other threads:[~2023-02-15 21:51 UTC|newest]

Thread overview: 19+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-02-08  7:17 Tom Tromey
2023-02-08  7:17 ` [PATCH 1/8] Remove H_CFLAGS from doc/local.mk Tom Tromey
2023-02-08  7:17 ` [PATCH 2/8] Simplify @node use in BFD documentation Tom Tromey
2023-03-03  8:20   ` Jan Beulich
2023-03-03 23:08     ` Tom Tromey
2023-03-06  7:07       ` Jan Beulich
2023-02-08  7:17 ` [PATCH 3/8] Add copyright headers to the .str files Tom Tromey
2023-02-08  7:17 ` [PATCH 4/8] Remove the paramstuff word Tom Tromey
2023-02-08  7:17 ` [PATCH 5/8] Use intptr_t rather than long in chew Tom Tromey
2023-02-08  7:17 ` [PATCH 6/8] Change internalmode to be an intrinsic variable Tom Tromey
2023-02-08  7:17 ` [PATCH 7/8] Use @deftypefn in chew output Tom Tromey
2023-02-15 17:55   ` Simon Marchi
2023-02-15 23:11     ` Tom Tromey
2023-02-16  1:29       ` Simon Marchi
2023-02-19  3:46         ` Alan Modra
2023-02-08  7:17 ` [PATCH 8/8] Remove RETURNS from BFD chew comments Tom Tromey
2023-02-15  9:54 ` [PATCH 0/8] Make the BFD info manual a bit prettier Nick Clifton
2023-02-15 21:51   ` Tom Tromey [this message]
2023-02-16  9:40     ` Nick Clifton

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=87ttzmbnsk.fsf@tromey.com \
    --to=tom@tromey.com \
    --cc=binutils@sourceware.org \
    --cc=nickc@redhat.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).