llvm.org GIT mirror llvm / 67b9896
Attempt to fix the ReST compilation to html of the C API docs. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@255304 91177308-0d34-0410-b5e6-96231b3b80d8 Eric Christopher 3 years ago
1 changed file(s) with 14 addition(s) and 14 deletion(s). Raw diff Collapse all Expand all
528528 ----------------
529529
530530 * Stability Guarantees: The C API is, in general, a "best effort" for stability.
531 This means that we make every attempt to keep the C API stable, but that
532 stability will be limited by the abstractness of the interface and the stability
533 of the C++ API that it wraps. In practice, this means that things like "create
534 debug info" or "create this type of instruction" are likely to be less stable
535 than "take this IR file and JIT it for my current machine".
531 This means that we make every attempt to keep the C API stable, but that
532 stability will be limited by the abstractness of the interface and the
533 stability of the C++ API that it wraps. In practice, this means that things
534 like "create debug info" or "create this type of instruction" are likely to be
535 less stable than "take this IR file and JIT it for my current machine".
536536
537537 * Release stability: We won't break the C API on the release branch with patches
538 that go on that branch, with the exception that if we will fix an unintentional
539 C API break that will keep the release consistent with both the previous and next
540 release.
538 that go on that branch, with the exception that if we will fix an unintentional
539 C API break that will keep the release consistent with both the previous and
540 next release.
541541
542542 * Testing: Patches to the C API are expected to come with tests just like any
543 other patch.
543 other patch.
544544
545545 * Including new things into the API: If an LLVM subcomponent has a C API already
546 included, then expanding that C API is acceptable. Adding C API for subcomponents
547 that don't currently have one need to be discussed on the mailing list for design
548 and maintainability feedback prior to implementation.
546 included, then expanding that C API is acceptable. Adding C API for
547 subcomponents that don't currently have one need to be discussed on the mailing
548 list for design and maintainability feedback prior to implementation.
549549
550550 * Documentation: Any changes to the C API are required to be documented in the
551 release notes so that it's clear to external users who do not follow the project
552 how the C API is changing and evolving.
551 release notes so that it's clear to external users who do not follow the
552 project how the C API is changing and evolving.
553553
554554 .. _copyright-license-patents:
555555