Bug fix: Non-portable functions

[geeqie.git] / CODING.md

diff --git a/CODING.md b/CODING.md
index 5c72374..7a517e9 100644 (file)
--- a/CODING.md
+++ b/CODING.md
@@ -1,4 +1,4 @@
-[Log Window](#log-window)  
+[Error Logging](#error-logging)  
 [GPL header](#gpl-header)  
 [Git change log](#git-change-log)  
 [Sources](#sources)  
@@ -7,13 +7,23 @@
 -----------
 
 
-# <a name='log-window'>
-#Log Window
+# <a name='error-logging'>
+# Error Logging
 
+`DEBUG_0()`  
+Use `DEBUG_0()` only for temporary debugging i.e. not in code in the repository.
+The user will then not see irrelevant debug output when the default
+`debug level = 0` is used.
 
 `log_printf()`  
 If the first word of the message is "error" or "warning" (case insensitive) the message will be color-coded appropriately.
 
+ - Note that these messages are output in the idle loop.
+
+`print_term(gboolean err, const gchar *text_utf8)`
+
+- If `err` is TRUE output is to STDERR, otherwise to STDOUT
+
 
 `DEBUG_NAME(widget)`  
 For use with the [GTKInspector](https://wiki.gnome.org/action/show/Projects/GTK/Inspector?action=show&redirect=Projects%2FGTK%2B%2FInspector) to provide a visual indication of where objects are declared.
@@ -55,7 +65,7 @@ Include a header in every file, like this:
 -------------
 
 # <a name='git-change-log'>
-#git change-log
+# git change-log
 
 If referencing a Geeqie GitHub issue, include the issue number in the summary line. Start with a short summary in the first line (without a dot at the end) followed by a empty line.
 
@@ -78,7 +88,7 @@ Also please use your full name and a working e-mail address as author for any co
 --------------------------------------------------------------------------------
 
 # <a name='sources'>
-#Sources
+# Sources
 
 Indentation: tabs at 4 spaces
        
@@ -175,7 +185,7 @@ Check if used functions are not deprecated.
 --------------------------------------------------------------------------------
 
 # <a name='documentation'>
-#Documentation
+# Documentation
 
 Use American, rather than British English, spelling. This will facilitate consistent
 text searches. User text may be translated via the en_GB.po file.