]> git.lizzy.rs Git - rust.git/commitdiff
document what each tools does
authorJorge Aparicio <jorge@japaric.io>
Tue, 1 May 2018 04:34:12 +0000 (06:34 +0200)
committerJorge Aparicio <jorge@japaric.io>
Sun, 3 Jun 2018 16:23:01 +0000 (18:23 +0200)
src/bootstrap/lib.rs

index c271af3f035bda4f5c710ba2e31ac21b001be052..dec514a0da6e677b3430ea80a1c9711152634151 100644 (file)
@@ -200,7 +200,11 @@ pub unsafe fn setup(_build: &mut ::Build) {
 use toolstate::ToolState;
 
 const LLVM_TOOLS: &[&str] = &[
-    "llvm-nm", "llvm-objcopy", "llvm-objdump", "llvm-profdata", "llvm-size",
+    "llvm-nm", // used to inspect binaries; it shows symbol names, their sizes and visibility
+    "llvm-objcopy", // used to transform ELFs into binary format which flashing tools consume
+    "llvm-objdump", // used to disassemble programs
+    "llvm-profdata", // used to inspect and merge files generated by profiles
+    "llvm-size", // prints the size of the linker sections of a program
 ];
 
 /// A structure representing a Rust compiler.