Skip to content

Commit

Permalink
Attempt to fix the ReST compilation to html of the C API docs.
Browse files Browse the repository at this point in the history
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@255304 91177308-0d34-0410-b5e6-96231b3b80d8
  • Loading branch information
echristo committed Dec 10, 2015
1 parent 7e0619a commit 67b9896
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions docs/DeveloperPolicy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -529,28 +529,28 @@ C API Changes
----------------

* Stability Guarantees: The C API is, in general, a "best effort" for stability.
This means that we make every attempt to keep the C API stable, but that
stability will be limited by the abstractness of the interface and the stability
of the C++ API that it wraps. In practice, this means that things like "create
debug info" or "create this type of instruction" are likely to be less stable
than "take this IR file and JIT it for my current machine".
This means that we make every attempt to keep the C API stable, but that
stability will be limited by the abstractness of the interface and the
stability of the C++ API that it wraps. In practice, this means that things
like "create debug info" or "create this type of instruction" are likely to be
less stable than "take this IR file and JIT it for my current machine".

* Release stability: We won't break the C API on the release branch with patches
that go on that branch, with the exception that if we will fix an unintentional
C API break that will keep the release consistent with both the previous and next
release.
that go on that branch, with the exception that if we will fix an unintentional
C API break that will keep the release consistent with both the previous and
next release.

* Testing: Patches to the C API are expected to come with tests just like any
other patch.
other patch.

* Including new things into the API: If an LLVM subcomponent has a C API already
included, then expanding that C API is acceptable. Adding C API for subcomponents
that don't currently have one need to be discussed on the mailing list for design
and maintainability feedback prior to implementation.
included, then expanding that C API is acceptable. Adding C API for
subcomponents that don't currently have one need to be discussed on the mailing
list for design and maintainability feedback prior to implementation.

* Documentation: Any changes to the C API are required to be documented in the
release notes so that it's clear to external users who do not follow the project
how the C API is changing and evolving.
release notes so that it's clear to external users who do not follow the
project how the C API is changing and evolving.

.. _copyright-license-patents:

Expand Down

0 comments on commit 67b9896

Please sign in to comment.