[llvm-commits] CVS: llvm/docs/index.html AliasAnalysis.html CFEBuildInstrs.html CodingStandards.html CommandLine.html DSGraphStatus.html GettingStarted.html HowToSubmitABug.html LangRef.html OpenProjects.html ProgrammersManual.html Projects.html TestingGuide.html WritingAnLLVMPass.html

John Criswell criswell at cs.uiuc.edu
Mon Oct 27 12:19:01 PST 2003


Changes in directory llvm/docs:

index.html updated: 1.1 -> 1.2
AliasAnalysis.html updated: 1.8 -> 1.9
CFEBuildInstrs.html updated: 1.4 -> 1.5
CodingStandards.html updated: 1.13 -> 1.14
CommandLine.html updated: 1.16 -> 1.17
DSGraphStatus.html updated: 1.15 -> 1.16
GettingStarted.html updated: 1.42 -> 1.43
HowToSubmitABug.html updated: 1.8 -> 1.9
LangRef.html updated: 1.34 -> 1.35
OpenProjects.html updated: 1.12 -> 1.13
ProgrammersManual.html updated: 1.47 -> 1.48
Projects.html updated: 1.7 -> 1.8
TestingGuide.html updated: 1.4 -> 1.5
WritingAnLLVMPass.html updated: 1.20 -> 1.21

---
Log message:

Merged in RELEASE_1.



---
Diffs of the changes:  (+343 -20)

