[llvm-commits] CVS: llvm-www/www-index.html

John Criswell criswell at cs.uiuc.edu
Fri Oct 17 15:44:01 PDT 2003


Changes in directory llvm-www:

www-index.html updated: 1.59 -> 1.60

---
Log message:

Subcatagorized the documentation.
Fixed some spelling mistakes.
Reformatted some of the documentation lists to (hopefully) make the HTML
source a little more readable.



---
Diffs of the changes:  (+73 -23)

Index: llvm-www/www-index.html
diff -u llvm-www/www-index.html:1.59 llvm-www/www-index.html:1.60
--- llvm-www/www-index.html:1.59	Wed Oct  8 00:44:16 2003
+++ llvm-www/www-index.html	Fri Oct 17 15:43:07 2003
@@ -267,32 +267,61 @@
             <tr>
                 <td>
                 Here are some technical and reference documents for the LLVM
-                system: <ul>
-                    <li><a
-                        href="pubs/2002-08-09-LLVMCompilationStrategy.html">The
-                        LLVM Instruction Set and Compilation
-                        Strategy</a> - Describes the high level
-                        picture of the LLVM instruction set and
-                        compilation system. This should be the
-                        first document you read to get an
-                        overview of LLVM. </li>
-                    <li><a href="docs/GettingStarted.html">The
-                        LLVM Getting Started Guide</a> -
-                        Discusses how to get up and running
+                system:
+                <p>
+
+                <h4>
+                LLVM Design
+                </h4>
+
+                <ul>
+                    <li>
+                    <a href="pubs/2002-08-09-LLVMCompilationStrategy.html">
+                    The LLVM Instruction Set and Compilation Strategy
+                    </a>
+                    - Describes the high level picture of the LLVM instruction
+                    set and compilation system. This should be the first
+                    document you read to get an overview of LLVM. </li>
+                </ul>
+
+                <h4>
+                LLVM User Guides
+                </h4>
+
+                <ul>
+                    <li>
+                    <a href="docs/GettingStarted.html">
+                    The LLVM Getting Started Guide
+                    </a>
+                    - Discusses how to get up and running
                         quickly with the LLVM infrastructure.
-                        Everything from unpacking &
+                        Everything from unpacking and
                         compilation of the distribution to
                         execution of some tools. </li>
-                    <li><a href="docs/CommandGuide/">LLVM Command
-                    Guide</a> - A reference manual for the LLVM command line
+
+                    <li>
+                    <a href="docs/CommandGuide/">
+                    LLVM Command Guide
+                    </a>
+                    - A reference manual for the LLVM command line
                     utilities.  </li>
-                    <li><a href="docs/LangRef.html">LLVM
-                        Reference Manual</a> - Defines the LLVM
+
+                    <li>
+                    <a href="docs/LangRef.html">
+                    LLVM Reference Manual
+                    </a>
+                    - Defines the LLVM
                         intermediate representation, the assembly
                         form of the different nodes, and provides
                         reference information about the different
                         tools in LLVM. </li>
+                </ul>
+
+                <h4>
+                Programming Documentation
+                </h4>
 
+                <ul>
                     <li><a href="docs/ProgrammersManual.html">The LLVM
                         Programmers Manual</a> - Introduction to the general
                         layout of the LLVM sourcebase, important classes and
@@ -307,6 +336,22 @@
                         analysis implementation or how to use existing
                         analyses.</li>
 
+                    <li><a href="docs/CommandLine.html">CommandLine
+                        library Reference Manual</a>
+                        - Provides information on using the command line
+                          parsing library.</li>
+
+                    <li><a href="docs/CodingStandards.html">Recommended
+                        LLVM Coding standards</a>
+                        - Details the LLVM coding standards and provides useful
+                          information on writing efficient C++ code.</li>
+                </ul>
+
+                <h4>
+                Contributing
+                </h4>
+
+                <ul>
                     <li><a href="docs/OpenProjects.html">Open Projects</a> in
                         the LLVM system.  Look here if you are interested in
                         doing something with LLVM, but aren't sure what needs
@@ -317,24 +362,29 @@
                        instructions for the proper way to submit information
                        about a bug you ran into in the LLVM system.</li>
                 </ul>
-                <p>Other useful information:</p>
+
+                <p>
+
+                <h4>
+                Other Useful Information
+                </h4>
+                </p>
+
                 <ul>
                     <li>LLVM Mailing Lists:
                     <ol>
-                    <li>The <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce">LLVM Anouncements List</a></li>
+                    <li>The
+                    <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce">
+                    LLVM Announcements List</a></li>
                     <li>The <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">Developer's List</a> (LLVM user & developer support)</li>
                     <li>The <a href="http://mail.cs.uiuc.edu/pipermail/llvmbugs/">Bugs & Patches Archive</a></li>
                     <li>The <a href="http://mail.cs.uiuc.edu/pipermail/llvm-commits/">CVS Commits Archive</a></li>
 
                     </ol>
-                    <li><a href="docs/CodingStandards.html">Recommended
-                        LLVM Coding standards</a> </li>
                     <li><a href="doxygen/">doxygen generated
                         documentation</a> (<a
                         href="doxygen/inherits.html">classes</a>)
                     </li>
-                    <li><a href="docs/CommandLine.html">CommandLine
-                        library</a> reference manual </li>
                     <li>Results from the <a href="testresults/">LLVM Automated Nightly Tester</a>
                 </ul><p>
                 </td>





More information about the llvm-commits mailing list