[ZOOKEEPER-263] document connection host:port as comma separated list in forrest docs

• Type: Improvement
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 3.0.0, 3.0.1
• Fix Version/s: 3.1.0
• Component/s: c client, documentation, java client
• Hadoop Flags: Reviewed
• Assignee: Patrick D. Hunt Assign to me
• Reporter: Patrick D. Hunt
• Created: 05/Jan/09 19:50
• Updated: 13/Feb/09 21:18
• Resolved: 28/Jan/09 00:22

Description

The java API docs talk about the host:port comma separated list, however the forrest docs don't mention this. it's confusing for users, they don't know that the connection string can be a list of host:port comma separated. We should mention in the programmer guide, perhaps even in the overview/started (mention in passing and reference the prog guide for full detail).

Also the java doc should be updated, right now we have a "see also" in the short constructor, to make it more explicit we should copy/paste the docs.

The c client should also be updated to detail that it's a comma separated list of host:port (similar to java). Right host we just say "host", need to be more explicit as to the format of the string.