diff options
| author | mike-m <mikem.llvm@gmail.com> | 2010-05-06 23:45:43 +0000 |
|---|---|---|
| committer | mike-m <mikem.llvm@gmail.com> | 2010-05-06 23:45:43 +0000 |
| commit | e08af303a642a69accf5d06c5ac61e6b8f2ef6b6 (patch) | |
| tree | 24747fb284e35af6cb557d1babe317d7ac59c3be /llvm/docs/doxygen.intro | |
| parent | 0b4b46e3e16fc2f9a48d48a8bad0ebe2c7310348 (diff) | |
| download | bcm5719-llvm-e08af303a642a69accf5d06c5ac61e6b8f2ef6b6.tar.gz bcm5719-llvm-e08af303a642a69accf5d06c5ac61e6b8f2ef6b6.zip | |
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.
llvm-svn: 103213
Diffstat (limited to 'llvm/docs/doxygen.intro')
| -rw-r--r-- | llvm/docs/doxygen.intro | 18 |
1 files changed, 0 insertions, 18 deletions
diff --git a/llvm/docs/doxygen.intro b/llvm/docs/doxygen.intro deleted file mode 100644 index 547730cba79..00000000000 --- a/llvm/docs/doxygen.intro +++ /dev/null @@ -1,18 +0,0 @@ -/// @mainpage Low Level Virtual Machine -/// -/// @section main_intro Introduction -/// Welcome to the Low Level Virtual Machine (LLVM). -/// -/// This documentation describes the @b internal software that makes -/// up LLVM, not the @b external use of LLVM. There are no instructions -/// here on how to use LLVM, only the APIs that make up the software. For usage -/// instructions, please see the programmer's guide or reference manual. -/// -/// @section main_caveat Caveat -/// This documentation is generated directly from the source code with doxygen. -/// Since LLVM is constantly under active development, what you're about to -/// read is out of date! However, it may still be useful since certain portions -/// of LLVM are very stable. -/// -/// @section main_changelog Change Log -/// - Original content written 12/30/2003 by Reid Spencer |
