Commit Graph

295 Commits

Author SHA1 Message Date
Chris Lattner 6953a6e799 update this manual
llvm-svn: 21965
2005-05-13 20:01:11 +00:00
Misha Brukman 6818b33096 extract has been renamed to llvm-extract to avoid conflicting with another tool
llvm-svn: 21501
2005-04-24 17:46:58 +00:00
Reid Spencer d6312210d1 There is no =head3. Convert to =head2.
llvm-svn: 21430
2005-04-22 02:16:19 +00:00
Reid Spencer 84f3911b09 Correct the documentation to match the program.
llvm-svn: 21429
2005-04-22 02:12:41 +00:00
Reid Spencer 895e00b418 Remove a -C I forgot to remove earlier.
llvm-svn: 20321
2005-02-24 21:41:26 +00:00
Reid Spencer e6684c8c82 For PR528:
Use the DataInstall and MKDIR macros instead of using $(INSTALL) directly

llvm-svn: 20318
2005-02-24 21:28:08 +00:00
Misha Brukman 634b0a3b7e * llvmc does not have a -V switch
* --config-file is really --config-dir, according to `llvmc --help'

llvm-svn: 20238
2005-02-18 18:00:53 +00:00
Reid Spencer 97f0f7646d Document the --load option.
llvm-svn: 19822
2005-01-25 05:04:49 +00:00
Reid Spencer 0e48bf8a19 Rename BUILD_* to PROJ_*
llvm-svn: 19592
2005-01-16 02:21:29 +00:00
Chris Lattner 132e400d73 ignore generated file
llvm-svn: 19288
2005-01-05 16:01:00 +00:00
Chris Lattner 05788f97f4 Ignore generated file
llvm-svn: 19287
2005-01-05 16:00:42 +00:00
Chris Lattner 3c6909423d Ignore .dir
llvm-svn: 19286
2005-01-05 16:00:00 +00:00
Reid Spencer 296cf274fd Hopefully fix a link.
llvm-svn: 19102
2004-12-22 06:48:03 +00:00
Reid Spencer 85a38ded31 Fix the names of these executables now that they've been somewhat cast in
stone.

llvm-svn: 19101
2004-12-22 06:47:25 +00:00
Reid Spencer 8f72ce0fd2 A little cleanup on this file.
llvm-svn: 18798
2004-12-11 07:16:54 +00:00
John Criswell dfe6a86b0b Merged in RELEASE_14 changes.
llvm-svn: 18763
2004-12-10 15:51:16 +00:00
Misha Brukman 61cf9c8811 Missed moving bugpoint link over to CommandGuide/html/
llvm-svn: 18732
2004-12-09 23:28:09 +00:00
Misha Brukman 4f1f92e323 Generated HTML documentation is now back in CommandGuide/html/
llvm-svn: 18731
2004-12-09 23:25:59 +00:00
Chris Lattner 0793bfc457 Clean up this man page
llvm-svn: 18724
2004-12-09 21:16:40 +00:00
Chris Lattner 6e8183063f Add new pseudo target
llvm-svn: 18723
2004-12-09 21:06:32 +00:00
Misha Brukman 32f139a169 The textual description is gone from this manpage, only the options and a quick
summary remain.  The manpage references Bugpoint.html as the repository for more
detailed info.

llvm-svn: 18722
2004-12-09 20:28:42 +00:00
Reid Spencer 0601d01f43 Build the man and ps versions of the command guide as well when
BUILD_FOR_WEBSITE is set.

llvm-svn: 18653
2004-12-08 19:01:01 +00:00
Reid Spencer 8f59e90cef Make an alternate version of this Makefile that can be used in an
unconfigured tree for rebuilding the html files from POD sources for the
website update on cvs commit.

llvm-svn: 18616
2004-12-08 04:43:40 +00:00
Reid Spencer e1cb6b9e2e Fix two bugs:
1. Nothing should happen on "make all". Doc generation is quick, but we
   don't want to do it unless we're installing.
2. Correct a dependency for the *.ps files .. didn't notice this before
   because of cruft in my directory. It failed on a clean build.

llvm-svn: 18359
2004-11-29 14:46:29 +00:00
Reid Spencer 9d3b50038d * Get rid of extraneous directories
* Ensure things installed to same place are all getting there by using a
  variable to name that place.
* Make sure missing index.html, images and *.css files get installed.

llvm-svn: 18321
2004-11-29 04:34:05 +00:00
Reid Spencer f8685399eb * add llvmc and llvm-ld
* fix the links to not be in an html subdir as that's not how this gets
  installed (anymore).

llvm-svn: 18320
2004-11-29 04:32:37 +00:00
Reid Spencer 94ade72d66 * Adjust so this falls in line with LLVM Makefile standards.
* Implement installation of doxygen and html documentation
* Fix it so it works with objdir != srcdir.

llvm-svn: 18318
2004-11-29 03:45:02 +00:00
Reid Spencer 7d42417cc5 * Fix an item list.
* Add an ENVIRONMENT section to describe LLVM_LIB_SEARCH_PATH

llvm-svn: 18317
2004-11-29 03:43:29 +00:00
Reid Spencer 0f9dabd0f8 Add a link.
llvm-svn: 18316
2004-11-29 03:37:54 +00:00
Reid Spencer 3f4f1e3511 First version of manual page for llvm-ld.
llvm-svn: 18092
2004-11-21 18:20:16 +00:00
Misha Brukman a559eee32f Ignore files generated by pod2html
llvm-svn: 18017
2004-11-19 21:54:43 +00:00
Reid Spencer f8d6f7e973 Add a standards section.
llvm-svn: 17921
2004-11-17 20:19:18 +00:00
Misha Brukman ef8d601a53 Be less verbose when `The' and `command' just aren't necessary
llvm-svn: 17846
2004-11-15 20:39:30 +00:00
Misha Brukman 6c668c4fba No need for the verbose `the llvm-link command' when simply `llvm-link' will do
llvm-svn: 17845
2004-11-15 20:36:39 +00:00
Misha Brukman 16c9176043 Force a short link to gccld's man page
llvm-svn: 17844
2004-11-15 20:32:58 +00:00
Misha Brukman da25907381 Fix syntax within a B<> tag
llvm-svn: 17843
2004-11-15 20:30:19 +00:00
Reid Spencer e51e5724b7 Remove personal email address.
llvm-svn: 17842
2004-11-15 20:25:08 +00:00
Misha Brukman 4055d31868 Add the PowerPC 32-bit ABI output option
llvm-svn: 17840
2004-11-15 20:22:49 +00:00
Chris Lattner cc93ee5b45 Bump version. Shouldn't this come from somewhere else??
llvm-svn: 17839
2004-11-15 20:06:11 +00:00
Misha Brukman a8e1718932 * Add an entry for llvm-ranlib
* Add missing dashes

