Skip to content

Commit

Permalink
Documentation: convert WritingAnLLVMPass.html to reST.
Browse files Browse the repository at this point in the history
Patch by Anthony Mykhailenko with small fixes by me.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@169992 91177308-0d34-0410-b5e6-96231b3b80d8
  • Loading branch information
gribozavr committed Dec 12, 2012
1 parent 44581af commit b64f020
Show file tree
Hide file tree
Showing 8 changed files with 1,456 additions and 1,967 deletions.
2 changes: 2 additions & 0 deletions docs/CMake.rst
Original file line number Diff line number Diff line change
Expand Up @@ -355,6 +355,8 @@ an equivalent variant of snippet shown above:
target_link_libraries(mycompiler ${REQ_LLVM_LIBRARIES})
.. _cmake-out-of-source-pass:

Developing LLVM pass out of source
----------------------------------

Expand Down
6 changes: 3 additions & 3 deletions docs/GarbageCollection.rst
Original file line number Diff line number Diff line change
Expand Up @@ -758,10 +758,10 @@ If ``CustomReadBarriers`` or ``CustomWriteBarriers`` are specified, then
``performCustomLowering`` **must** eliminate the corresponding barriers.

``performCustomLowering`` must comply with the same restrictions as
`FunctionPass::runOnFunction <WritingAnLLVMPass.html#runOnFunction>`__
:ref:`FunctionPass::runOnFunction <writing-an-llvm-pass-runOnFunction>`
Likewise, ``initializeCustomLowering`` has the same semantics as
`Pass::doInitialization(Module&)
<WritingAnLLVMPass.html#doInitialization_mod>`__
:ref:`Pass::doInitialization(Module&)
<writing-an-llvm-pass-doInitialization-mod>`

The following can be used as a template:

Expand Down
6 changes: 3 additions & 3 deletions docs/MakefileGuide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -170,9 +170,9 @@ openable with the ``dlopen`` function and searchable with the ``dlsym`` 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 ``LOADABLE_MODULE`` for any shared library that you
intend to be loaded into an tool via the ``-load`` option. See the
`WritingAnLLVMPass.html <WritingAnLLVMPass.html#makefile>`_ document for an
example of why you might want to do this.
intend to be loaded into an tool via the ``-load`` option. `Pass documentation
<writing-an-llvm-pass-makefile>`_ has an example of why you might want to do
this.

Bitcode Modules
^^^^^^^^^^^^^^^
Expand Down
4 changes: 2 additions & 2 deletions docs/WritingAnLLVMBackend.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,8 @@ These essential documents must be read before reading this document:
file (``.td`` suffix) and generates C++ code that can be used for code
generation.

* `Writing an LLVM Pass <WritingAnLLVMPass.html>`_ --- The assembly printer is
a ``FunctionPass``, as are several SelectionDAG processing steps.
* :doc:`WritingAnLLVMPass` --- The assembly printer is a ``FunctionPass``, as
are several ``SelectionDAG`` processing steps.

To follow the SPARC examples in this document, have a copy of `The SPARC
Architecture Manual, Version 8 <http://www.sparc.org/standards/V8.pdf>`_ for
Expand Down
Loading

0 comments on commit b64f020

Please sign in to comment.