[Ada] Avoid single colon in comment markup

Pierre-Marie de Rodat derodat@adacore.com
Fri Sep 29 15:35:00 GMT 2017


This change allows our style-checker to implement a heuristic to detect
either only typed one ':' or mistyped one of the characters, causing the
entire markup block to disappear as it is then unexpectedly being
treated as a comment instead.

Tested on x86_64-pc-linux-gnu, committed on trunk

2017-09-29  Joel Brobecker  <brobecker@adacore.com>

	* doc/gnat_ugn/building_executable_programs_with_gnat.rst,
	doc/gnat_ugn/the_gnat_compilation_model.rst: Avoid use of single colon
	in comment markup.
	* gnat_ugn.texi: Regenerate.

-------------- next part --------------
Index: doc/gnat_ugn/building_executable_programs_with_gnat.rst
===================================================================
--- doc/gnat_ugn/building_executable_programs_with_gnat.rst	(revision 253283)
+++ doc/gnat_ugn/building_executable_programs_with_gnat.rst	(working copy)
@@ -559,7 +559,7 @@
   -f, it is equivalent to calling the compiler directly. Note that using
   -u with a project file and no main has a special meaning.
 
-.. --Comment:
+.. --Comment
   (See :ref:`Project_Files_and_Main_Subprograms`.)
 
 
Index: doc/gnat_ugn/the_gnat_compilation_model.rst
===================================================================
--- doc/gnat_ugn/the_gnat_compilation_model.rst	(revision 253283)
+++ doc/gnat_ugn/the_gnat_compilation_model.rst	(working copy)
@@ -1569,7 +1569,7 @@
 If you are using project file, a separate mechanism is provided using
 project attributes.
 
-.. --Comment:
+.. --Comment
    See :ref:`Specifying_Configuration_Pragmas` for more details.
 
 
Index: gnat_ugn.texi
===================================================================
--- gnat_ugn.texi	(revision 253285)
+++ gnat_ugn.texi	(working copy)
@@ -3193,7 +3193,7 @@
 If you are using project file, a separate mechanism is provided using
 project attributes.
 
-@c --Comment:
+@c --Comment
 @c See :ref:`Specifying_Configuration_Pragmas` for more details.
 
 @node Generating Object Files,Source Dependencies,Configuration Pragmas,The GNAT Compilation Model
@@ -7925,7 +7925,7 @@
 -u with a project file and no main has a special meaning.
 @end table
 
-@c --Comment:
+@c --Comment
 @c (See :ref:`Project_Files_and_Main_Subprograms`.)
 
 @geindex -U (gnatmake)


More information about the Gcc-patches mailing list