[PATCH] Normalize "on|off" text in manual
Kevin Buettner
kevinb@redhat.com
Fri Apr 12 17:04:37 GMT 2024
On Sun, 31 Mar 2024 08:01:16 +0300
Eli Zaretskii <eliz@gnu.org> wrote:
> > From: Tom Tromey <tom@tromey.com>
> > Cc: Tom Tromey <tom@tromey.com>
> > Date: Sat, 30 Mar 2024 12:54:01 -0600
> >
> > While looking in the info manual, I noticed this:
> >
> > ‘set style enabled ‘on|off’’
> >
> > The styling looked weird here and in the source I saw it was written as:
> >
> > @item set style enabled @samp{on|off}
> >
> > I looked through the rest of the manual and found this same sort of
> > thing was written in a variety of styles.
> >
> > For this patch, I picked one way to write this and applied it to all
> > the instances.
>
> Thanks.
>
> I agree that we should be consistent. While using @r{..} for the
> brackets and "|" is probably rigorously correct, I think it is too
> much bother, and thus is likely not to be followed by many patches. I
> wonder whether we could use the simpler way: leave them alone, which
> will cause the entire "set style enabled on|off" have the @code
> markup, due to "@table @code". This will be easier to follow and
> easier to enforce. What do people think?
So long as the result in the manual looks okay, I'm in favor of simplicity.
Kevin
More information about the Gdb-patches
mailing list