Skip to content

Commit

Permalink
[docs] Fix up some links to the preferred style.
Browse files Browse the repository at this point in the history
:doc:`...` and :ref:`...` links help Sphinx keep track the dependencies
between documents and ensure that they are not pointing to nowhere.

Raw HTML links work just fine and are easier for people less familiar
with reST/Sphinx. They are easy to change over to the :doc:/:ref: style
after the fact so this is not a problem.

This commit doesn't fix all of them.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@205792 91177308-0d34-0410-b5e6-96231b3b80d8
  • Loading branch information
chisophugis committed Apr 8, 2014
1 parent c6a7502 commit 0a50cec
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 16 deletions.
6 changes: 3 additions & 3 deletions docs/AliasAnalysis.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ starting address and size, and function calls are represented as the actual
get mod/ref information for arbitrary instructions.

All ``AliasAnalysis`` interfaces require that in queries involving multiple
values, values which are not `constants <LangRef.html#constants>`_ are all
values, values which are not :ref:`constants <constants>` are all
defined within the same function.

Representation of Pointers
Expand Down Expand Up @@ -111,7 +111,7 @@ returns MustAlias, PartialAlias, MayAlias, or NoAlias as appropriate.

Like all ``AliasAnalysis`` interfaces, the ``alias`` method requires that either
the two pointer values be defined within the same function, or at least one of
the values is a `constant <LangRef.html#constants>`_.
the values is a :ref:`constant <constants>`.

.. _Must, May, or No:

Expand All @@ -126,7 +126,7 @@ used for reading memory. Another is when the memory is freed and reallocated
between accesses through one pointer and accesses through the other --- in this
case, there is a dependence, but it's mediated by the free and reallocation.

As an exception to this is with the `noalias <LangRef.html#noalias>`_ keyword;
As an exception to this is with the :ref:`noalias <noalias>` keyword;
the "irrelevant" dependencies are ignored.

The ``MayAlias`` response is used whenever the two pointers might refer to the
Expand Down
2 changes: 1 addition & 1 deletion docs/Bugpoint.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ optimization (or combination of optimizations) that causes the crash, and reduce
the file down to a small example which triggers the crash.

For detailed case scenarios, such as debugging ``opt``, or one of the LLVM code
generators, see `How To Submit a Bug Report document <HowToSubmitABug.html>`_.
generators, see :doc:`HowToSubmitABug`.

Design Philosophy
=================
Expand Down
2 changes: 1 addition & 1 deletion docs/CodeGenerator.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ different pieces of this will be useful to you. In any case, you should be
familiar with the `target description`_ and `machine code representation`_
classes. If you want to add a backend for a new target, you will need to
`implement the target description`_ classes for your new target and understand
the `LLVM code representation <LangRef.html>`_. If you are interested in
the :doc:`LLVM code representation <LangRef>`. If you are interested in
implementing a new `code generation algorithm`_, it should only depend on the
target-description and machine code representation classes, ensuring that it is
portable.
Expand Down
7 changes: 2 additions & 5 deletions docs/CodingStandards.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,10 +76,7 @@ implemented in the LLVM namespace following the expected standard interface.

There are some exceptions such as the standard I/O streams library which are
avoided. Also, there is much more detailed information on these subjects in the
`Programmer's Manual`_.

.. _Programmer's Manual:
http://llvm.org/docs/ProgrammersManual.html
:doc:`ProgrammersManual`.

Supported C++11 Language and Library Features
---------------------------------------------
Expand Down Expand Up @@ -605,7 +602,7 @@ is never used for a class. Because of this, we turn them off globally in the
code.

That said, LLVM does make extensive use of a hand-rolled form of RTTI that use
templates like `isa<>, cast<>, and dyn_cast<> <ProgrammersManual.html#isa>`_.
templates like :ref:`isa\<>, cast\<>, and dyn_cast\<> <isa>`.
This form of RTTI is opt-in and can be
:doc:`added to any class <HowToSetUpLLVMStyleRTTI>`. It is also
substantially more efficient than ``dynamic_cast<>``.
Expand Down
8 changes: 4 additions & 4 deletions docs/GettingStartedVS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Most of the tools build and work. ``bugpoint`` does build, but does
not work.

Additional information about the LLVM directory structure and tool chain
can be found on the main `Getting Started <GettingStarted.html>`_ page.
can be found on the main :doc:`GettingStarted` page.


Requirements
Expand Down Expand Up @@ -97,7 +97,7 @@ Here's the short story for getting up and running quickly with LLVM:
using LLVM. Another important option is ``LLVM_TARGETS_TO_BUILD``,
which controls the LLVM target architectures that are included on the
build.
* See the `LLVM CMake guide <CMake.html>`_ for detailed information about
* See the :doc:`LLVM CMake guide <CMake>` for detailed information about
how to configure the LLVM build.

6. Start Visual Studio
Expand Down Expand Up @@ -215,8 +215,8 @@ An Example Using the LLVM Tool Chain
Common Problems
===============
If you are having problems building or using LLVM, or if you have any other
general questions about LLVM, please consult the `Frequently Asked Questions
<FAQ.html>`_ page.
general questions about LLVM, please consult the :doc:`Frequently Asked Questions
<FAQ>` page.


Links
Expand Down
9 changes: 7 additions & 2 deletions docs/LangRef.rst
Original file line number Diff line number Diff line change
Expand Up @@ -802,6 +802,9 @@ Currently, only the following parameter attributes are defined:
not to trap and to be properly aligned. This may only be applied to
the first parameter. This is not a valid attribute for return
values.

.. _noalias:

``noalias``
This indicates that pointer values :ref:`based <pointeraliasing>` on
the argument or return value do not alias pointer values which are
Expand All @@ -811,8 +814,8 @@ Currently, only the following parameter attributes are defined:
"irrelevant" to the ``noalias`` keyword for the arguments and return
value used in that call. The caller shares the responsibility with
the callee for ensuring that these requirements are met. For further
details, please see the discussion of the NoAlias response in `alias
analysis <AliasAnalysis.html#MustMayNo>`_.
details, please see the discussion of the NoAlias response in :ref:`alias
analysis <Must, May, or No>`.

Note that this definition of ``noalias`` is intentionally similar
to the definition of ``restrict`` in C99 for function arguments,
Expand Down Expand Up @@ -1986,6 +1989,8 @@ notion of a forward declared structure.
| ``opaque`` | An opaque type. |
+--------------+-------------------+

.. _constants:

Constants
=========

Expand Down

0 comments on commit 0a50cec

Please sign in to comment.