Merge documentation from HEAD

(This used to be commit 3761f8ebe339fbbeffee9d7b69f9483ebfd9ae6b)

diff --git a/source3/lib/charcnv.c b/source3/lib/charcnv.c
index bffa2a378ccccdf5a5b4297832ff42f90a5790f1..a8df003f8bca63d030466b42cce2792bd5af3924 100644 (file)
--- a/source3/lib/charcnv.c
+++ b/source3/lib/charcnv.c
@@ -22,17 +22,24 @@
 */
 #include "includes.h"
 
-static pstring cvtbuf;
-
-static smb_iconv_t conv_handles[NUM_CHARSETS][NUM_CHARSETS];
-
 /**
  * @file
  *
- * Character set conversion routines.
+ * @brief Character-set conversion routines built on our iconv.
+ * 
+ * @note Samba's internal character set (at least in the 3.0 series)
+ * is always the same as the one for the Unix filesystem.  It is
+ * <b>not</b> necessarily UTF-8 and may be different on machines that
+ * need i18n filenames to be compatible with Unix software.  It does
+ * have to be a superset of ASCII.  All multibyte sequences must start
+ * with a byte with the high bit set.
  *
  * @sa lib/iconv.c
- **/
+ */
+
+static pstring cvtbuf;
+
+static smb_iconv_t conv_handles[NUM_CHARSETS][NUM_CHARSETS];
 
 
 /**