From a1ef529703172a1eb432782b3494512b74af6b07 Mon Sep 17 00:00:00 2001
From: Jorge Aparicio <jorge@japaric.io>
Date: Tue, 1 May 2018 06:34:12 +0200
Subject: [PATCH] document what each tools does

---
 src/bootstrap/lib.rs | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/src/bootstrap/lib.rs b/src/bootstrap/lib.rs
index c271af3f035..dec514a0da6 100644
--- a/src/bootstrap/lib.rs
+++ b/src/bootstrap/lib.rs
@@ -200,7 +200,11 @@ use cache::{Interned, INTERNER};
 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.