summaryrefslogtreecommitdiff
path: root/lld/tools
diff options
context:
space:
mode:
authorRui Ueyama <ruiu@google.com>2018-06-08 00:18:32 +0000
committerRui Ueyama <ruiu@google.com>2018-06-08 00:18:32 +0000
commite53890f33ef418197d610bf4bd47961b773e77df (patch)
treed18fa914966651bc20ad72bfa8649cd8bdfff1e4 /lld/tools
parent7d17d7278b5eec9c3e063568e1e43bf2f577c0b7 (diff)
downloadllvm-e53890f33ef418197d610bf4bd47961b773e77df.tar.gz
Expand comments.
llvm-svn: 334250
Diffstat (limited to 'lld/tools')
-rw-r--r--lld/tools/lld/lld.cpp20
1 files changed, 15 insertions, 5 deletions
diff --git a/lld/tools/lld/lld.cpp b/lld/tools/lld/lld.cpp
index 2c00a131436e..edc74bf32930 100644
--- a/lld/tools/lld/lld.cpp
+++ b/lld/tools/lld/lld.cpp
@@ -7,12 +7,22 @@
//
//===----------------------------------------------------------------------===//
//
-// This is the entry point to the lld driver. This is a thin wrapper which
-// dispatches to the given platform specific driver.
+// This file contains the main function of the lld executable. The main
+// function is a thin wrapper which dispatches to the platform specific
+// driver.
//
-// If there is -flavor option, it is dispatched according to the arguments.
-// If the flavor parameter is not present, then it is dispatched according
-// to argv[0].
+// lld is a single executable that contains four different linkers for ELF,
+// COFF, WebAssembly and Mach-O. The main function dispatches according to
+// argv[0] (i.e. command name). The most common name for each target is shown
+// below:
+//
+// - ld.lld: ELF (Unix)
+// - ld64: Mach-O (macOS)
+// - lld-link: COFF (Windows)
+// - ld-wasm: WebAssembly
+//
+// lld can be invoked as "lld" along with "-flavor" option. This is for
+// backward compatibility and not recommended.
//
//===----------------------------------------------------------------------===//