diff options
author | Bill Wendling <isanbard@gmail.com> | 2012-03-14 08:07:43 +0000 |
---|---|---|
committer | Bill Wendling <isanbard@gmail.com> | 2012-03-14 08:07:43 +0000 |
commit | 4cc2be672f5ac66c53389bcf5e7dc8ad45c5fd88 (patch) | |
tree | a8f12a717b277f9b6310c440e54f5237903fbe76 /docs | |
parent | 3d1d895c866b76ac4d862301f36e2b95d803f0ab (diff) |
Update the "hello world" example to resemble what we currently output.
Also do some minor reformatting.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@152707 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs')
-rw-r--r-- | docs/LangRef.html | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/docs/LangRef.html b/docs/LangRef.html index 008ae6a67f..6ff0f5e7be 100644 --- a/docs/LangRef.html +++ b/docs/LangRef.html @@ -490,43 +490,43 @@ <div> -<p>LLVM programs are composed of "Module"s, each of which is a translation unit - of the input programs. Each module consists of functions, global variables, - and symbol table entries. Modules may be combined together with the LLVM - linker, which merges function (and global variable) definitions, resolves - forward declarations, and merges symbol table entries. Here is an example of - the "hello world" module:</p> +<p>LLVM programs are composed of <tt>Module</tt>s, each of which is a + translation unit of the input programs. Each module consists of functions, + global variables, and symbol table entries. Modules may be combined together + with the LLVM linker, which merges function (and global variable) + definitions, resolves forward declarations, and merges symbol table + entries. Here is an example of the "hello world" module:</p> <pre class="doc_code"> <i>; Declare the string constant as a global constant.</i> -<a href="#identifiers">@.LC0</a> = <a href="#linkage_internal">internal</a> <a href="#globalvars">constant</a> <a href="#t_array">[13 x i8]</a> c"hello world\0A\00" <i>; [13 x i8]*</i> +<a href="#identifiers">@.str</a> = <a href="#linkage_private">private</a> <a href="#globalvars">unnamed_addr</a> <a href="#globalvars">constant</a> <a href="#t_array">[13 x i8]</a> c"hello world\0A\00" <i>; External declaration of the puts function</i> -<a href="#functionstructure">declare</a> i32 @puts(i8*) <i>; i32 (i8*)* </i> +<a href="#functionstructure">declare</a> i32 @puts(i8* <a href="#nocapture">nocapture</a>) <a href="#fnattrs">nounwind</a> <i>; Definition of main function</i> define i32 @main() { <i>; i32()* </i> <i>; Convert [13 x i8]* to i8 *...</i> - %cast210 = <a href="#i_getelementptr">getelementptr</a> [13 x i8]* @.LC0, i64 0, i64 0 <i>; i8*</i> + %cast210 = <a href="#i_getelementptr">getelementptr</a> [13 x i8]* @.str, i64 0, i64 0 <i>; Call puts function to write out the string to stdout.</i> - <a href="#i_call">call</a> i32 @puts(i8* %cast210) <i>; i32</i> + <a href="#i_call">call</a> i32 @puts(i8* %cast210) <a href="#i_ret">ret</a> i32 0 } <i>; Named metadata</i> -!1 = metadata !{i32 41} +!1 = metadata !{i32 42} !foo = !{!1, null} </pre> <p>This example is made up of a <a href="#globalvars">global variable</a> named - "<tt>.LC0</tt>", an external declaration of the "<tt>puts</tt>" function, + "<tt>.str</tt>", an external declaration of the "<tt>puts</tt>" function, a <a href="#functionstructure">function definition</a> for "<tt>main</tt>" and <a href="#namedmetadatastructure">named metadata</a> - "<tt>foo"</tt>.</p> + "<tt>foo</tt>".</p> -<p>In general, a module is made up of a list of global values, where both - functions and global variables are global values. Global values are +<p>In general, a module is made up of a list of global values (where both + functions and global variables are global values). Global values are represented by a pointer to a memory location (in this case, a pointer to an array of char, and a pointer to a function), and have one of the following <a href="#linkage">linkage types</a>.</p> |