public inbox for binutils@sourceware.org
 help / color / mirror / Atom feed
From: Tom Tromey <tom@tromey.com>
To: binutils@sourceware.org
Subject: [PATCH 0/4] More fixes to chew documentation
Date: Fri, 17 Feb 2023 12:29:01 -0700	[thread overview]
Message-ID: <20230217192905.3160819-1-tom@tromey.com> (raw)

I re-read the chew-generated BFD info pages, and found a few more
issues.  This series fixes the simpler ones.

For patch #3, I looked at adding a GLOBAL directive to chew, to make
it possible to document bfd_use_reserved_id using @deftypevar.
However, because chew doesn't really implement conditionals, this
turns out to be surprisingly tricky.  It would be simpler to just turn
this global into a setter function instead -- there's just one spot in
ld that sets it.

Alternatively, maybe adding conditionals to chew is the way to go, as
that would also let us improve the documentation for macros.

Tom



             reply	other threads:[~2023-02-17 19:29 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-02-17 19:29 Tom Tromey [this message]
2023-02-17 19:29 ` [PATCH 1/4] Fix formatting of long function description in chew output Tom Tromey
2023-02-17 19:29 ` [PATCH 2/4] Don't use chew comments for static functions Tom Tromey
2023-02-17 19:29 ` [PATCH 3/4] Hoist the SECTION comment in opncls.c Tom Tromey
2023-02-17 19:29 ` [PATCH 4/4] Redefine FUNCTION in doc.str Tom Tromey
2023-02-20 14:59 ` [PATCH 0/4] More fixes to chew documentation 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=20230217192905.3160819-1-tom@tromey.com \
    --to=tom@tromey.com \
    --cc=binutils@sourceware.org \
    /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).