public inbox for gcc-patches@gcc.gnu.org
 help / color / mirror / Atom feed
From: Jonathan Wakely <jwakely.gcc@gmail.com>
To: "Martin Liška" <mliska@suse.cz>
Cc: Andrew Pinski <pinskia@gmail.com>,
	GCC Mailing List <gcc@gcc.gnu.org>,
	 GCC Patches <gcc-patches@gcc.gnu.org>,
	Gerald Pfeifer <gerald@pfeifer.com>
Subject: Re: Revert Sphinx documentation [Was: Issues with Sphinx]
Date: Mon, 14 Nov 2022 09:24:08 +0000	[thread overview]
Message-ID: <CAH6eHdSYVhsiJxxLgCrA4LsRR5XMUvS8KzO1f=S8ravjftyUjQ@mail.gmail.com> (raw)
In-Reply-To: <029e0760-3f48-4b7a-a3f8-99a2c32536b0@suse.cz>

[-- Attachment #1: Type: text/plain, Size: 824 bytes --]

On Mon, 14 Nov 2022 at 08:40, Martin Liška wrote:
>
> On 11/14/22 03:49, Martin Liška wrote:
> > I'm going to revert the patchset during today (Monday) and I'll send a patch with a couple
> > of new changes that landed in the period of time we used Sphinx.
>
> The revert is done and I included ce51e8439a491910348a1c5aea43b55f000ba8ac commit
> that ports all the new documentation bits to Texinfo.

Sorry it didn't work out, and thanks for reapplying my two doc changes
that landed during the era of the sphinx.

I formatted my new region/endregion pragmas on one line because that
seemed to be how it should be done for rSt, e.g. we had:

``#pragma GCC push_options`` ``#pragma GCC pop_options``

But I think the attached patch is more correct for how we document
pragmas in texinfo.

OK for trunk?

[-- Attachment #2: patch.txt --]
[-- Type: text/plain, Size: 973 bytes --]

commit 3aa461d4ba46449544730a342cb2dcb0ce6851e9
Author: Jonathan Wakely <jwakely@redhat.com>
Date:   Mon Nov 14 09:19:13 2022

    doc: Format region pragmas as separate items
    
    This seems consistent with how other paired pragmas are documented in
    texinfo, e.g. push_options and pop_options.
    
    gcc/ChangeLog:
    
            * doc/cpp.texi (Pragmas): Use @item and @itemx for region
            pragmas.

diff --git a/gcc/doc/cpp.texi b/gcc/doc/cpp.texi
index 1be29eb605e..5e86a957a88 100644
--- a/gcc/doc/cpp.texi
+++ b/gcc/doc/cpp.texi
@@ -3843,7 +3843,8 @@ file will never be read again, no matter what.  It is a less-portable
 alternative to using @samp{#ifndef} to guard the contents of header files
 against multiple inclusions.
 
-@code{#pragma region @{tokens@}...}, @code{#pragma endregion @{tokens@}...}
+@item #pragma region @{tokens@}...
+@itemx #pragma endregion @{tokens@}...
 These pragmas are accepted, but have no effect.
 
 @end ftable

  reply	other threads:[~2022-11-14  9:24 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <CA+=Sn1m=F6JVszrTFS_v=rfC7nrO=X5pSbgestxtPr___QGQuA@mail.gmail.com>
2022-11-14  2:49 ` Martin Liška
2022-11-14  8:38   ` Martin Liška
2022-11-14  9:24     ` Jonathan Wakely [this message]
2022-11-14 22:26       ` Gerald Pfeifer
2022-11-14 13:06   ` Gerald Pfeifer
2022-11-15 10:05     ` Martin Liška

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='CAH6eHdSYVhsiJxxLgCrA4LsRR5XMUvS8KzO1f=S8ravjftyUjQ@mail.gmail.com' \
    --to=jwakely.gcc@gmail.com \
    --cc=gcc-patches@gcc.gnu.org \
    --cc=gcc@gcc.gnu.org \
    --cc=gerald@pfeifer.com \
    --cc=mliska@suse.cz \
    --cc=pinskia@gmail.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).