[CDRIVER-1912] Document configuration options in installation docs Created: 09/Nov/16 Updated: 28/Jan/17 Resolved: 27/Jan/17 |
|
| Status: | Closed |
| Project: | C Driver |
| Component/s: | docs |
| Affects Version/s: | None |
| Fix Version/s: | 1.6.0 |
| Type: | Improvement | Priority: | Major - P3 |
| Reporter: | David Golden | Assignee: | A. Jesse Jiryu Davis |
| Resolution: | Done | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Description |
|
We should list, and document, each configuration option of libbson and mongoc. Both standard configure options and our custom ones. – libbson's README.md has info on config options like `--enable-static`. libmongoc's README does not, nor does the mongoc docs site. I think it would help users to mention that and other common autolib/configure options in an easy-to-find location. |
| Comments |
| Comment by Githook User [ 28/Jan/17 ] | ||
|
Author: {u'username': u'ajdavis', u'name': u'A. Jesse Jiryu Davis', u'email': u'jesse@mongodb.com'}Message: | ||
| Comment by Githook User [ 25/Jan/17 ] | ||
|
Author: {u'username': u'ajdavis', u'name': u'A. Jesse Jiryu Davis', u'email': u'jesse@mongodb.com'}Message: | ||
| Comment by David Golden [ 14/Jan/17 ] | ||
|
Counterexample from configure --help:
What is this for? When would I want to use it? When should I avoid it? Ditto stuff like the shm_counters. The mongocxx evergreen config disables them. The Travis config does not. Why? It's your call, but I wouldn't have opened this if we weren't wondering why the config options are different in different CI systems, etc. | ||
| Comment by A. Jesse Jiryu Davis [ 14/Jan/17 ] | ||
|
I propose not doing this, since ./configure --help correctly documents both the standard options and our custom options, for libbson and libmongoc. I don't see any value in copying a description of each standard option into our HTML docs, particularly since they'll vary according to what version of the Autotools you have installed. It's their job, not ours, to document these. I do see the value in documenting our projects' custom options in HTML. But there is also a cost: We must remember to update the HTML when we update the Autotools configuration, and inevitably we'll forget. I think this cost outweighs the value. |