aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEd Maste <emaste@FreeBSD.org>2023-04-05 15:21:26 +0000
committerEd Maste <emaste@FreeBSD.org>2023-04-05 17:05:15 +0000
commita9d0665bbba528efcce56333a9a58d18ffb3a108 (patch)
tree5ab6966216502b9ace99256b3ea5dd5d07a35e1b
parentce12afaa6fff46c9027eb6b2bd515a4e46ecefc9 (diff)
downloadsrc-a9d0665bbba528efcce56333a9a58d18ffb3a108.tar.gz
src-a9d0665bbba528efcce56333a9a58d18ffb3a108.zip
src.conf.5: Expand WITH_LLVM_BINUTILS description
List the specific tools that are controlled by WITH_LLVM_BINUTILS, and mention the tools that are always or never taken from LLVM. Tools come from one of three sources (LLVM, ELF Tool Chain, bespoke base system) and it is useful to be explicit. Reviewed by: markj Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D39428
-rw-r--r--share/man/man5/src.conf.519
-rw-r--r--tools/build/options/WITH_LLVM_BINUTILS19
2 files changed, 36 insertions, 2 deletions
diff --git a/share/man/man5/src.conf.5 b/share/man/man5/src.conf.5
index 565d551c8497..ff287a5b017e 100644
--- a/share/man/man5/src.conf.5
+++ b/share/man/man5/src.conf.5
@@ -906,7 +906,24 @@ some other way.
.It Va WITHOUT_LLVM_ASSERTIONS
Disable debugging assertions in LLVM.
.It Va WITH_LLVM_BINUTILS
-Install LLVM's binutils (ar, addr2line, nm, etc.) instead of ELF Tool Chain's.
+Install LLVM's binutils (without an llvm- prefix),
+instead of ELF Tool Chain's tools.
+This includes
+.Xr addr2line 1 ,
+.Xr ar 1 ,
+.Xr nm 1 ,
+.Xr objcopy 1 ,
+.Xr ranlib 1 ,
+.Xr readelf 1 ,
+.Xr size 1 ,
+and
+.Xr strip 1 .
+Regardless of this setting, LLVM tools are used for
+.Xr c++filt 1
+and
+.Xr objdump 1 .
+.Xr strings 1
+is always provided by ELF Tool Chain.
.It Va WITHOUT_LLVM_COV
Do not build the
.Xr llvm-cov 1
diff --git a/tools/build/options/WITH_LLVM_BINUTILS b/tools/build/options/WITH_LLVM_BINUTILS
index 8fa2c55f31a9..f60b1ebac0e4 100644
--- a/tools/build/options/WITH_LLVM_BINUTILS
+++ b/tools/build/options/WITH_LLVM_BINUTILS
@@ -1,2 +1,19 @@
.\" $FreeBSD$
-Install LLVM's binutils (ar, addr2line, nm, etc.) instead of ELF Tool Chain's.
+Install LLVM's binutils (without an llvm- prefix),
+instead of ELF Tool Chain's tools.
+This includes
+.Xr addr2line 1 ,
+.Xr ar 1 ,
+.Xr nm 1 ,
+.Xr objcopy 1 ,
+.Xr ranlib 1 ,
+.Xr readelf 1 ,
+.Xr size 1 ,
+and
+.Xr strip 1 .
+Regardless of this setting, LLVM tools are used for
+.Xr c++filt 1
+and
+.Xr objdump 1 .
+.Xr strings 1
+is always provided by ELF Tool Chain.