Document errhidecontext() where it ought to be documented.

Seems to have been missed when this function was added.  Noted while
looking at David Steele's proposal to add another similar function.

diff --git a/doc/src/sgml/sources.sgml b/doc/src/sgml/sources.sgml
index 614defaa2f132c7597f22aa0c1ff362a5d609f51..13409a7994a5d018d6267a86cadbb0a9179a7a78 100644 (file)
--- a/doc/src/sgml/sources.sgml
+++ b/doc/src/sgml/sources.sgml
@@ -353,6 +353,15 @@ ereport(ERROR,
      includes the current statement already.
     </para>
    </listitem>
+   <listitem>
+    <para>
+     <function>errhidecontext(bool hide_ctx)</function> can be called to
+     specify suppression of the <literal>CONTEXT:</> portion of a message in
+     the postmaster log.  This should only be used for verbose debugging
+     messages where the repeated inclusion of context would bloat the log
+     volume too much.
+    </para>
+   </listitem>
   </itemizedlist>
    </para>
 

diff --git a/src/backend/utils/error/elog.c b/src/backend/utils/error/elog.c
index 458f3aa2b653b8b6f91742ede47253f8b2330bb9..8e006097a64c658f0c0115967dad78e2605695f6 100644 (file)
--- a/src/backend/utils/error/elog.c
+++ b/src/backend/utils/error/elog.c
@@ -1081,7 +1081,7 @@ errhidestmt(bool hide_stmt)
  * errhidecontext --- optionally suppress CONTEXT: field of log entry
  *
  * This should only be used for verbose debugging messages where the repeated
- * inclusion of CONTEXT: bloats the log volume too much.
+ * inclusion of context would bloat the log volume too much.
  */
 int
 errhidecontext(bool hide_ctx)