* Describe the LOADABLE_MODULE feature

* Get rid of non-compliant <font> elements (how did that get in there?)


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@19458 91177308-0d34-0410-b5e6-96231b3b80d8
This commit is contained in:
Reid Spencer 2005-01-11 05:12:54 +00:00
parent a95589be3f
commit 7c7e9aa590

View File

@ -240,6 +240,16 @@
Note that you normally do not need to specify the sources involved. The LLVM Note that you normally do not need to specify the sources involved. The LLVM
Makefile system will infer the source files from the contents of the source Makefile system will infer the source files from the contents of the source
directory.</p> directory.</p>
<p>The <tt>LOADABLE_MODULE=1</tt> directive can be used in conjunction with
<tt>SHARED_LIBRARY=1</tt> to indicate that the resulting shared library should
be openable with the <tt>dlopen</tt> function and searchable with the
<tt>dlsym</tt> function (or your operating system's equivalents). While this
isn't strictly necessary on Linux and a few other platforms, it is required
on systems like HP-UX and Darwin. You should use <tt>LOADABLE_MODULE</tt> for
any shared library that you intend to be loaded into an tool via the
<tt>-load</tt> option. See the
<a href="WritingAnLLVMPass.html#makefile">WritingAnLLVMPass.html</a> document
for an example of why you might want to do this.
</div> </div>
<!-- ======================================================================= --> <!-- ======================================================================= -->
@ -539,8 +549,8 @@
<tt>$(BUILD_OBJ_ROOT)</tt> directoy by removing its content entirely and <tt>$(BUILD_OBJ_ROOT)</tt> directoy by removing its content entirely and
reconfiguring the directory. This returns the <tt>$(BUILD_OBJ_ROOT)</tt> reconfiguring the directory. This returns the <tt>$(BUILD_OBJ_ROOT)</tt>
directory to a completely fresh state. All content in the directory except directory to a completely fresh state. All content in the directory except
configured files and top-level makefiles will be lost. configured files and top-level makefiles will be lost.</p>
<font color="red">Use with caution.</font></p> <div class="doc_warning"><p>Use with caution.</p></div>
</div> </div>
<!-- ======================================================================= --> <!-- ======================================================================= -->
@ -652,6 +662,12 @@
<dt><a name="LLVMLIBS"><tt>LLVMLIBS</tt></a></dt> <dt><a name="LLVMLIBS"><tt>LLVMLIBS</tt></a></dt>
<dd>Specifies the set of libraries from the LLVM $(ObjDir) that will be <dd>Specifies the set of libraries from the LLVM $(ObjDir) that will be
linked into the tool or library.</dd> linked into the tool or library.</dd>
<dt><a name="LOADABLE_MODULE"><tt>LOADABLE_MODULE</tt></a></dt>
<dd>If set to any value, causes the shared library being built to also be
a loadable module. Loadable modules can be opened with the dlopen() function
and searched with dlsym (or the operating system's equivalent). Note that
setting this variable without also setting <tt>SHARED_LIBRARY</tt> will have
no effect.</dd>
<dt><a name="MODULE_NAME"><tt>MODULE_NAME</tt></a></dt> <dt><a name="MODULE_NAME"><tt>MODULE_NAME</tt></a></dt>
<dd>Specifies the name of a bytecode module to be created. A bytecode <dd>Specifies the name of a bytecode module to be created. A bytecode
module can be specified in conjunction with other kinds of library builds module can be specified in conjunction with other kinds of library builds