summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorRemco Rijnders <remco@webconquest.com>2020-10-29 14:24:08 -0400
committerRemco Rijnders <remco@webconquest.com>2020-10-29 14:24:08 -0400
commit37a1950af04c50aee03c205897847e4eea36d4ec (patch)
treea9cc8826190d44e4ec413b95dd1d353e6d1d958f /doc
parent4fa19ba4a91837bae256889fad9b8d50439679dd (diff)
Move contents from BEWARE to devel-notes.txt
Diffstat (limited to 'doc')
-rw-r--r--doc/devel-notes.txt19
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/devel-notes.txt b/doc/devel-notes.txt
index be526938..30edbed5 100644
--- a/doc/devel-notes.txt
+++ b/doc/devel-notes.txt
@@ -159,6 +159,23 @@ in the top-level source directory reports no errors/warnings.
Documentation changes should be validated by running 'make validate'
in the doc subdirectory.
+
+String comparisons
+------------------
+
+A word of warning about string comparisons: Since mutt may run in a
+huge variety of locales, case-insensitive string comparisons and
+case conversions may be dangerous. For instance, in iso-8859-9,
+tolower('I') is DIFFERENT from 'i' - it's indeed the Turkish dotless
+lowercase i.
+
+For this reason, always use the ascii_* functions defined in ascii.h
+and implemented in ascii.c when comparing or handling strings which
+are defined as us-ascii. This concerns lots of text-based
+protocols, message header tags, character set names, domain names,
+e-mail addresses, etc.
+
+
A word about warnings
---------------------
@@ -202,6 +219,8 @@ Style Guide
/* L10N: this is a translator comment */
puts(_("String to translate));
+
+
Documentation
-------------