Document errhidecontext() where it ought to be documented.

tglsfdc · tglsfdc · commit e5a4dea80f25 · 2016-03-28T14:18:14.000-04:00
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
@@ -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
@@ -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)

Original file line number	Diff line number	Diff line change
`@@ -1081,7 +1081,7 @@ errhidestmt(bool hide_stmt)`
`1081`	`1081`	`* errhidecontext --- optionally suppress CONTEXT: field of log entry`
`1082`	`1082`	`*`
`1083`	`1083`	`* This should only be used for verbose debugging messages where the repeated`
`1084`		`- * inclusion of CONTEXT: bloats the log volume too much.`
	`1084`	`+ * inclusion of context would bloat the log volume too much.`
`1085`	`1085`	`*/`
`1086`	`1086`	`int`
`1087`	`1087`	`errhidecontext(bool hide_ctx)`