[CXX-482] Please make docs for C, C++ drivers match docs for Java driver Created: 21/Jan/15 Updated: 23/Jan/15 Resolved: 23/Jan/15 |
|
| Status: | Closed |
| Project: | C++ Driver |
| Component/s: | None |
| Affects Version/s: | None |
| Fix Version/s: | legacy-1.0.0-rc4 |
| Type: | Improvement | Priority: | Major - P3 |
| Reporter: | Mark Callaghan | Assignee: | Andrew Morrow (Inactive) |
| Resolution: | Done | Votes: | 0 |
| Labels: | legacy-cxx | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Issue Links: |
|
||||||||||||
| Description |
|
I wanted to write MongoDB benchmark clients in C++ to avoid problems from Java GC stalls and to re-learn modern C++. For the C driver the API section documents types but not functions. For the C++ driver I get confused.
|
| Comments |
| Comment by Andrew Morrow (Inactive) [ 22/Jan/15 ] |
|
mdcallag FYI I've added some notes to the testing wiki page explaining the differences on the 26compat branch. See the linked wiki diff in |
| Comment by Andrew Morrow (Inactive) [ 22/Jan/15 ] |
|
mdcallag Since I've filed other tickets for the issues with the C++ Driver 26compat docs ( Thanks, |
| Comment by Mark Callaghan [ 21/Jan/15 ] |
|
Thanks for the prompt responses. I see now that the C API has lots of documentation once I click on the types. |
| Comment by Andrew Morrow (Inactive) [ 21/Jan/15 ] |
|
Hi mdcallag - A few comments in addition to what Tyler wrote above:
In the meantime, if you have specific questions that the documentation is not answering, the C and C++ developers monitor mongodb-user and mongodb-dev closely and will be happy to answer any questions there. Thanks, |
| Comment by Michael Paik [ 21/Jan/15 ] |
|
To be clear, this isn't actually from me - this is a DOCS ticket that I moved to Drivers that Bernie then moved to C++. I've got no skin in the game. |
| Comment by Tyler Brock [ 21/Jan/15 ] |
|
Hey Michael, That seems like a worthwhile goal. Thanks for being interested. This project is for the C++ drivers only. Any questions about the C driver should be filed as within the CDRIVER project. I would file a ticket there myself for your issue but I'm not sure I understand what you mean by "the C driver api section documents types but not functions". The existing documentation does, in fact, document functions but they are documented within the section for a specific type. For example, the documentation for mongoc_collection_t includes documentation for mongoc_collection_insert which operates on a mongoc_collection_t. The C++ driver is confusing. There are 3 of them, one which is called 26compat, another called legacy, and the future one which will just be called "The C++(11) driver". The 26compat driver is meant to be 2.6compat-ible and was extracted directly from the MongoDB 2.6 source tree. The legacy driver has various enhancements to that code while maintaining the overall API and cruft of the existing driver and the new C++11 driver is brand new and being written from scratch. We are encouraging users to use the legacy driver now and the C++11 driver when it is released (hence the name legacy for the existing one). The API page does document the 26compat driver as C++(Server) – Deprecated. We probably won't update the wiki page for 26compat as we don't want people to actually use it outside of requiring a drop in replacement for code written against the client that existed in the server circa MongoDB 2.6. |