stability.html 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. {
  2. title: "API Stability",
  3. crumbs: [
  4. { 'Reference Guide': '../ref/' },
  5. ],
  6. }
  7. <h1>Interface Stability Classification</h1>
  8. <p>The programming interfaces and data structures are classified with a stability class. These
  9. classifications help developers understand which interfaces may change in future releases and may
  10. need&nbsp; to be wrapped within their applications.</p>
  11. <p>The version numbering for Embedthis products follows the scheme MAJOR.MINOR.PATCH. For example 2.1.3 is
  12. major version 2, minor version 1 and patch version 3.</p>
  13. <table title="classification" class="ui table segment">
  14. <thead>
  15. <tr>
  16. <th>Classification</th>
  17. <th>Description</th>
  18. </tr>
  19. </thead>
  20. <tbody>
  21. <tr>
  22. <td>
  23. <p>Mature</p>
  24. </td>
  25. <td>
  26. <p>Must be interoperable across at least two consecutive major releases so that applications
  27. are not required to change. These APIs must be Deprecated before change or removal.</p>
  28. </td>
  29. </tr>
  30. <tr>
  31. <td>
  32. <p>Stable</p>
  33. </td>
  34. <td>
  35. <p>Will not change between minor releases (e.g. 2.0 to 2.1). May change between major
  36. releases.</p>
  37. </td>
  38. </tr>
  39. <tr>
  40. <td>
  41. <p>Evolving</p>
  42. </td>
  43. <td>
  44. <p>May change between major or minor releases. May not change between patch releases (e.g.
  45. 2.0.0 to 2.0.1) release.<br /></p>
  46. </td>
  47. </tr>
  48. <tr>
  49. <td>Prototype</td>
  50. <td>May change between any major, minor or patch releases.</td>
  51. </tr>
  52. <tr>
  53. <td>
  54. <p>Deprecated</p>
  55. </td>
  56. <td>
  57. <p>For use by legacy applications only. Customers are advised that these interfaces may be
  58. removed in the next major or minor release.<br /></p>
  59. </td>
  60. </tr>
  61. </tbody>
  62. </table>