llvm-svn: 17838
2004-11-15 19:53:43 +00:00
Misha Brukman 774a6be462 This is llvm-ar, not llvm-as.
llvm-svn: 17837
2004-11-15 19:50:15 +00:00
Reid Spencer d4d25bdb2b Remove reference to llvm-ld.
llvm-svn: 17836
2004-11-15 19:47:20 +00:00
Reid Spencer 38f5a1c6c4 Terminate a list.
Remove reference to llvm-ld

llvm-svn: 17835
2004-11-15 19:45:29 +00:00
Reid Spencer bfa25440e7 Changes/corrections suggested from Chris Lattner's review.
llvm-svn: 17832
2004-11-15 19:12:06 +00:00
Reid Spencer 2ea5ae618c Document the new llvm-ranlib command.
llvm-svn: 17687
2004-11-12 00:18:35 +00:00
Reid Spencer ffb9f06135 Correctly terminate a list.
llvm-svn: 17686
2004-11-12 00:16:51 +00:00
Reid Spencer 2e34034d80 Document the modifiers and the file format.
llvm-svn: 17685
2004-11-12 00:15:43 +00:00
Reid Spencer e448500e6d Add llvm-ar to the index.
llvm-svn: 17682
2004-11-11 09:30:00 +00:00
Reid Spencer 8beeb49594 First attempt at llvm-ar documentation. Modifiers need a little more
explanation.

llvm-svn: 17681
2004-11-11 09:21:18 +00:00
Reid Spencer 01b22282fc Document definitions and computations provided by llvm-bcanalyzer.
llvm-svn: 16044
2004-08-25 00:35:20 +00:00
Reid Spencer 4606127bf2 Move information on Configuration files to the ../CompilerDriver.html
file since it doesn't belong in the man page.

