public inbox for gcc-cvs@sourceware.org
help / color / mirror / Atom feed
* [gcc r14-5644] ada: Fix misplaced index directive in documentation
@ 2023-11-21 9:58 Marc Poulhi?s
0 siblings, 0 replies; only message in thread
From: Marc Poulhi?s @ 2023-11-21 9:58 UTC (permalink / raw)
To: gcc-cvs
https://gcc.gnu.org/g:c6cd629ffbf895542dcf6e603ab112818cd9afd7
commit r14-5644-gc6cd629ffbf895542dcf6e603ab112818cd9afd7
Author: Marc Poulhiès <poulhies@adacore.com>
Date: Mon Oct 23 10:08:35 2023 +0200
ada: Fix misplaced index directive in documentation
The index directive must be located before the indexed element, at least
for the generated texinfo to be correct. See:
https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-index
This was reported along with changes done in https://inbox.sourceware.org/gcc-patches/20230223102714.3606058-3-arsen@aarsen.me/
gcc/ada/
* doc/gnat_ugn/the_gnat_compilation_model.rst: Move index
directives.
* gnat_ugn.texi: Regenerate.
Diff:
---
.../doc/gnat_ugn/the_gnat_compilation_model.rst | 11 ++++-----
gcc/ada/gnat_ugn.texi | 28 +++++++++++++++-------
2 files changed, 25 insertions(+), 14 deletions(-)
diff --git a/gcc/ada/doc/gnat_ugn/the_gnat_compilation_model.rst b/gcc/ada/doc/gnat_ugn/the_gnat_compilation_model.rst
index ed24fed7293..fd15459203a 100644
--- a/gcc/ada/doc/gnat_ugn/the_gnat_compilation_model.rst
+++ b/gcc/ada/doc/gnat_ugn/the_gnat_compilation_model.rst
@@ -226,9 +226,9 @@ possible encoding schemes:
``16#A345#``.
This scheme is compatible with use of the full Wide_Character set.
-*Upper-Half Coding*
- .. index:: Upper-Half Coding
+.. index:: Upper-Half Coding
+*Upper-Half Coding*
The wide character with encoding ``16#abcd#`` where the upper bit is on
(in other words, 'a' is in the range 8-F) is represented as two bytes,
``16#ab#`` and ``16#cd#``. The second byte cannot be a format control
@@ -236,9 +236,9 @@ possible encoding schemes:
be also used for shift-JIS or EUC, where the internal coding matches the
external coding.
-*Shift JIS Coding*
- .. index:: Shift JIS Coding
+.. index:: Shift JIS Coding
+*Shift JIS Coding*
A wide character is represented by a two-character sequence,
``16#ab#`` and
``16#cd#``, with the restrictions described for upper-half encoding as
@@ -247,10 +247,9 @@ possible encoding schemes:
conversion. Only characters defined in the JIS code set table can be
used with this encoding method.
+.. index:: EUC Coding
*EUC Coding*
- .. index:: EUC Coding
-
A wide character is represented by a two-character sequence
``16#ab#`` and
``16#cd#``, with both characters being in the upper half. The internal
diff --git a/gcc/ada/gnat_ugn.texi b/gcc/ada/gnat_ugn.texi
index 78f8849e379..3859709afff 100644
--- a/gcc/ada/gnat_ugn.texi
+++ b/gcc/ada/gnat_ugn.texi
@@ -19,7 +19,7 @@
@copying
@quotation
-GNAT User's Guide for Native Platforms , Oct 26, 2023
+GNAT User's Guide for Native Platforms , Nov 10, 2023
AdaCore
@@ -1363,22 +1363,30 @@ characters (using uppercase letters) of the wide character code. For
example, ESC A345 is used to represent the wide character with code
@code{16#A345#}.
This scheme is compatible with use of the full Wide_Character set.
-
-@item `Upper-Half Coding'
+@end table
@geindex Upper-Half Coding
+
+@table @asis
+
+@item `Upper-Half Coding'
+
The wide character with encoding @code{16#abcd#} where the upper bit is on
(in other words, ‘a’ is in the range 8-F) is represented as two bytes,
@code{16#ab#} and @code{16#cd#}. The second byte cannot be a format control
character, but is not required to be in the upper half. This method can
be also used for shift-JIS or EUC, where the internal coding matches the
external coding.
-
-@item `Shift JIS Coding'
+@end table
@geindex Shift JIS Coding
+
+@table @asis
+
+@item `Shift JIS Coding'
+
A wide character is represented by a two-character sequence,
@code{16#ab#} and
@code{16#cd#}, with the restrictions described for upper-half encoding as
@@ -1386,11 +1394,15 @@ described above. The internal character code is the corresponding JIS
character according to the standard algorithm for Shift-JIS
conversion. Only characters defined in the JIS code set table can be
used with this encoding method.
-
-@item `EUC Coding'
+@end table
@geindex EUC Coding
+
+@table @asis
+
+@item `EUC Coding'
+
A wide character is represented by a two-character sequence
@code{16#ab#} and
@code{16#cd#}, with both characters being in the upper half. The internal
@@ -29568,8 +29580,8 @@ to permit their use in free software.
@printindex ge
-@anchor{d1}@w{ }
@anchor{gnat_ugn/gnat_utility_programs switches-related-to-project-files}@w{ }
+@anchor{d1}@w{ }
@c %**end of body
@bye
^ permalink raw reply [flat|nested] only message in thread
only message in thread, other threads:[~2023-11-21 9:58 UTC | newest]
Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-11-21 9:58 [gcc r14-5644] ada: Fix misplaced index directive in documentation Marc Poulhi?s
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).