From 184c00e38cb65a604a104c12986d731ea5ee8487 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexandre=20Ren=C3=A9?= Date: Sun, 17 Jul 2022 20:49:07 +0200 Subject: [PATCH 1/2] Explain non-standard encoding in LatinRules.xdy In order to fulfill its function, LatinRules.xdy must use single, non-standard byte characters (neither ASCII, nor multi-byte UTF-8). To someone encountering the file without knowing its purpose (e.g. due a post-processing raising a warning for the unrecognized encoding) this is likely surprising, and may seem like a holdover from a time where Unicode wasn't as universally supported. The added comment should make clear that the file must stay as it is, and in particular that it must not be "standardized" to UTF-8. --- sphinx/texinputs/LatinRules.xdy | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/sphinx/texinputs/LatinRules.xdy b/sphinx/texinputs/LatinRules.xdy index 99f14a2ee85..f0db7abfe3f 100644 --- a/sphinx/texinputs/LatinRules.xdy +++ b/sphinx/texinputs/LatinRules.xdy @@ -1,6 +1,10 @@ -;; style file for xindy +;; Common Lisp style file for xindy ;; filename: LatinRules.xdy ;; +;; Please note that this data file deliberately uses strings +;; with single non-ascii bytes. This is intentional and +;; follows the usage observed in similar xindy support files. +;; ;; It is based upon xindy's files lang/general/utf8.xdy and ;; lang/general/utf8-lang.xdy which implement ;; "a general sorting order for Western European languages" From 37267fe0deca972dac09a5c8fa93519c4f419030 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexandre=20Ren=C3=A9?= Date: Mon, 18 Jul 2022 14:15:28 +0200 Subject: [PATCH 2/2] Fix punctuation in comments --- sphinx/texinputs/LatinRules.xdy | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/sphinx/texinputs/LatinRules.xdy b/sphinx/texinputs/LatinRules.xdy index f0db7abfe3f..b20fbbb83a5 100644 --- a/sphinx/texinputs/LatinRules.xdy +++ b/sphinx/texinputs/LatinRules.xdy @@ -2,12 +2,12 @@ ;; filename: LatinRules.xdy ;; ;; Please note that this data file deliberately uses strings -;; with single non-ascii bytes. This is intentional and +;; with single non-ascii bytes. This is intentional and ;; follows the usage observed in similar xindy support files. ;; ;; It is based upon xindy's files lang/general/utf8.xdy and ;; lang/general/utf8-lang.xdy which implement -;; "a general sorting order for Western European languages" +;; "a general sorting order for Western European languages". ;; ;; The aim for Sphinx is to be able to index in a Cyrillic document ;; also terms using the Latin alphabets, inclusive of letters @@ -18,7 +18,7 @@ ;; ;; So here we use only 0o266 or higher bytes. ;; (ÅŠ, Å‹, IJ, and ij are absent from -;; lang/general/utf8.xdy and not included here) +;; lang/general/utf8.xdy and not included here.) ;; Contributed by the Sphinx team, 2018. (define-letter-group "A" :prefixes ("¶"))