Merge pull request #599 from Shopify/ssl-docs

Update docs around TLS

CHANGELOG.md

@@ -14,6 +14,8 @@ Improvements:
    ([#584](https://github.com/Shopify/sarama/pull/584)).
  - Automatically retry `InvalidMessage` errors to match upstream behaviour
    ([#589](https://github.com/Shopify/sarama/pull/589)).
+ - Verified that TLS support works with Kafka 0.9
+   ([#581](https://github.com/Shopify/sarama/pull/581)).
 
 Bug Fixes:
  - Fix the OffsetManager to be compatible with Kafka 0.9

Makefile

@@ -7,7 +7,7 @@ vet:
 	go vet ./...
 
 errcheck:
-	errcheck github.com/Shopify/sarama/...
+	@if go version | grep -q go1.5; then errcheck github.com/Shopify/sarama/...; fi
 
 fmt:
 	@if [ -n "$$(go fmt ./...)" ]; then echo 'Please run go fmt on your code.' && exit 1; fi
@@ -15,7 +15,7 @@ fmt:
 install_dependencies: install_errcheck install_go_vet get
 
 install_errcheck:
-	go get github.com/kisielk/errcheck
+	@if go version | grep -q go1.5; then go get github.com/kisielk/errcheck; fi
 
 install_go_vet:
 	go get golang.org/x/tools/cmd/vet

config.go

@@ -21,8 +21,6 @@ type Config struct {
 		ReadTimeout  time.Duration // How long to wait for a response.
 		WriteTimeout time.Duration // How long to wait for a transmit.
 
-		// NOTE: these config values have no compatibility guarantees; they may
-		// change when Kafka releases its official TLS support in version 0.9.
 		TLS struct {
 			// Whether or not to use TLS when connecting to the broker
 			// (defaults to false).