public inbox for gcc-patches@gcc.gnu.org
 help / color / mirror / Atom feed
From: Sandra Loosemore <sloosemore@baylibre.com>
To: Jakub Jelinek <jakub@redhat.com>,
	Gerald Pfeifer <gerald@pfeifer.com>,
	"Joseph S. Myers" <josmyers@redhat.com>
Cc: gcc-patches@gcc.gnu.org
Subject: Re: [PATCH] docs: Use @var{S} etc. in Spec File invoke.texi documentation
Date: Wed, 27 Mar 2024 08:32:06 -0600	[thread overview]
Message-ID: <e64993fb-3232-43c5-8449-8a7d34fa0ffa@baylibre.com> (raw)
In-Reply-To: <ZgP7inVWtWKhtZy+@tucnak>

On 3/27/24 04:57, Jakub Jelinek wrote:
> Hi!
> 
> We got internally a question about the Spec File syntax, misunderstanding
> what is the literal syntax and what are the placeholder variables in
> the syntax descriptions.
> The following patch attempts to use @var{S} etc. instead of just S
> to clarify it stands for any option (or start of option etc.) rather
> than literal S, say in %{S:X}.  At least in HTML documentation it
> then uses italics.
> 
> Bootstrapped/regtested on x86_64-linux and i686-linux, ok for trunk?

Looks good for me, as long as you visually inspected the changed text in 
the manual and didn't just make sure it still builds.  (I generally 
consider any markup/formatting changes "obvious" as long as they 
actually look OK.)

-Sandra

      reply	other threads:[~2024-03-27 14:32 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-03-27 10:57 Jakub Jelinek
2024-03-27 14:32 ` Sandra Loosemore [this message]

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=e64993fb-3232-43c5-8449-8a7d34fa0ffa@baylibre.com \
    --to=sloosemore@baylibre.com \
    --cc=gcc-patches@gcc.gnu.org \
    --cc=gerald@pfeifer.com \
    --cc=jakub@redhat.com \
    --cc=josmyers@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).