llvm-svn: 15575
2004-08-09 03:10:39 +00:00
Reid Spencer 6c70fdd7b8 Added information about the configuration file. This is a temporary home
for this information as it belongs in a larger document on the subject of
llvmc.

llvm-svn: 15566
2004-08-07 16:30:14 +00:00
Reid Spencer e132906258 Correct spelling mistakes. Wrap lines at 80 columns.
llvm-svn: 15562
2004-08-06 22:56:49 +00:00
Reid Spencer fd5ea75c3e Various updates suggested by Misha and Chris. Moved material that is
aimed more at the comiler writer than the llvmc user later in the document.

llvm-svn: 15561
2004-08-06 22:28:47 +00:00
Reid Spencer 9a908daf38 First version of a manual page for the llvmc compiler driver. This tool is
being documented before being written to foster discussion about what the
tool should do. Eventually, we'll achieve a decision point at which time
this document forms the requirements for the tool from which it will be
coded.

llvm-svn: 15552
2004-08-06 16:58:48 +00:00
Misha Brukman ab25ccb9ea Fix spelling of `iterative scan'
llvm-svn: 15075
2004-07-21 12:53:14 +00:00
Alkis Evlogimenos d524e5bdf2 Add Iterative scan register allocator.
llvm-svn: 15068
2004-07-21 08:24:35 +00:00
Alkis Evlogimenos c03ccc225b Linearscan is no longer experimental.
llvm-svn: 15067
2004-07-21 08:18:50 +00:00
Reid Spencer 3c0249e916 - Correct grammar of -s description
- Normalize -s option specification

llvm-svn: 14736
2004-07-10 23:41:08 +00:00
Chris Lattner f61dbbaa7c Add link to the stkrc page
llvm-svn: 14734
2004-07-10 21:43:12 +00:00
Reid Spencer 487b1e5bf4 Command Guide for the Stacker language compiler, stkrc.
llvm-svn: 14733
2004-07-10 20:04:02 +00:00
Chris Lattner 517d650eb3 Minor cleanups:
* Mention the --help and --help-hidden options
 * Don't say program when we really mean any old bytecode file
 * Add a link to the man pages
 * Move analyze down in the list, as it's not as important as the rest

llvm-svn: 14730
2004-07-10 06:06:56 +00:00
Misha Brukman 6c4644b4a9 * Standardize manpage output: program name bold, options italic/emphasized
* Make links in SEE ALSO section of manpages short without "the ... manpage"

llvm-svn: 14579
2004-07-02 16:06:19 +00:00
Misha Brukman 763855342b The HTML documentation is now automatically generated from POD source.
llvm-svn: 14578
2004-07-02 15:48:33 +00:00
Misha Brukman cbbf9a1f8f * Link to the POD-generated HTML documentation
* Updated llvm-abcd to llvm-bcanalyzer

llvm-svn: 14577
2004-07-02 15:46:55 +00:00
Misha Brukman bbd9759fd6 Make `args' stand out as bold, delete confusing elipsis at the end of cmdline.
llvm-svn: 14576
2004-07-02 15:42:20 +00:00
Misha Brukman 064e9b7cf0 HTML links in PODs must be absolute.
llvm-svn: 14575
2004-07-02 15:37:53 +00:00
Misha Brukman 0e21722a9f Simplify wording: `the bugpoint tool' can just become `bugpoint'.
llvm-svn: 14574
2004-07-02 15:36:29 +00:00
Misha Brukman 2410a8807e llvm-abcd has become llvm-bcanalyzer
llvm-svn: 14573
2004-07-02 15:32:49 +00:00
Reid Spencer 7efe23752f llvm-abcd tool name changed to llvm-bcanalyzer: see llvm-bcanalyzer.pod.
llvm-svn: 14557
2004-07-02 03:45:32 +00:00
Reid Spencer b703e0b32f Podified documentation for the llvm-bcanalyzer tool (nee llvm-abcd).
llvm-svn: 14556
2004-07-02 03:44:14 +00:00
Brian Gaeke d4ba0a5721 bug. point. pod.
llvm-svn: 14547
2004-07-01 20:29:08 +00:00
Brian Gaeke b8a340a3bf abcd pod document
llvm-svn: 14543
2004-07-01 20:07:15 +00:00
Brian Gaeke cc7cafb371 llvm-nm pod format man page.
llvm-svn: 14542
2004-07-01 19:40:36 +00:00
Misha Brukman fa3561c603 Fix grammar: remove `our' as it no longer makes sense.
llvm-svn: 14540
2004-07-01 18:34:46 +00:00
Chris Lattner 8a9d11b1bc This is more of an "llvm team" thing by now
llvm-svn: 14539
2004-07-01 18:25:59 +00:00
Misha Brukman 0667a12dcd llvm-db is in alpha stage, this document is a placeholder.
llvm-svn: 14538
2004-07-01 18:00:42 +00:00
Misha Brukman 3121ce052f Fix links to llvmgcc and llvmgxx
llvm-svn: 14537
2004-07-01 17:59:53 +00:00
Misha Brukman ae8b03362c gccld enters the Hall of POD.
llvm-svn: 14536
2004-07-01 17:53:27 +00:00
Misha Brukman 082fe484ed Make the text of the link to llvmgxx.html more appropriate: `llvmg++'.
llvm-svn: 14535
2004-07-01 17:52:58 +00:00
Misha Brukman 61a747f60b Mention llvm-abcd, point out difference between it and `analyze'.
llvm-svn: 14532
2004-07-01 16:59:05 +00:00
Misha Brukman b410763f25 Change format of CommandGuide index page to look like other docs.
llvm-svn: 14531
2004-07-01 16:04:49 +00:00
Misha Brukman 6836eaed42 Fresh from the LLVM baker's oven: opt and analyze pods.
llvm-svn: 14529
2004-07-01 15:25:04 +00:00
Misha Brukman dfb5a7b925 Add llvm-g++ and llvm-gcc pod documentation.
llvm-svn: 14528
2004-07-01 14:51:26 +00:00
Misha Brukman 81e616976f Fix link to llvmgcc.
llvm-svn: 14527
2004-07-01 14:47:05 +00:00
Misha Brukman 0c7ed6e335 Make links relative instead of absolute.
llvm-svn: 14525
2004-07-01 13:52:35 +00:00
Reid Spencer 209ae4bd6d Added a command page for the llvm-abcd tool.
llvm-svn: 14513
2004-07-01 02:32:42 +00:00
Tanya Lattner 31d8921d1d Changing absolute link. Remembering to logout as root ;)
llvm-svn: 14309
2004-06-21 23:36:39 +00:00
Tanya Lattner c0b271710c Just a stub command guide for llvm-db for now. Will be filled in later. This is not linked off the main command guide web page, but should be once its completed.
llvm-svn: 14307
2004-06-21 23:27:57 +00:00
Brian Gaeke 60f37d6df7 Another pod
llvm-svn: 13969
2004-06-02 20:55:52 +00:00
Brian Gaeke 51b3ef02ad The llvm-dis.html page was a little out of date, but this pod file can supersede it.
llvm-svn: 13968
2004-06-02 20:45:25 +00:00
Brian Gaeke e35ca2ec1c Tasty, tasty pods...
llvm-svn: 13966
2004-06-02 20:29:49 +00:00
Chris Lattner 05a292a37f The -q option is gone
llvm-svn: 13965
2004-06-02 19:51:09 +00:00
Chris Lattner 7113171f63 The --enable-correct-eh-support option is meaningless when provided to
gccas.

llvm-svn: 13964
2004-06-02 19:30:23 +00:00
Brian Gaeke 098fc08d54 Here's another pod.
llvm-svn: 13961
2004-06-02 19:21:26 +00:00
Brian Gaeke 9e8f8628c3 Look, it's a gccas pod.
llvm-svn: 13960
2004-06-02 19:12:38 +00:00
Chris Lattner 3709627b7d Unbreak the bugpoint image
llvm-svn: 13878
2004-05-28 16:49:54 +00:00
Misha Brukman 7e39a19ecb Rename "User's Guide" to "Command Guide" to be consistent with current scheme.
llvm-svn: 13580
2004-05-14 20:29:11 +00:00
Misha Brukman 0dbe2acf5f Ignore generated ps files.
llvm-svn: 13579
2004-05-14 20:26:45 +00:00
Misha Brukman d198ac5470 Ignore generated man files.
llvm-svn: 13578
2004-05-14 20:26:39 +00:00
Misha Brukman caed51e6f7 Ignore generated HTML files.
llvm-svn: 13577
2004-05-14 20:26:34 +00:00
Misha Brukman 5ac525ba39 This is the stylesheet used by perldoc.com; we shall modify it as we see fit.
llvm-svn: 13576
2004-05-14 20:25:35 +00:00
Misha Brukman 13b433ecf5 Put outputs of each type into a separate subdirectory.
llvm-svn: 13575
2004-05-14 20:24:59 +00:00
Brian Gaeke ee7068ef6d More pods... work in progress
llvm-svn: 13574
2004-05-14 19:50:33 +00:00
Brian Gaeke 1274e44002 NAME section is supposed to have a brief description, for apropos(1) & whatis(1)
llvm-svn: 13570
2004-05-14 18:31:13 +00:00
Brian Gaeke c5565949df This seems like as good a place as any to keep POD files.
llvm-svn: 13569
2004-05-14 18:03:22 +00:00
Brian Gaeke 48ef3f0fa1 update command guide to have --tool-args
llvm-svn: 13359
2004-05-04 21:13:35 +00:00
Misha Brukman d2493e1565 * Remove note about "UNSUPPORTED: " feature that just became supported
* Fix usage of <p> tag and some grammar

llvm-svn: 13062
2004-04-19 03:28:39 +00:00
Chris Lattner 7f601ade01 Document new option
llvm-svn: 12699
2004-04-06 16:46:12 +00:00
Chris Lattner 3ef249c05e Update docs a bit
llvm-svn: 12695
2004-04-06 15:22:35 +00:00
Chris Lattner 80e594fa80 Remove some options that don't really have anything to do with bugpoint
llvm-svn: 12694
2004-04-06 15:14:10 +00:00
John Criswell fa2f3686a3 Merged in RELEASE_12.
llvm-svn: 12532
2004-03-29 20:23:11 +00:00
Chris Lattner 84d0f63804 Option no more
llvm-svn: 12360
2004-03-13 19:36:30 +00:00
John Criswell 13875932b2 Performed some updates on the new options to these command line tools.
llvm-svn: 12350
2004-03-12 22:45:35 +00:00
Alkis Evlogimenos 79850121ad Add simple spiller.
llvm-svn: 12188
2004-03-06 22:38:29 +00:00
Alkis Evlogimenos 36fd868f08 The default register allocator is local not simple.
llvm-svn: 12187
2004-03-06 22:27:41 +00:00
Alkis Evlogimenos cb8937197e Make <di> into <dt> (definition list term).
llvm-svn: 12072
2004-03-02 03:36:10 +00:00
Alkis Evlogimenos 45da18d2a4 Fix <p> missing <p> tag
llvm-svn: 12063
2004-03-01 23:25:38 +00:00
Alkis Evlogimenos 31953c7a10 Add a spiller option to llc. A simple spiller will come soon. When we get CFG in the machine code represenation a global spiller will also be possible. Also document the linear scan register allocator but mark it as experimental for now.
llvm-svn: 12062
2004-03-01 23:18:15 +00:00
Chris Lattner 5f015c709c Document the code generator debugger.
llvm-svn: 11616
2004-02-18 23:30:21 +00:00
Chris Lattner 4d885d9dcc document the -march=c option
llvm-svn: 11615
2004-02-18 23:30:02 +00:00
Chris Lattner 7f059ebd78 Extract has new options
llvm-svn: 11581
2004-02-18 16:55:29 +00:00
Misha Brukman 4dd7a7245f PreSelection isn't optional and so there's no way to turn it off.
llvm-svn: 11504
2004-02-16 19:45:26 +00:00
Brian Gaeke bc67d59ac8 add advice bullet about -check-exit-code
llvm-svn: 11327
2004-02-11 18:44:55 +00:00
Brian Gaeke 228a29b711 add description of -check-exit-code
llvm-svn: 11326
2004-02-11 18:40:04 +00:00
Chris Lattner cad1501db8 Fix documentation bugs
llvm-svn: 11267
2004-02-10 18:04:24 +00:00
John Criswell 2edea847fc Clarified the extension to shared library objects.
llvm-svn: 10978
2004-01-26 21:26:54 +00:00
Chris Lattner 121d04d1ae A line was missing
llvm-svn: 10269
2003-11-30 05:46:14 +00:00
Brian Gaeke e86d843420 Update to reflect the fact that llvm-nm can read archives now.
llvm-svn: 10061
2003-11-18 06:18:09 +00:00
Brian Gaeke 9c917abe9f Document -disable-opt option that I added.
llvm-svn: 10045
2003-11-16 23:39:11 +00:00
Chris Lattner dc79f6c776 Add new commandline option
llvm-svn: 9755
2003-11-06 20:29:33 +00:00
Chris Lattner a616c55ba9 Bugpoint no longer has this option
llvm-svn: 9744
2003-11-05 21:46:13 +00:00
Chris Lattner 38e692da04 Add note about profile.sh
llvm-svn: 9652
2003-11-02 05:20:44 +00:00
Chris Lattner d57aa5e8a5 Checkin an initial version of the llvm-prof documentation
llvm-svn: 9649
2003-11-02 02:10:54 +00:00
Brian Gaeke b8c28f3553 Well, to be honest, -array-checks and -trace are gone, too. :-)
llvm-svn: 9631
2003-10-31 05:12:04 +00:00
Misha Brukman 47e7fd2c0f * Not much point to indent the whole file
* Let CVS keep track of our last-modified timestamp

llvm-svn: 9628
2003-10-31 00:39:28 +00:00
Misha Brukman c64b74554a The `-q' option has gone away.
llvm-svn: 9627
2003-10-31 00:34:52 +00:00
Misha Brukman 774b94a74b Fixed the documentation to coincide with the code.
llvm-svn: 9301
2003-10-20 19:47:25 +00:00
Brian Gaeke 98e1f50d0c Change it to match llvmgcc.html ... why do we have separate pages for these two?
llvm-svn: 9265
2003-10-19 18:23:05 +00:00
Brian Gaeke 7c49d984d2 Clarify the roles of gccld and gccas.
Mention that they should really read the gcc manual.

