From: Lee Howes <lwh@fb.com>
Date: Wed, 1 Nov 2017 22:46:19 +0000 (-0700)
Subject: Quick comment on DE to clarify use cases and lack of thread safety.
X-Git-Tag: v2017.11.06.00~16
X-Git-Url: http://plrg.eecs.uci.edu/git/?p=folly.git;a=commitdiff_plain;h=968945c5e981c50746ba2f71293310a4536f96e1

Quick comment on DE to clarify use cases and lack of thread safety.

Summary: (Note: this ignores all push blocking failures!)

Reviewed By: yfeldblum

Differential Revision: D6212919

fbshipit-source-id: b066d99e13e97cbab489132bcb91872ed4407f81
---

diff --git a/folly/futures/Future-pre.h b/folly/futures/Future-pre.h
index 1fd0ebe7..26d9c7c6 100644
--- a/folly/futures/Future-pre.h
+++ b/folly/futures/Future-pre.h
@@ -155,6 +155,11 @@ struct Extract<R (&)(Args...)> {
 
 /**
  * Defer work until executor is actively boosted.
+ *
+ * NOTE: that this executor is a private implementation detail belonging to the
+ * Folly Futures library and not intended to be used elsewhere. It is designed
+ * specifically for the use case of deferring work on a SemiFuture. It is NOT
+ * thread safe. Please do not use for any other purpose without great care.
  */
 class DeferredExecutor final : public Executor {
  public: