Bug 5685

Summary: lang vs. locales on Mail::SpamAssassin::Conf(3pm)
Product: Spamassassin Reporter: jidanni
Component: DocumentationAssignee: SpamAssassin Developer Mailing List <dev>
Status: RESOLVED FIXED    
Severity: trivial CC: apache
Priority: P5    
Version: 3.2.3   
Target Milestone: Undefined   
Hardware: Other   
OS: other   
Whiteboard:

Description jidanni 2007-10-13 19:06:08 UTC
On Mail::SpamAssassin::Conf(3pm) one sees way at the bottom:
       The locales string should specify either both the language and country,
e.g.         
       "lang pt_BR", or just the language, e.g. "lang de".
Well, if you are talking about ok_locales, then you had better mention it not so
late in the page.
If you are talking about the lang string instead, then say lang instead of locales.
Comment 1 Matt Kettler 2007-10-14 19:55:05 UTC
It is clearly not talking about ok_locales, or anything vaguely related to that
option.

It's talking about using the "lang" config option to localize the reports that
SA generates into your choice of language.

It's even in a section titled "LOCALI[SZ]ATION"...


---------------------------
LOCALI[SZ]ATION

A line starting with the text lang xx will only be interpreted if the user is in
that locale, allowing test descriptions and templates to be set for that language.

The locales string should specify either both the language and country, e.g.
lang pt_BR, or just the language, e.g. lang de.
---------------------------

However, this is a good spot to point out that the "lang" config option is not
documented in the same format as other config options. All other options start
off with the option name on a line by itself, followed by a description..

I'd offer to reformat it, but the existing description is confusing even to me.
Particularly the ".. will only be interpreted if the user is in that locale"
part.. What exactly does that mean?


Comment 2 Justin Mason 2007-10-15 03:59:17 UTC
(In reply to comment #1)
> I'd offer to reformat it, but the existing description is confusing even to me.
> Particularly the ".. will only be interpreted if the user is in that locale"
> part.. What exactly does that mean?

that's if the env vars $LC_ALL, $LANG, etc. are set to indicate that locale.
Comment 3 Henrik Krohns 2019-08-13 06:05:41 UTC
Clarified docs.

Sending        trunk/lib/Mail/SpamAssassin/Conf.pm
Transmitting file data .done
Committing transaction...
Committed revision 1865010.