Skip to content

Commit bcc8cb8

Browse files
committed
Document non-GNU IConv on macOS
1 parent dd7d0d4 commit bcc8cb8

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

doc/building_boost_locale.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@
3232
so you need to either use GNU iconv or link with the ICU library.
3333
- If the iconv library is not found on Darwin/Mac OS X builds make sure there
3434
are not multiple iconv installations and provide the -sICONV_PATH build option
35-
to point to the correct location of the iconv library.
35+
to point to the correct location of the iconv library.
36+
Using the HomeBrew installed GNU IConv is highly recommended!
3637

3738
\subsection bb_building_proc Building Process
3839

doc/main.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,13 @@ It is based on the operating system native API or on the standard
5454
C++ library support. Sacrificing some less important features,
5555
Boost.Locale becomes less powerful but lighter and easier to deploy.
5656

57+
Charset conversion is also provided through the lightweight IConv library.
58+
When that is not available ICU or operating system native APIs are used.
59+
60+
\warning The system IConv library on Apple macOS may not be GNU conformant
61+
and can lead to unexpected results during encoding conversions.
62+
Using the GNU IConv provided by HomeBrew is highly recommended.
63+
5764

5865
\section main_tutorial Tutorials
5966

0 commit comments

Comments
 (0)