Document API and ABI policy

XMLWordPrintableJSON

    • Type: Task
    • Resolution: Done
    • Priority: Unknown
    • None
    • Affects Version/s: None
    • Component/s: None
    • None
    • Not Needed
    • None
    • Fully Compatible
    • C Drivers
    • Not Needed
    • Hide

      1. What would you like to communicate to the user about this feature?
      2. Would you like the user to see examples of the syntax and/or executable code and its output?
      3. Which versions of the driver/connector does this apply to?

      Show
      1. What would you like to communicate to the user about this feature? 2. Would you like the user to see examples of the syntax and/or executable code and its output? 3. Which versions of the driver/connector does this apply to?
    • None
    • None
    • None
    • None
    • None
    • None

      libmongoc and libbson do not set an ABI version. On Linux, the installed soname is: "libbson-1.0.so.0".

      Set an ABI version to communicate expected stability.

      Document expectations for API and ABI stability in libmongoc and libbson.

      • What symbols in public headers are considered ABI stable?
      • Is use of two ABI incompatible versions of the library supported?
      • What should users do/not do to avoid upgrade issues? (e.g. build with pkg-config/CMake rather than direct flags).

      Consider using the C++ policy defined in CXX-2967 as a model.

            Assignee:
            Colby Pike
            Reporter:
            Kevin Albertson
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:
              Resolved: