utf8.h: Add comment

khwilliamson · khwilliamson · commit b0345726a1d4 · 2024-10-31T11:44:13.000-06:00
diff --git a/utf8.h b/utf8.h
@@ -23,7 +23,12 @@
  * which differs from UTF-8 only in a few details.  It is often useful to
  * translate UTF-EBCDIC into this form for processing.  In general, macros and
  * functions that are expecting their inputs to be either in I8 or UTF-8 are
- * named UTF_foo (without an '8'), to indicate this.
+ * named UTF_foo (without an '8'), to indicate this.  khw thinks it would be
+ * clearer if these were renamed to be I8, because UTF is the prefix for UTF16,
+ * U32, etc., and we use it only for 8 bit quantities; though on ASCII machines
+ * these are final, not intermediate, values.  U8 would be more accurate, but
+ * bears too much resemblence to the ubiquitous U8 declaration.  'I8' stands
+ * out as very different from 'UTFn'.
  *
  * Unfortunately there are inconsistencies.
  *

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,12 @@`
`23`	`23`	`* which differs from UTF-8 only in a few details. It is often useful to`
`24`	`24`	`* translate UTF-EBCDIC into this form for processing. In general, macros and`
`25`	`25`	`* functions that are expecting their inputs to be either in I8 or UTF-8 are`
`26`		`- * named UTF_foo (without an '8'), to indicate this.`
	`26`	`+ * named UTF_foo (without an '8'), to indicate this. khw thinks it would be`
	`27`	`+ * clearer if these were renamed to be I8, because UTF is the prefix for UTF16,`
	`28`	`+ * U32, etc., and we use it only for 8 bit quantities; though on ASCII machines`
	`29`	`+ * these are final, not intermediate, values. U8 would be more accurate, but`
	`30`	`+ * bears too much resemblence to the ubiquitous U8 declaration. 'I8' stands`
	`31`	`+ * out as very different from 'UTFn'.`
`27`	`32`	`*`
`28`	`33`	`* Unfortunately there are inconsistencies.`
`29`	`34`	`*`