Index: llvm/docs/index.html
diff -u /dev/null llvm/docs/index.html:1.2
--- /dev/null	Mon Oct 27 12:18:26 2003
+++ llvm/docs/index.html	Mon Oct 27 12:18:16 2003
@@ -0,0 +1,265 @@
+<html>
+<title>
+The LLVM Compiler Infrastructure
+</title>
+
+<body>
+
+<center>
+<h1>
+                       The LLVM Compiler Infrastructure
+                                 <br>
+        <a href="http://llvm.cs.uiuc.edu">http://llvm.cs.uiuc.edu</a>
+</h1>
+</center>
+
+<hr>
+
+<h2>
+Welcome to LLVM!
+</h2>
+This file is intended to do four things:
+<ol>
+	<li>
+	help you get started using LLVM;
+	</li>
+
+	<li>
+	tell you how to get questions about LLVM answered;
+	</li>
+
+	<li>
+	tell you where to find documentation for different kinds of questions; and
+	</li>
+
+	<li>
+	tell you about three LLVM-related mailing lists.
+	</li>
+</ol>
+
+
+<hr>
+
+<h2>
+Getting Started with LLVM
+</h2>
+
+<dl compact>
+    <dt>
+    For license information:
+    <dd>
+        <a href="../LICENSE.TXT">llvm/LICENSE.TXT</a>
+        <p>
+
+    <dt>
+    Installing and compiling LLVM:
+    <dd>
+        <a href="GettingStarted.html">llvm/docs/GettingStarted.html</a>
+        <p>
+
+    <dt>
+    Learn about features and limitations of this release:
+    <dd>
+        <a href="ReleaseNotes.html">llvm/docs/ReleaseNotes.html</a>
+        <p>
+
+    <dt>
+    Learn how to write a pass within the LLVM system:
+    <dd>
+        <a href="WritingAnLLVMPass.html">llvm/docs/WritingAnLLVMPass.html </a>
+        <p>
+
+    <dt>
+    Learn how to start a new development project using LLVM, where your
+    new source code can live anywhere (outside or inside the LLVM tree),
+    while using LLVM header files and libraries:
+    <dd>
+        <a href="Projects.html">llvm/docs/Projects.html</a>
+</dl>
+
+<hr>
+
+<h2>
+Getting Help with LLVM
+</h2>
+
+<ol>
+        <li>
+        If you have questions or development problems not answered in the
+        documentation, send e-mail to llvmdev at cs.uiuc.edu.  This mailing list is
+        monitored by all the people in the LLVM group at Illinois, and you
+        should expect prompt first responses.
+        </li>
+
+        <li>
+        To report a bug, submit a bug report as described in the document:
+        <a href="http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.html">
+        http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.html</a>
+        </li>
+
+        <li>
+        We now use Bugzilla to track bugs, so you can check the status of
+        previous bugs at:
+        <a href="http://llvm.cs.uiuc.edu/bugs/query.cgi">
+        http://llvm.cs.uiuc.edu/bugs/query.cgi </a>
+        </li>
+</ol>
+
+<hr>
+
+<h2>
+LLVM Documentation
+</h2>
+
+All the documents mentioned below except the design overview tech report
+are included as part of the LLVM release (in llvm/docs/*):
+
+<h3>
+LLVM Design Overview:
+</h3>
+
+<dl compact>
+    <dt>
+    LLVM : A Compilation Framework for Lifelong Program Analysis
+    and Transformation:
+    <dd>
+        <a href="http://llvm.cs.uiuc.edu/pubs/2003-09-30-LifelongOptimizationTR.html">
+        http://llvm.cs.uiuc.edu/pubs/2003-09-30-LifelongOptimizationTR.html </a>
+
+</dl>
+
+<h3>
+LLVM User Guides:
+</h3>
+
+<dl compact>
+    <dt>
+    Download and Installation Instructions:
+    <dd>
+        <a href="GettingStarted.html"> llvm/docs/GettingStarted.html</a>
+        <p>
+
+    <dt>
+    LLVM Command Guide:
+    <dd>
+        <a href="CommandGuide/index.html">
+        llvm/docs/CommandGuide/index.html</a>
+        <p>
+
+    <dt>
+    LLVM Assembly Language:
+    <dd>
+        <a href="LangRef.html"> llvm/docs/LangRef.html</a>
+        <p>
+
+    <dt>
+    LLVM Test Suite Guide:
+    <dd>
+        <a href="TestingGuide.html"> llvm/docs/TestingGuide.html</a>
+        <p>
+</dl>
+
+<h3>
+LLVM Programming Documentation:
+</h3>
+
+<dl compact>
+    <dt>
+    LLVM Programmers Manual:
+    <dd>
+        <a href="ProgrammersManual.html"> llvm/docs/ProgrammersManual.html</a>
+        <p>
+
+    <dt>
+    Writing an LLVM Pass:
+    <dd>
+        <a href="WritingAnLLVMPass.html"> llvm/docs/WritingAnLLVMPass.html</a>
+        <p>
+
+    <dt>
+    Alias Analysis in LLVM:
+    <dd>
+        <a href="AliasAnalysis.html"> llvm/docs/AliasAnalysis.html</a>
+        <p>
+
+    <dt>
+    Command Line Library:
+    <dd>
+        <a href="CommandLine.html"> llvm/docs/CommandLine.html</a>
+        <p>
+
+    <dt>
+    Coding Standards:
+    <dd>
+        <a href="CodingStandards.html"> llvm/docs/CodingStandards.html</a>
+        <p>
+</dl>
+
+<h3>
+Other LLVM Resources:
+</h3>
+
+<dl compact>
+    <dt>
+    Submitting a Bug:
+    <dd>
+        <a href="http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.html">
+        http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.html</a>
+        <p>
+
+    <dt>
+    Open Projects:
+    <dd>
+        <a href="OpenProjects.html"> llvm/docs/OpenProjects.html</a>
+        <p>
+
+    <dt>
+    Creating a new LLVM Project:
+    <dd>
+        <a href="Projects.html"> llvm/docs/Projects.html</a>
+        <p>
+</dl>
+
+<hr>
+
+<h2>
+Mailing Lists
+</h2>
+There are three mailing lists for providing LLVM users with information:
+
+<ol>
+    <li> LLVM Announcements List:<br>
+    <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce">
+    http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce</a>
+
+    <p>
+    This is a low volume list that provides important announcements regarding
+    LLVM.  It is primarily intended to announce new releases, major updates to
+    the software, etc.  This list is highly recommended for anyone that uses
+    LLVM.
+    </p>
+
+    <li> LLVM Developers List:<br>
+    <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">
+    http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev</a>
+
+    <p>
+    This list is for people who want to be included in technical discussions
+    of LLVM.  People post to this list when they have questions about writing
+    code for or using the LLVM tools.  It is relatively low volume.
+    </p>
+
+    <li> LLVM Commits List<br>
+    <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvm-commits">
+    http://mail.cs.uiuc.edu/mailman/listinfo/llvm-commits</a>
+
+    <p>
+    This list contains all commit messages that are made when LLVM developers
+    commit code changes to the CVS archive.  It is useful for those who want to
+    stay on the bleeding edge of LLVM development. This list is very high
+    volume.
+    </p>
+</ol>
+</body>
+</html>
+


Index: llvm/docs/AliasAnalysis.html
diff -u llvm/docs/AliasAnalysis.html:1.8 llvm/docs/AliasAnalysis.html:1.9
--- llvm/docs/AliasAnalysis.html:1.8	Fri Oct 24 13:06:11 2003
+++ llvm/docs/AliasAnalysis.html	Mon Oct 27 12:18:16 2003
@@ -485,7 +485,9 @@
 <hr>
 <div class="doc_footer">
   <address><a href="mailto:sabre at nondot.org">Chris Lattner</a></address>
-  Last modified: $Date: 2003/10/24 18:06:11 $
+  <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a>
+  <br>
+  Last modified: $Date: 2003/10/27 18:18:16 $
 </div>
 
 </body>


Index: llvm/docs/CFEBuildInstrs.html
diff -u llvm/docs/CFEBuildInstrs.html:1.4 llvm/docs/CFEBuildInstrs.html:1.5
--- llvm/docs/CFEBuildInstrs.html:1.4	Fri Oct 24 11:02:34 2003
+++ llvm/docs/CFEBuildInstrs.html	Mon Oct 27 12:18:16 2003
@@ -15,9 +15,12 @@
 C/C++ front-end, based on GCC 3.4, from source.</p>
 
 <p><b>NOTE:</b> This is currently a somewhat fragile, error-prone
-process, and you should only try to do it if (A) you really, really,
-really can't use the binaries we distribute, and (B) you are a wicked
-good GCC hacker.</p>
+process, and you should only try to do it if
+<ul>
+  <li>(A) you really, really, really can't use the binaries we distribute
+  <li>(B) you need GCC to fix some of the header files on your system
+  <li>(C) you are an elite GCC hacker.</p>
+</ul>
 
 <p>We welcome patches to help make this process simpler.</p>
 
@@ -154,7 +157,9 @@
 
 <hr><font size="-1">
 <address><a href="mailto:gaeke -at- uiuc.edu">Brian Gaeke</a></address>
-Last modified: $Date: 2003/10/24 16:02:34 $
+<a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a>
+<br>
+Last modified: $Date: 2003/10/27 18:18:16 $
 </font>
 
 </body>


Index: llvm/docs/CodingStandards.html
diff -u llvm/docs/CodingStandards.html:1.13 llvm/docs/CodingStandards.html:1.14
--- llvm/docs/CodingStandards.html:1.13	Fri Oct 24 12:57:33 2003
+++ llvm/docs/CodingStandards.html	Mon Oct 27 12:18:16 2003
@@ -950,7 +950,9 @@
 
 <div class="doc_footer">
   <address><a href="mailto:sabre at nondot.org">Chris Lattner</a></address>
-  Last modified: $Date: 2003/10/24 17:57:33 $
+  <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a>
+  <br>
+  Last modified: $Date: 2003/10/27 18:18:16 $
 </div>
 
 </body>


Index: llvm/docs/CommandLine.html
diff -u llvm/docs/CommandLine.html:1.16 llvm/docs/CommandLine.html:1.17
--- llvm/docs/CommandLine.html:1.16	Fri Oct 24 14:59:21 2003
+++ llvm/docs/CommandLine.html	Mon Oct 27 12:18:16 2003
@@ -1690,7 +1690,9 @@
 <hr>
 <div class="doc_footer">
 <address><a href="mailto:sabre at nondot.org">Chris Lattner</a></address>
-Last modified: $Date: 2003/10/24 19:59:21 $
+<a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a>
+<br>
+Last modified: $Date: 2003/10/27 18:18:16 $
 </div>
 
 </body>


Index: llvm/docs/DSGraphStatus.html
diff -u llvm/docs/DSGraphStatus.html:1.15 llvm/docs/DSGraphStatus.html:1.16
--- llvm/docs/DSGraphStatus.html:1.15	Tue May 20 16:01:22 2003
+++ llvm/docs/DSGraphStatus.html	Mon Oct 27 12:18:16 2003
@@ -875,6 +875,8 @@
 
     <hr>
     <address><a href="mailto:sabre at nondot.org">Chris Lattner</a></address>
+    <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a>
+    <br>
 <!-- Created: Wed Nov  6 19:57:57 CST 2002 -->
 <!-- hhmts start -->
 Last modified: Thu Nov 14 20:00:50 CST 2002


Index: llvm/docs/GettingStarted.html
diff -u llvm/docs/GettingStarted.html:1.42 llvm/docs/GettingStarted.html:1.43
--- llvm/docs/GettingStarted.html:1.42	Thu Oct 23 14:49:01 2003
+++ llvm/docs/GettingStarted.html	Mon Oct 27 12:18:16 2003
@@ -90,6 +90,11 @@
             <li><tt>cd <i>where-you-want-the-C-front-end-to-live</i></tt>
             <li><tt>gunzip --stdout cfrontend.<i>platform</i>.tar.gz | tar -xvf
             -</tt>
+            <li><b>Sparc Only:</b><br>
+            <tt>
+            cd cfrontend/sparc<br>
+            ./fixheaders
+            </tt>
         </ol>
 
         <p>
@@ -204,8 +209,7 @@
     native code may not work on your platform.
     <p>
     The GCC front end is not very portable at the moment.  If you want to get
-    it to work on another platform, you can always request
-    <a href="mailto:llvm-request at zion.cs.uiuc.edu">a copy of the source</a>
+    it to work on another platform, you can download a copy of the source
     and try to compile it on your platform.
     </p>
 
@@ -377,7 +381,8 @@
 
     <p>
     Before configuring and compiling the LLVM suite, you need to extract the
-    LLVM GCC front end from the binary distribution.  It is used for building the
+    LLVM GCC front end from the binary distribution.  It is used for building
+    the
     bytecode libraries later used by the GCC front end for linking programs, and
     its location must be specified when the LLVM suite is configured.
     </p>
@@ -390,6 +395,29 @@
         -</tt>
     </ol>
 
+    If you are on a Sparc/Solaris machine, you will need to fix the header
+    files:
+
+    <p>
+
+    <tt>
+    cd cfrontend/sparc
+    <br>
+    ./fixheaders
+    </tt>
+
+    <p>
+    The binary versions of the GCC front end may not suit all of your needs.
+    For example, the binary distribution may include an old version of a system
+    header file, not "fix" a header file that needs to be fixed for GCC, or it
+    may be linked with libraries not available on your system.
+    </p>
+
+    <p>
+    In cases like these, you may want to try
+    <a href="CFEBuildInstrs.html">building the GCC front end from source.</a>
+    This is not for the faint of heart, so be forewarned.
+    </p>
     <!------------------------------------------------------------------------->
     <h3><a name="config">Local LLVM Configuration</a></h3>
     <!------------------------------------------------------------------------->
@@ -1010,10 +1038,12 @@
     If you have any questions or run into any snags (or you have any
     additions...), please send an email to
     <a href="mailto:sabre at nondot.org">Chris Lattner</a>.</p>
+    <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a>
+    <br>
 
-	    <!-- Created: Mon Jul  1 02:29:02 CDT 2002 -->
-	    <!-- hhmts start -->
-Last modified: Mon Aug 11 13:52:22 CDT 2003
-<!-- hhmts end -->
+	<!-- Created: Mon Jul  1 02:29:02 CDT 2002 -->
+	<!-- hhmts start -->
+    Last modified: Mon Oct 27 12:00:00 CDT 2003
+    <!-- hhmts end -->
   </body>
 </html>


Index: llvm/docs/HowToSubmitABug.html
diff -u llvm/docs/HowToSubmitABug.html:1.8 llvm/docs/HowToSubmitABug.html:1.9
--- llvm/docs/HowToSubmitABug.html:1.8	Wed Oct 22 12:01:44 2003
+++ llvm/docs/HowToSubmitABug.html	Mon Oct 27 12:18:16 2003
@@ -273,8 +273,10 @@
 
 <hr><font size-1>
 <address><a href="mailto:sabre at nondot.org">Chris Lattner</a></address>
+<a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a>
+<br>
 <!-- Created: Tue Aug  6 15:00:33 CDT 2002 -->
 <!-- hhmts start -->
-Last modified: Tue Oct 14 15:57:47 CDT 2003
+Last modified: Mon Oct 27 12:00:00 CDT 2003
 <!-- hhmts end -->
 </font></body></html>


Index: llvm/docs/LangRef.html
diff -u llvm/docs/LangRef.html:1.34 llvm/docs/LangRef.html:1.35
--- llvm/docs/LangRef.html:1.34	Tue Oct 21 10:43:55 2003
+++ llvm/docs/LangRef.html	Mon Oct 27 12:18:16 2003
@@ -1947,9 +1947,11 @@
 <hr>
 <font size=-1>
 <address><a href="mailto:sabre at nondot.org">Chris Lattner</a></address>
+<a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a>
+<br>
 <!-- Created: Tue Jan 23 15:19:28 CST 2001 -->
 <!-- hhmts start -->
-Last modified: Tue Oct 21 10:43:36 CDT 2003
+Last modified: Mon Oct 27 12:00:00 CDT 2003
 <!-- hhmts end -->
 </font>
 </body></html>


Index: llvm/docs/OpenProjects.html
diff -u llvm/docs/OpenProjects.html:1.12 llvm/docs/OpenProjects.html:1.13
--- llvm/docs/OpenProjects.html:1.12	Sat Oct 25 13:41:16 2003
+++ llvm/docs/OpenProjects.html	Mon Oct 27 12:18:16 2003
@@ -277,8 +277,10 @@
 
 <hr><font size-1>
 <address><a href="mailto:sabre at nondot.org">Chris Lattner</a></address>
+<a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a>
+<br>
 <!-- Created: Tue Aug  6 15:00:33 CDT 2002 -->
 <!-- hhmts start -->
-Last modified: Wed Oct  1 16:48:54 CDT 2003
+Last modified: Mon Oct 27 12:00:00 CDT 2003
 <!-- hhmts end -->
 </font></body></html>


Index: llvm/docs/ProgrammersManual.html
diff -u llvm/docs/ProgrammersManual.html:1.47 llvm/docs/ProgrammersManual.html:1.48
--- llvm/docs/ProgrammersManual.html:1.47	Sat Sep 20 09:43:16 2003
+++ llvm/docs/ProgrammersManual.html	Mon Oct 27 12:18:16 2003
@@ -1787,8 +1787,10 @@
 <hr><font size-1>
 <address>By: <a href="mailto:dhurjati at cs.uiuc.edu">Dinakar Dhurjati</a> and
 <a href="mailto:sabre at nondot.org">Chris Lattner</a></address>
+<a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a>
+<br>
 <!-- Created: Tue Aug  6 15:00:33 CDT 2002 -->
 <!-- hhmts start -->
-Last modified: Sat Sep 20 09:25:11 CDT 2003
+Last modified: Mon Oct 27 12:00:00 CDT 2003
 <!-- hhmts end -->
 </font></body></html>


Index: llvm/docs/Projects.html
diff -u llvm/docs/Projects.html:1.7 llvm/docs/Projects.html:1.8
--- llvm/docs/Projects.html:1.7	Tue Oct 21 14:35:06 2003
+++ llvm/docs/Projects.html	Mon Oct 27 12:18:16 2003
@@ -383,5 +383,8 @@
 	
 <hr>
 Written by <a href="mailto:criswell at uiuc.edu">John Criswell</a>.
+<br>
+<a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a>
+<br>
 </body>
 </html>


Index: llvm/docs/TestingGuide.html
diff -u llvm/docs/TestingGuide.html:1.4 llvm/docs/TestingGuide.html:1.5
--- llvm/docs/TestingGuide.html:1.4	Sun Oct 26 07:41:18 2003
+++ llvm/docs/TestingGuide.html	Mon Oct 27 12:18:16 2003
@@ -420,7 +420,9 @@
 
 <hr><font size="-1">
 <address>John T. Criswell</address>
-Last modified: $Date: 2003/10/26 13:41:18 $
+<a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a>
+<br>
+Last modified: $Date: 2003/10/27 18:18:16 $
 </font>
 
 </body>


Index: llvm/docs/WritingAnLLVMPass.html
diff -u llvm/docs/WritingAnLLVMPass.html:1.20 llvm/docs/WritingAnLLVMPass.html:1.21
--- llvm/docs/WritingAnLLVMPass.html:1.20	Thu Oct 23 14:48:11 2003
+++ llvm/docs/WritingAnLLVMPass.html	Mon Oct 27 12:18:16 2003
@@ -1273,8 +1273,10 @@
 
 <hr><font size-1>
 <address><a href="mailto:sabre at nondot.org">Chris Lattner</a></address>
+<a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a>
+<br>
 <!-- Created: Tue Aug  6 15:00:33 CDT 2002 -->
 <!-- hhmts start -->
-Last modified: Tue Jul 22 15:52:30 CDT 2003
+Last modified: Mon Oct 27 12:00:00 CDT 2003
 <!-- hhmts end -->
 </font></body></html>





More information about the llvm-commits mailing list