From: John Darrington <john@darrington.wattle.id.au>
Date: Sat, 18 Jul 2009 10:38:02 +0000 (+0200)
Subject: Add comment explaining the meaning of encoding to data_out
X-Git-Tag: build37~53^2
X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=2b77d6273ba47af3020a827d48d0ff3330d76ba5;p=pspp-builds.git

Add comment explaining the meaning of encoding to data_out
---

diff --git a/src/data/data-out.c b/src/data/data-out.c
index 20a0b46d..94a6130a 100644
--- a/src/data/data-out.c
+++ b/src/data/data-out.c
@@ -113,19 +113,23 @@ data_out_legacy (const union value *input, const char *encoding,
     }
 }
 
-/* Converts the INPUT value into a UTF8 encoded string, according to format
-   specification FORMAT. 
+/* Converts the INPUT value into a UTF8 encoded string, according
+   to format specification FORMAT. 
 
    VALUE must be the correct width for FORMAT, that is, its
    width must be fmt_var_width(FORMAT).
 
+   ENCODING must be the encoding of INPUT.  Normally this can
+   be obtained by calling dict_get_encoding on the dictionary
+   with which INPUT is associated.
+
    The return value is dynamically allocated, and must be freed
    by the caller.  If POOL is non-null, then the return value is
    allocated on that pool.
 */
 char *
-data_out_pool (const union value *input, const char *encoding, const struct fmt_spec *format,
-	  struct pool *pool)
+data_out_pool (const union value *input, const char *encoding,
+	       const struct fmt_spec *format, struct pool *pool)
 {
   char *output = xmalloc (format->w + 1);
   char *t ;