diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/AliasAnalysis.html | 2 | ||||
-rw-r--r-- | docs/CodingStandards.html | 4 | ||||
-rw-r--r-- | docs/HistoricalNotes/2001-02-09-AdveCommentsResponse.txt | 2 | ||||
-rw-r--r-- | docs/HistoricalNotes/2001-05-18-ExceptionHandling.txt | 2 | ||||
-rw-r--r-- | docs/HistoricalNotes/2002-06-25-MegaPatchInfo.txt | 2 | ||||
-rw-r--r-- | docs/OpenProjects.html | 2 | ||||
-rw-r--r-- | docs/ProgrammersManual.html | 8 | ||||
-rw-r--r-- | docs/WritingAnLLVMPass.html | 4 |
8 files changed, 13 insertions, 13 deletions
diff --git a/docs/AliasAnalysis.html b/docs/AliasAnalysis.html index d29ec92..51a80ef 100644 --- a/docs/AliasAnalysis.html +++ b/docs/AliasAnalysis.html @@ -68,7 +68,7 @@ this class exposes Mod/Ref information from those implementations which can provide it, allowing for powerful analyses and transformations to work well together.<p> -This document contains information neccesary to successfully implement this +This document contains information necessary to successfully implement this interface, use it, and to test both sides. It also explains some of the finer points about what exactly results mean. If you feel that something is unclear or should be added, please <a href="mailto:sabre@nondot.org">let me know</a>.<p> diff --git a/docs/CodingStandards.html b/docs/CodingStandards.html index 1f6efd6..700fe1b 100644 --- a/docs/CodingStandards.html +++ b/docs/CodingStandards.html @@ -93,7 +93,7 @@ Every source file should have a header on it that describes the basic purpose of //===----------------------------------------------------------------------===// </pre> -A few things to note about this particular format. The "<tt>-*- C++ -*-</tt>" string on the first line is there to tell Emacs that the source file is a C++ file, not a C file (Emacs assumes .h files are C files by default [Note that tag this is not neccesary in .cpp files]). The name of the file is also on the first line, along with a very short description of the purpose of the file. This is important when printing out code and flipping though lots of pages.<p> +A few things to note about this particular format. The "<tt>-*- C++ -*-</tt>" string on the first line is there to tell Emacs that the source file is a C++ file, not a C file (Emacs assumes .h files are C files by default [Note that tag this is not necessary in .cpp files]). The name of the file is also on the first line, along with a very short description of the purpose of the file. This is important when printing out code and flipping though lots of pages.<p> The main body of the description does not have to be very long in most cases. Here it's only two lines. If an algorithm is being implemented or something tricky is going on, a reference to the paper where it is published should be included, as well as any notes or "gotchas" in the code to watch out for.<p> @@ -105,7 +105,7 @@ Classes are one fundemental part of a good object oriented design. As such, a c <h4><li>Method information</h4> -Methods defined in a class (as well as any global functions) should also be documented properly. A quick note about what it does any a description of the borderline behaviour is all that is neccesary here (unless something particularly tricky or insideous is going on). The hope is that people can figure out how to use your interfaces without reading the code itself... that is the goal metric.<p> +Methods defined in a class (as well as any global functions) should also be documented properly. A quick note about what it does any a description of the borderline behaviour is all that is necessary here (unless something particularly tricky or insideous is going on). The hope is that people can figure out how to use your interfaces without reading the code itself... that is the goal metric.<p> Good things to talk about here are what happens when something unexpected happens: does the method return null? Abort? Format your hard disk?<p> </ol> diff --git a/docs/HistoricalNotes/2001-02-09-AdveCommentsResponse.txt b/docs/HistoricalNotes/2001-02-09-AdveCommentsResponse.txt index 4d28795..5c87330 100644 --- a/docs/HistoricalNotes/2001-02-09-AdveCommentsResponse.txt +++ b/docs/HistoricalNotes/2001-02-09-AdveCommentsResponse.txt @@ -150,7 +150,7 @@ needed... Conditional move is effectly a special case of a predicated instruction... and I think that all predicated instructions can possibly be implemented later in LLVM. It would significantly change things, and -it doesn't seem to be very neccesary right now. It would seem to +it doesn't seem to be very necessary right now. It would seem to complicate flow control analysis a LOT in the virtual machine. I would tend to prefer that a predicated architecture like IA64 convert from a "basic block" representation to a predicated rep as part of it's dynamic diff --git a/docs/HistoricalNotes/2001-05-18-ExceptionHandling.txt b/docs/HistoricalNotes/2001-05-18-ExceptionHandling.txt index 2e0b794..b546301 100644 --- a/docs/HistoricalNotes/2001-05-18-ExceptionHandling.txt +++ b/docs/HistoricalNotes/2001-05-18-ExceptionHandling.txt @@ -144,7 +144,7 @@ least*: 2. A pointer to the dtor for the contained object 3. The contained object itself -Note that it is neccesary to maintain #1 & #2 in the exception object itself +Note that it is necessary to maintain #1 & #2 in the exception object itself because objects without virtual function tables may be thrown (as in this example). Assuming this, TryHandler would look something like this: diff --git a/docs/HistoricalNotes/2002-06-25-MegaPatchInfo.txt b/docs/HistoricalNotes/2002-06-25-MegaPatchInfo.txt index 9709ce5..2ca4611 100644 --- a/docs/HistoricalNotes/2002-06-25-MegaPatchInfo.txt +++ b/docs/HistoricalNotes/2002-06-25-MegaPatchInfo.txt @@ -43,7 +43,7 @@ Changes: which is much more natural and what users expect. -* Simplification of #include's: Before, it was neccesary for a .cpp file to +* Simplification of #include's: Before, it was necessary for a .cpp file to include every .h file that it used. Now things are batched a little bit more to make it easier to use. Specifically, the include graph now includes these edges: diff --git a/docs/OpenProjects.html b/docs/OpenProjects.html index 740c9db..574f4d3 100644 --- a/docs/OpenProjects.html +++ b/docs/OpenProjects.html @@ -92,7 +92,7 @@ could use the following improvements:<p> <li>Graphs - It would be great to have gnuplot graphs to keep track of how the tree is changing over time. We already gather a several statistics, it - just neccesary to add the script-fu to gnuplotize it. + just necessary to add the script-fu to gnuplotize it. <li>Regression tests - We should run the regression tests in addition to the program tests... diff --git a/docs/ProgrammersManual.html b/docs/ProgrammersManual.html index 6c26598..be40ba3 100644 --- a/docs/ProgrammersManual.html +++ b/docs/ProgrammersManual.html @@ -1452,7 +1452,7 @@ list.<p> <li><tt>Function::BasicBlockListType &getBasicBlockList()</tt><p> Returns the list of <a href="#BasicBlock"><tt>BasicBlock</tt></a>s. This is -neccesary to use when you need to update the list or perform a complex action +necessary to use when you need to update the list or perform a complex action that doesn't have a forwarding method.<p> @@ -1467,7 +1467,7 @@ These are forwarding methods that make it easy to access the contents of a <li><tt>Function::ArgumentListType &getArgumentList()</tt><p> Returns the list of <a href="#Argument"><tt>Argument</tt></a>s. This is -neccesary to use when you need to update the list or perform a complex action +necessary to use when you need to update the list or perform a complex action that doesn't have a forwarding method.<p> @@ -1583,7 +1583,7 @@ list.<p> <li><tt>Module::FunctionListType &getFunctionList()</tt><p> Returns the list of <a href="#Function"><tt>Function</tt></a>s. This is -neccesary to use when you need to update the list or perform a complex action +necessary to use when you need to update the list or perform a complex action that doesn't have a forwarding method.<p> <!-- Global Variable --> @@ -1601,7 +1601,7 @@ list.<p> <li><tt>Module::GlobalListType &getGlobalList()</tt><p> Returns the list of <a href="#GlobalVariable"><tt>GlobalVariable</tt></a>s. -This is neccesary to use when you need to update the list or perform a complex +This is necessary to use when you need to update the list or perform a complex action that doesn't have a forwarding method.<p> diff --git a/docs/WritingAnLLVMPass.html b/docs/WritingAnLLVMPass.html index a39369f..e176435 100644 --- a/docs/WritingAnLLVMPass.html +++ b/docs/WritingAnLLVMPass.html @@ -367,7 +367,7 @@ available, from the most general to the most specific.<p> When choosing a superclass for your Pass, you should choose the <b>most specific</b> class possible, while still being able to meet the requirements -listed. This gives the LLVM Pass Infrastructure information neccesary to +listed. This gives the LLVM Pass Infrastructure information necessary to optimize how passes are run, so that the resultant compiler isn't unneccesarily slow.<p> @@ -476,7 +476,7 @@ href="http://llvm.cs.uiuc.edu/doxygen/LowerAllocations_8cpp-source.html">LowerAl pass. This pass converts <tt>malloc</tt> and <tt>free</tt> instructions into platform dependant <tt>malloc()</tt> and <tt>free()</tt> function calls. It uses the <tt>doInitialization</tt> method to get a reference to the malloc and -free functions that it needs, adding prototypes to the module if neccesary.<p> +free functions that it needs, adding prototypes to the module if necessary.<p> <!-- _______________________________________________________________________ --> </ul><h4><a name="runOnFunction"><hr size=0>The <tt>runOnFunction</tt> method</h4><ul> |