LLVM Command Guide

From 68cb31901c590cabceee6e6356d62c84142114cb Mon Sep 17 00:00:00 2001 From: mike-m Date: Thu, 6 May 2010 23:45:43 +0000 Subject: Overhauled llvm/clang docs builds. Closes PR6613. NOTE: 2nd part changeset for cfe trunk to follow. *** PRE-PATCH ISSUES ADDRESSED - clang api docs fail build from objdir - clang/llvm api docs collide in install PREFIX/ - clang/llvm main docs collide in install - clang/llvm main docs have full of hard coded destination assumptions and make use of absolute root in static html files; namely CommandGuide tools hard codes a website destination for cross references and some html cross references assume website root paths *** IMPROVEMENTS - bumped Doxygen from 1.4.x -> 1.6.3 - splits llvm/clang docs into 'main' and 'api' (doxygen) build trees - provide consistent, reliable doc builds for both main+api docs - support buid vs. install vs. website intentions - support objdir builds - document targets with 'make help' - correct clean and uninstall operations - use recursive dir delete only where absolutely necessary - added call function fn.RMRF which safeguards against botched 'rm -rf'; if any target (or any variable is evaluated) which attempts to remove any dirs which match a hard-coded 'safelist', a verbose error will be printed and make will error-stop. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@103213 91177308-0d34-0410-b5e6-96231b3b80d8 --- docs/CommandGuide/index.html | 155 ------------------------------------------- 1 file changed, 155 deletions(-) delete mode 100644 docs/CommandGuide/index.html (limited to 'docs/CommandGuide/index.html') diff --git a/docs/CommandGuide/index.html b/docs/CommandGuide/index.html deleted file mode 100644 index 72cd2cf5f9..0000000000 --- a/docs/CommandGuide/index.html +++ /dev/null @@ -1,155 +0,0 @@ - - - - LLVM Command Guide - - - - -

- LLVM Command Guide -

- -

These documents are HTML versions of the man pages -for all of the LLVM tools. These pages describe how to use the LLVM commands -and what their options are. Note that these pages do not describe all of the -options available for all tools. To get a complete listing, pass the --help (general options) or -help-hidden (general+debugging -options) arguments to the tool you are interested in.

- -

- - -

- Basic Commands -

- - -

- -

llvm-as - - assemble a human-readable .ll file into bytecode
llvm-dis - - disassemble a bytecode file into a human-readable .ll file
opt - - run a series of LLVM-to-LLVM optimizations on a bytecode file
llc - - generate native machine code for a bytecode file
lli - - directly run a program compiled to bytecode using a JIT compiler or - interpreter
llvm-link - - link several bytecode files into one
llvm-ar - - archive bytecode files
llvm-ranlib - - create an index for archives made with llvm-ar
llvm-nm - - print out the names and types of symbols in a bytecode file
llvm-prof - - format raw `llvmprof.out' data into a human-readable report
llvm-ld - - general purpose linker with loadable runtime optimization support
llvm-config - - print out LLVM compilation options, libraries, etc. as configured
llvmc - - a generic customizable compiler driver

- -

- - -

- C and C++ Front-end Commands -

- - -

llvm-gcc - - GCC-based C front-end for LLVM - -
llvm-g++ - - GCC-based C++ front-end for LLVM

- -

- - -

- Debugging Tools -

- - - -

- -

bugpoint - - automatic test-case reducer
llvm-extract - - extract a function from an LLVM bytecode file
llvm-bcanalyzer - - bytecode analyzer (analyzes the binary encoding itself, not the program it - represents)

- - -

- Internal Tools -

- - -

FileCheck - - Flexible file verifier used extensively by the testing harness
tblgen - - target description reader and generator
lit - - LLVM Integrated Tester, for running tests

- - - -

- - LLVM Compiler Infrastructure
- Last modified: $Date$ -

- - - -- cgit v1.2.3