From: erg <devnull@localhost>
Date: Fri, 25 Aug 2006 22:29:20 +0000 (+0000)
Subject: Clarify use of NULL argument in gvRender
X-Git-Tag: LAST_LIBGRAPH~32^2~5936
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=3f83139fe826d3163c48f413926bd83aee8db5ae;p=graphviz

Clarify use of NULL argument in gvRender
---

diff --git a/doc/libguide/basic.tex b/doc/libguide/basic.tex
index 252284d25..0c1ff6c40 100644
--- a/doc/libguide/basic.tex
+++ b/doc/libguide/basic.tex
@@ -666,7 +666,10 @@ One simple way to do this is to use the position and drawing information as
 supplied by the {\tt dot} or {\tt xdot} format (see
 Sections~\ref{sect:dot} and \ref{sect:xdot}). To get this, the application
 can call the appropriate renderer, passing a NULL stream
-pointer to {\tt gvRender} as in Figure~\ref{fig:nop}.
+pointer to {\tt gvRender}\footnote{
+This convention only works, and only makes sense, with the {\tt dot} 
+and {\tt xdot} renderers. For other renders, a NULL stream will cause
+output to be written on {\tt stdout}.} as in Figure~\ref{fig:nop}.
 This will attach the information as string attributes. The application
 can then use {\tt agget} to read the attributes.