Documentation for Clang and Emscripten toolsets

bfgroup · Jul 6, 2024 · 4350b2d · 4350b2d
1 parent 3c0f563
commit 4350b2d
Show file tree

Hide file tree

Showing 5 changed files with 51 additions and 1 deletion.
diff --git a/doc/src/reference.adoc b/doc/src/reference.adoc
@@ -325,10 +325,13 @@ be used to explicitly request that compiler.
 :leveloffset: +3
 include::../../src/tools/acc.jam[tag=doc]
 include::../../src/tools/borland.jam[tag=doc]
+include::../../src/tools/clang-linux.jam[tag=doc]
+include::../../src/tools/clang-win.jam[tag=doc]
 include::../../src/tools/como.jam[tag=doc]
 include::../../src/tools/cw.jam[tag=doc]
 include::../../src/tools/dmc.jam[tag=doc]
 include::../../src/tools/embarcadero.jam[tag=doc]
+include::../../src/tools/emscripten.jam[tag=doc]
 include::../../src/tools/gcc.jam[tag=doc]
 include::../../src/tools/hp_cxx.jam[tag=doc]
 include::../../src/tools/intel.jam[tag=doc]

diff --git a/src/tools/clang-linux.jam b/src/tools/clang-linux.jam
@@ -7,6 +7,16 @@
 #  License Version 1.0. (See accompanying file LICENSE.txt or
 #  https://www.bfgroup.xyz/b2/LICENSE.txt)
 
+#| tag::doc[]
+
+[[bbv2.reference.tools.compiler.clang-linux]]
+= Clang (GCC frontend)
+
+The `clang-linux` module supports Clang with GCC frontend and has the same
+options as link:#bbv2.reference.tools.compiler.gcc[`gcc`] toolset.
+
+|# # end::doc[]
+
 import common ;
 import toolset ;
 import feature ;

diff --git a/src/tools/clang-win.jam b/src/tools/clang-win.jam
@@ -5,6 +5,16 @@
 # (See accompanying file LICENSE.txt
 # or copy at https://www.bfgroup.xyz/b2/LICENSE.txt)
 
+#| tag::doc[]
+
+[[bbv2.reference.tools.compiler.clang-win]]
+= Clang (MSVC frontend)
+
+The `clang-win` module supports Clang with MSVC frontend and has the same
+options as link:#bbv2.reference.tools.compiler.msvc[`msvc`] toolset.
+
+|# # end::doc[]
+
 import common ;
 import errors ;
 import feature ;

diff --git a/src/tools/emscripten.jam b/src/tools/emscripten.jam
@@ -4,6 +4,33 @@
 # (See accompanying file LICENSE.txt
 # or copy at https://www.bfgroup.xyz/b2/LICENSE.txt)
 
+#| tag::doc[]
+
+[[bbv2.reference.tools.compiler.emscripten]]
+= Emscripten
+
+The `emscripten` module supports https://emscripten.org[Emscripten toolchain]
+and has the same options as link:#bbv2.reference.tools.compiler.clang-linux[`clang-linux`]
+toolset.
+
+WARNING: Emscripten toolset defaults to static linkage because it is what
+generally expected and limitations of the toolchain itself
+(`wasm-ld` does not support `rpath`; js launcher does not respect
+`LD_LIBRARY_PATH`/`PATH` when looking for shared objects).
+
+Additional link:#bbv2.overview.invocation.properties[features]
+supported by Emscripten toolset exclusively:
+
+`debug-symbols-source-map`::
+Setting to `on` will enable source map generation, more info could be found in
+https://emscripten.org/docs/tools_reference/emcc.html#emcc-gsource-map[Emscripten documentation].
+
+`exception-handling-method`::
+Setting to `js` will result in using Emscripten’s JavaScript-based exception
+support instead of native WebAssembly exception handling.
+
+|# # end::doc[]
+
 import feature ;
 import os ;
 import toolset ;

diff --git a/src/tools/gcc.jam b/src/tools/gcc.jam
@@ -14,7 +14,7 @@
 #| tag::doc[]
 
 [[bbv2.reference.tools.compiler.gcc]]
-= GNU C++
+= GCC - GNU Compiler Collection
 
 The `gcc` module supports the http://gcc.gnu.org[GNU C++ compiler] on
 Linux, a number of Unix-like system including SunOS and on Windows