llvm-svn: 9264
2003-10-19 18:15:18 +00:00
Brian Gaeke cfd030726c Minor edits; also expand description of '-v' option.
llvm-svn: 9263
2003-10-19 18:09:24 +00:00
Brian Gaeke e4cea8cd34 Tweak -plugin description to match bugpoint.html
llvm-svn: 9262
2003-10-19 18:08:57 +00:00
Brian Gaeke 70e81e2320 Mostly rewritten.
llvm-svn: 9261
2003-10-19 18:03:11 +00:00
Chris Lattner d46f945b43 A minor fix
llvm-svn: 9260
2003-10-19 17:37:33 +00:00
Brian Gaeke c852194dec Take out extra paragraph tag.
llvm-svn: 9259
2003-10-19 17:37:12 +00:00
Brian Gaeke 8ef235e2fc Make this (-run) set look like the other (-disable) set.
llvm-svn: 9258
2003-10-19 17:35:35 +00:00
Brian Gaeke 33534d7ba9 Always say "the test program", part 2.
Refer to the various "modules" of bugpoint as "debuggers", not
 "debugging modes" or "modules". I think this is more evocative of
 how they typically act, and it's shorter.
Add a note about how a linker bug can crash bugpoint early.

llvm-svn: 9257
2003-10-19 17:30:36 +00:00
Chris Lattner 90f86a79c4 Two minor fixes
llvm-svn: 9256
2003-10-19 17:27:12 +00:00
Brian Gaeke abe08a6ee0 Minor edits to Description section.
Add Design Philosophy as a separate subsection.  Clarify its last sentence.
Give Automatic Mode Selection a uniquely-named anchor.
Always call the program the "test program", instead of the "initial program",
 the "LLVM program", the "test case", the "resultant module", etc.
Try to explain the assumptions a little more, instead of just describing the
 process.

llvm-svn: 9255
2003-10-19 17:20:15 +00:00
Brian Gaeke c8cff0e914 Spell-check.
Many minor edits.
Rewrite some of the options section for grammatical parallelism,
 clarity, and brevity.

llvm-svn: 9254
2003-10-19 17:03:59 +00:00