Revert Sphinx documentation [Was: Issues with Sphinx]
Jonathan Wakely
jwakely.gcc@gmail.com
Mon Nov 14 09:24:08 GMT 2022
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?
-------------- next part --------------
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
More information about the Gcc
mailing list