Merge pull request #61 from LinuxJedi/doc_fixes

LinuxJedi · LinuxJedi · commit f3d28366400b · 2014-08-31T11:09:00.000+01:00
Documentation updates
diff --git a/docs/api/query.rst b/docs/api/query.rst
@@ -121,6 +121,18 @@ attachsql_query_affected_rows()
 
    .. versionadded:: 0.1.0
 
+attachsql_query_warning_count()
+-------------------------------
+
+.. c:function:: uint32_t attachsql_query_warning_count(attachsql_connect_t *con)
+
+   Returns the number of warnings for a query.
+
+   :param con: The connection object the query was on
+   :returns: The number of warnings for the query result
+
+   .. versionadded:: 0.1.0
+
 attachsql_query_info()
 ----------------------
 
diff --git a/docs/contributors/github.rst b/docs/contributors/github.rst
@@ -79,7 +79,14 @@ If your commit fixes an issue you can add the following (for issue #93)::
 
    Fixes libattachsql/libattachsql#93
 
-Once all your commits are done you are now ready to push up to GitHub:
+Once all your commits are done a quick rebase may be needed to make sure your changes will merge OK with what is in master:
+
+.. code-block:: bash
+
+   git fetch upstream
+   git rebase upstream/master
+
+This will give futher instructions as to what is needed to complete the rebase.  You should now be ready to push up to GitHub:
 
 .. code-block:: bash
 
diff --git a/docs/introduction/version_history.rst b/docs/introduction/version_history.rst
@@ -10,7 +10,7 @@ Version 0.3.0 Alpha (Not yet released)
 * Fixed infinite loop memory eater for test run when MySQL server not present (`Issue #48 <https://github.com/libattachsql/libattachsql/issues/48>`_)
 * Add UDS test case (`Issue #46 <https://github.com/libattachsql/libattachsql/issues/46>`_).  Note, the ``MYSQL_SOCK`` env variable needs to be set to use it.
 * Add protocol compression support (`Issue #9 <https://github.com/libattachsql/libattachsql/issues/9>`_)
-* Additional documentation (`Issue #44 <https://github.com/libattachsql/libattachsql/issues/44>`_)
+* Additional documentation (`Issue #44 <https://github.com/libattachsql/libattachsql/issues/44>`_, `Issue #58 <https://github.com/libattachsql/libattachsql/issues/58>`_ and `Issue #59 <https://github.com/libattachsql/libattachsql/issues/59>`_)
 * Fixed case where multiple network writes could overwrite each other
 * Add optional SSL support using OpenSSL (`Issue #10 <https://github.com/libattachsql/libattachsql/issues/10>`_)
 * Fix valgrind reported problems (`Issue #55 <https://github.com/libattachsql/libattachsql/issues/55>`_)
