Skip to content

Commit 4e4d8a5

Browse files
ajdavishanumantmk
authored andcommitted
CDRIVER-414: Add "How To Ask For Help" to README.
Closes #160
1 parent f4e5adb commit 4e4d8a5

File tree

1 file changed

+44
-2
lines changed

1 file changed

+44
-2
lines changed

README.rst

Lines changed: 44 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ The documentation is available at http://api.mongodb.org/c/current/.
2323
For issues with, questions about, or feedback for libmongoc, please look into
2424
our `support channels <http://www.mongodb.org/about/support>`_. Please
2525
do not email any of the libmongoc developers directly with issues or
26-
questions - you're more likely to get an answer on the `mongodb-user
27-
<http://groups.google.com/group/mongodb-user>`_ list on Google Groups.
26+
questions - you're more likely to get an answer on the `mongodb-user list`_
27+
on Google Groups.
2828

2929
Bugs / Feature Requests
3030
=======================
@@ -39,6 +39,48 @@ case in our issue management tool, JIRA:
3939
Bug reports in JIRA for all driver projects (i.e. CDRIVER, CSHARP, JAVA) and the
4040
Core Server (i.e. SERVER) project are **public**.
4141

42+
How To Ask For Help
43+
-------------------
44+
45+
If you are having difficulty building the driver after reading the below instructions, please email
46+
the `mongodb-user list`_ to ask for help. Please include in your email all of the following
47+
information:
48+
49+
- The version of the driver you are trying to build (branch or tag).
50+
- Examples: master branch, 1.0.2 tag
51+
- Host OS, version, and architecture.
52+
- Examples: Windows 8 64-bit x86, Ubuntu 12.04 32-bit x86, OS X Mavericks
53+
- C Compiler and version.
54+
- Examples: GCC 4.8.2, MSVC 2013 Express, clang 3.4, XCode 5
55+
- The output of ``./autogen.sh`` or ``./configure`` (depending on whether you are building from a
56+
repository checkout or from a tarball). The output starting from "libbson was configured with
57+
the following options" is sufficient.
58+
- The text of the error you encountered.
59+
60+
Failure to include the relevant information will result in additional round-trip
61+
communications to ascertain the necessary details, delaying a useful response.
62+
Here is a made-up example of a help request that provides the relevant
63+
information:
64+
65+
Hello, I'm trying to build the C driver with SSL, from mongo-c-driver-1.1.0.tar.gz. I'm on Ubuntu
66+
14.04, 64-bit Intel, with gcc 4.8.2. I run configure like::
67+
68+
$ ./configure --enable-sasl=yes
69+
checking for gcc... gcc
70+
checking whether the C compiler works... yes
71+
72+
... SNIPPED OUTPUT, but when you ask for help, include full output without any omissions ...
73+
74+
checking for pkg-config... no
75+
checking for SASL... no
76+
checking for sasl_client_init in -lsasl2... no
77+
checking for sasl_client_init in -lsasl... no
78+
configure: error: You must install the Cyrus SASL libraries and development headers to enable SASL support.
79+
80+
Can you tell me what I need to install? Thanks!
81+
82+
.. _mongodb-user list: http://groups.google.com/group/mongodb-user
83+
4284
Security Vulnerabilities
4385
------------------------
4486

0 commit comments

Comments
 (0)