Commit Graph

68 Commits

Author SHA1 Message Date
Daniel Dunbar
adea497673 [docs] Update HTML pages to refer to CSS in a way that works locally and with Sphinx.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@155153 91177308-0d34-0410-b5e6-96231b3b80d8
2012-04-19 20:20:34 +00:00
NAKAMURA Takumi
f5af6ada3b docs: Introduce cascading style <div> and <p> continued on <h[2-5]>.
<h2>Section Example</h2>
<div> <!-- h2+div is applied -->
<p>Section preamble.</p>

<h3>Subsection Example</h3>
<p> <!-- h3+p is applied -->
Subsection body
</p>

<!-- End of section body -->
</div>

FIXME: Care H5 better.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@130040 91177308-0d34-0410-b5e6-96231b3b80d8
2011-04-23 00:30:22 +00:00
NAKAMURA Takumi
05d0265fef docs: Use <Hn> as Heading elements instead of <DIV class="doc_foo">.
H1 ... doc_title
H2 ... doc_section
H3 ... doc_subsection
H4 ... doc_subsubsection

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@129736 91177308-0d34-0410-b5e6-96231b3b80d8
2011-04-18 23:59:50 +00:00
NAKAMURA Takumi
dd499c3dd2 docs/CommandLine.html: &quot;ize.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@129267 91177308-0d34-0410-b5e6-96231b3b80d8
2011-04-11 03:27:31 +00:00
NAKAMURA Takumi
b9a33634cc docs: Canonicalize URLs.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@129181 91177308-0d34-0410-b5e6-96231b3b80d8
2011-04-09 02:13:37 +00:00
mike-m
e2c3a49c80 Revert r103213. It broke several sections of live website.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@103219 91177308-0d34-0410-b5e6-96231b3b80d8
2010-05-07 00:28:04 +00:00
mike-m
68cb31901c 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
2010-05-06 23:45:43 +00:00
Dan Gohman
621a415c01 Fix typos in comments.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@97257 91177308-0d34-0410-b5e6-96231b3b80d8
2010-02-26 20:18:32 +00:00
Duncan Sands
7e7ae5ad69 Refer to -help instead of --help since this is what tools themselves say.
Also, have tools output -help-hidden rather than refer to --help-hidden,
for consistency, and likewise adjust documentation.  This doesn't change
every mention of --help, only those which seemed clearly safe.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@96578 91177308-0d34-0410-b5e6-96231b3b80d8
2010-02-18 14:08:13 +00:00
Benjamin Kramer
8040cd3cfd Documentation: Perform automated correction of common typos.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@83849 91177308-0d34-0410-b5e6-96231b3b80d8
2009-10-12 14:46:08 +00:00
Dan Gohman
0cabaa54e5 Update documentation for the -f change.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@79996 91177308-0d34-0410-b5e6-96231b3b80d8
2009-08-25 15:54:01 +00:00
Benjamin Kramer
e15192b36b Documentation: fix HTML validation errors.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@78196 91177308-0d34-0410-b5e6-96231b3b80d8
2009-08-05 15:42:44 +00:00
Benjamin Kramer
e6864c1d35 Remove duplicated colons and spaces.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@77892 91177308-0d34-0410-b5e6-96231b3b80d8
2009-08-02 12:13:02 +00:00
Mikhail Glushenkov
df04ead72b Formatting fix.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@73600 91177308-0d34-0410-b5e6-96231b3b80d8
2009-06-17 03:09:39 +00:00
Chris Lattner
00a7b52385 Remove AllowInverse: it leaks memory and is not the right
abstraction for CommandLine.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@68588 91177308-0d34-0410-b5e6-96231b3b80d8
2009-04-08 03:43:51 +00:00
Mike Stump
d64e0eb094 Improve -fno-opt style option processing to not require an extra
option to make the -fno- form on the option.  We also document the new
form in the CommandLine documentation.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@63559 91177308-0d34-0410-b5e6-96231b3b80d8
2009-02-02 22:48:49 +00:00
Mikhail Glushenkov
7059d47a6e Support for multi-valued options in CommandLine
Makes possible to specify options that take multiple arguments (a-la
-sectalign on Darwin). See documentation for details.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@62372 91177308-0d34-0410-b5e6-96231b3b80d8
2009-01-16 22:54:19 +00:00
Misha Brukman
444087057a Global replace of yellow W3C "valid HTML/CSS" icons with blue ones.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@60880 91177308-0d34-0410-b5e6-96231b3b80d8
2008-12-11 17:34:48 +00:00
Mikhail Glushenkov
beb4d8293d Add support for response files to the CommandLine library.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@50355 91177308-0d34-0410-b5e6-96231b3b80d8
2008-04-28 16:44:25 +00:00
Chris Lattner
8eedc9ee2c minor typo
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@49040 91177308-0d34-0410-b5e6-96231b3b80d8
2008-04-01 18:02:36 +00:00
Chris Lattner
74ba1711b7 fix typo, PR2181
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@48954 91177308-0d34-0410-b5e6-96231b3b80d8
2008-03-30 16:59:21 +00:00
Anton Korobeynikov
45982a5364 Add documentation for cl::sink stuff
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@47378 91177308-0d34-0410-b5e6-96231b3b80d8
2008-02-20 12:38:31 +00:00
Chris Lattner
8b44b90644 many cleanups and fixed, contributed by Sam Bishop
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@45780 91177308-0d34-0410-b5e6-96231b3b80d8
2008-01-09 19:28:50 +00:00
Chris Lattner
f021f8a5ac fix formatting
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@45214 91177308-0d34-0410-b5e6-96231b3b80d8
2007-12-19 19:48:49 +00:00
Dale Johannesen
0f2c8fc829 Document boolOrDefault and its parser.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@37290 91177308-0d34-0410-b5e6-96231b3b80d8
2007-05-22 18:32:34 +00:00
Bill Wendling
832171cb97 Removing even more <iostream> includes.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@32320 91177308-0d34-0410-b5e6-96231b3b80d8
2006-12-07 20:04:42 +00:00
Jim Laskey
f55914a529 Fix a couple typos.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@29416 91177308-0d34-0410-b5e6-96231b3b80d8
2006-07-31 20:18:49 +00:00
Reid Spencer
2403b855cd Document the cl::SetVersionPrinter function.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@28690 91177308-0d34-0410-b5e6-96231b3b80d8
2006-06-05 17:30:16 +00:00
Reid Spencer
05fe4b0256 Changes docs for llvm.cs.uiuc.edu -> llvm.org
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@26746 91177308-0d34-0410-b5e6-96231b3b80d8
2006-03-14 05:39:39 +00:00
Andrew Lenharth
94f3d1af5f this file moved
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@24356 91177308-0d34-0410-b5e6-96231b3b80d8
2005-11-14 19:32:05 +00:00
Jim Laskey
22b7dfa645 Changed unsigned long to unsigned.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@23078 91177308-0d34-0410-b5e6-96231b3b80d8
2005-08-26 09:25:54 +00:00
Jim Laskey
2602922735 Tweak of multiple occurance paragraph.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@23064 91177308-0d34-0410-b5e6-96231b3b80d8
2005-08-25 23:01:25 +00:00
Jim Laskey
1d8f626f66 Documentation updated to include upcoming support for bit vector support
(flags.)


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@23063 91177308-0d34-0410-b5e6-96231b3b80d8
2005-08-25 22:52:43 +00:00
Chris Lattner
ce5fcc30ae Revert my patch which changed the code to not work.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@22965 91177308-0d34-0410-b5e6-96231b3b80d8
2005-08-22 16:24:25 +00:00
Chris Lattner
730e15eb74 Make the example a bit easier to understand, suggested by Jim.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@22964 91177308-0d34-0410-b5e6-96231b3b80d8
2005-08-22 16:11:46 +00:00
Misha Brukman
c43d914175 Consistently surround `cl::' code structures with <b> and <tt> to make them
stand out as code


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@21846 91177308-0d34-0410-b5e6-96231b3b80d8
2005-05-10 22:05:27 +00:00
Misha Brukman
f75c4b444b Sprinkle code examples and command-line interaction examples with some style
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@20557 91177308-0d34-0410-b5e6-96231b3b80d8
2005-03-11 00:00:33 +00:00
Misha Brukman
1fc9f8ef0c * Use doc_code style for blocks of code
* Convert < to &lt; in <pre> block
* Use doc_hilite instead of doc_red style
* Put some classes and options in <tt> blocks


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@20100 91177308-0d34-0410-b5e6-96231b3b80d8
2005-02-09 22:49:05 +00:00
Reid Spencer
5f8448f79c Implement and document prefix options with arbitrary values including an
= sign. This needed to support -DNAME=value options as pass-through in
llvmc.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@18203 91177308-0d34-0410-b5e6-96231b3b80d8
2004-11-24 06:13:42 +00:00
John Criswell
c24d48282b It looks like I'm fixing a spelling mistake, but I'm really trying to
replicate the CVS performance problems that Reid is seeing.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@18089 91177308-0d34-0410-b5e6-96231b3b80d8
2004-11-21 14:34:34 +00:00
Reid Spencer
9bbba09139 Per code review:
*Implement/Document the cl::extrahelp feature instead of the MoreHelp ptr.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@17871 91177308-0d34-0410-b5e6-96231b3b80d8
2004-11-16 06:11:52 +00:00
Reid Spencer
c7d1d8256e Attempt HTML 4.01 Strict compliance.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@17399 91177308-0d34-0410-b5e6-96231b3b80d8
2004-11-01 09:16:30 +00:00
Reid Spencer
b993feb53c Add a blurb about exploiting the use of external storage.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@16114 91177308-0d34-0410-b5e6-96231b3b80d8
2004-08-30 05:56:51 +00:00
Reid Spencer
2c8ab588d5 Added description of usage of the getPosition() option on cl::opt and
cl::list.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@15726 91177308-0d34-0410-b5e6-96231b3b80d8
2004-08-13 20:19:14 +00:00
Reid Spencer
d8473378fe Fixed some spellos and grammaros.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@15610 91177308-0d34-0410-b5e6-96231b3b80d8
2004-08-10 16:38:18 +00:00
Chris Lattner
b406eadfe3 For 64-bit platform support, we now use the clEnumValEnd macro to terminate
cl::values lists


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@14869 91177308-0d34-0410-b5e6-96231b3b80d8
2004-07-16 00:10:54 +00:00
Chris Lattner
7911ce2578 Make use of the new doc_author class. "Seperate content from presentation" they said.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@13675 91177308-0d34-0410-b5e6-96231b3b80d8
2004-05-23 21:07:27 +00:00
Misha Brukman
c53aefb5ac Made to be HTML-4.01 (Strict) -compliant.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@13499 91177308-0d34-0410-b5e6-96231b3b80d8
2004-05-12 18:42:35 +00:00
Chris Lattner
be801bf248 Add a new cl::PositionalEatsArgs flag
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@13387 91177308-0d34-0410-b5e6-96231b3b80d8
2004-05-06 22:03:59 +00:00
Misha Brukman
8becd71d7c Actually have a target "#introduction" if we're making a link to it.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@9785 91177308-0d34-0410-b5e6-96231b3b80d8
2003-11-07 19:42:44 +00:00