From: Karl Williamson <public@khwilliamson.com>
Date: Thu, 27 Jun 2013 19:57:19 +0000 (-0600)
Subject: locale.c: Add comments
X-Git-Tag: v5.19.2~178
X-Git-Url: https://perl5.git.perl.org/perl5.git/commitdiff_plain/0ef2a2b264125e11ee1ca1f0658013336a25ccf6?ds=sidebyside

locale.c: Add comments
---

diff --git a/locale.c b/locale.c
index c10228d..32e47eb 100644
--- a/locale.c
+++ b/locale.c
@@ -38,14 +38,15 @@
 /*
  * Standardize the locale name from a string returned by 'setlocale'.
  *
- * The standard return value of setlocale() is either
+ * The typical return value of setlocale() is either
  * (1) "xx_YY" if the first argument of setlocale() is not LC_ALL
  * (2) "xa_YY xb_YY ..." if the first argument of setlocale() is LC_ALL
  *     (the space-separated values represent the various sublocales,
- *      in some unspecified order)
+ *      in some unspecified order).  This is not handled by this function.
  *
  * In some platforms it has a form like "LC_SOMETHING=Lang_Country.866\n",
- * which is harmful for further use of the string in setlocale().
+ * which is harmful for further use of the string in setlocale().  This
+ * function removes the trailing new line and everything up through the '='
  *
  */
 STATIC char *