doc: improve document of ECPG host variable

Started by Ryo Matsumura (Fujitsu)about 2 years ago1 messages

matsumura.ryo@fujitsu.com

about 2 years ago

1 attachment(s)

Hi hackers,

I attach a small patch improving document of ECPG host variable.
Please back patch to supported version, if possible.

Range of 'bool' as type of ECPG is not defined explicitly. Our customer was confused.
Additionally, I could not understand clearly what the existing sentence mentions to user.

My idea is as follows:

- [b] declared in ecpglib.h if not native
+ [b] Range of bool is true/false only.
      There is no need to include any header like stdbool.h for type and literals
      because they are defined by ECPG and
      ECPG internally includes a appropriate C language standard header or
      deifnes them if there is no such header.

Best Regards
Ryo Matsumura

Attachments:

doc-ecpg-var.patchapplication/octet-stream; name=doc-ecpg-var.patchDownload

diff --git a/doc/src/sgml/ecpg.sgml b/doc/src/sgml/ecpg.sgml
index dd576c2..eb8b685 100644
--- a/doc/src/sgml/ecpg.sgml
+++ b/doc/src/sgml/ecpg.sgml
@@ -1006,7 +1006,17 @@ do
 
       <row>
        <entry><type>boolean</type></entry>
-       <entry><type>bool</type><footnote><para>declared in <filename>ecpglib.h</filename> if not native</para></footnote></entry>
+       <entry><type>bool</type>
+        <footnote>
+         <para>
+           Range of bool is true/false only.
+           There is no need to include any header like stdbool.h for type and
+           literals because they are defined by ECPG and ECPG internally
+           includes a appropriate C language standard header or deifnes them
+           if there is no such header.
+         </para>
+        </footnote>
+       </entry>
       </row>
 
       <row>