Document disabling the on-by-default gRPC/GAX transport for pubsub/logging.

tseaver · tseaver · commit 9cf5b721c7b3 · 2016-08-10T17:09:02.000-04:00
Addresses: #2085 (comment)
diff --git a/docs/logging-usage.rst b/docs/logging-usage.rst
@@ -13,6 +13,12 @@ Authentication and Configuration
   to interact with. If you are Google App Engine or Google Compute Engine
   this will be detected automatically.
 
+- The library now enables the ``gRPC`` transport for the logging API by
+  default, assuming that the required dependencies are installed and
+  importable.  To *disable* this transport, set the
+  :envvar:`GCLOUD_DISABLE_GAX` environment variable to a non-empty string,
+  e.g.:  ``$ export GCLOUD_DISABLE_GAX=1``.
+
 - After configuring your environment, create a
   :class:`Client <gcloud.logging.client.Client>`
 
diff --git a/docs/pubsub-usage.rst b/docs/pubsub-usage.rst
@@ -7,6 +7,17 @@ Authentication / Configuration
 - Use :class:`Client <gcloud.pubsub.client.Client>` objects to configure
   your applications.
 
+- In addition to any authentication configuration, you should also set the
+  :envvar:`GCLOUD_PROJECT` environment variable for the project you'd like
+  to interact with. If you are Google App Engine or Google Compute Engine
+  this will be detected automatically.
+
+- The library now enables the ``gRPC`` transport for the pubsub API by
+  default, assuming that the required dependencies are installed and
+  importable.  To *disable* this transport, set the
+  :envvar:`GCLOUD_DISABLE_GAX` environment variable to a non-empty string,
+  e.g.:  ``$ export GCLOUD_DISABLE_GAX=1``.
+
 - :class:`Client <gcloud.pubsub.client.Client>` objects hold both a ``project``
   and an authenticated connection to the PubSub service.
 
