Updated documentation

rxin · rxin · commit e9823e7fc65a · 2016-10-31T22:32:39.000-07:00
diff --git a/sql/core/src/main/scala/org/apache/spark/sql/execution/datasources/FileCommitProtocol.scala b/sql/core/src/main/scala/org/apache/spark/sql/execution/datasources/FileCommitProtocol.scala
@@ -62,8 +62,11 @@ object FileCommitProtocol {
 
 
 /**
- * An interface to define how a Spark job commits its outputs. Implementations must be serializable,
- * as the committer instance instantiated on the driver will be used for tasks on executors.
+ * An interface to define how a single Spark job commits its outputs. Two notes:
+ *
+ * 1. Implementations must be serializable, as the committer instance instantiated on the driver
+ *    will be used for tasks on executors.
+ * 2. A committer should not be reused across multiple Spark jobs.
  *
  * The proper call sequence is:
  *

Original file line number	Diff line number	Diff line change
`@@ -62,8 +62,11 @@ object FileCommitProtocol {`
`62`	`62`
`63`	`63`
`64`	`64`	`/**`
`65`		`- * An interface to define how a Spark job commits its outputs. Implementations must be serializable,`
`66`		`- * as the committer instance instantiated on the driver will be used for tasks on executors.`
	`65`	`+ * An interface to define how a single Spark job commits its outputs. Two notes:`
	`66`	`+ *`
	`67`	`+ * 1. Implementations must be serializable, as the committer instance instantiated on the driver`
	`68`	`+ * will be used for tasks on executors.`
	`69`	`+ * 2. A committer should not be reused across multiple Spark jobs.`
`67`	`70`	`*`
`68`	`71`	`* The proper call sequence is:`
`69`	`72`	`*`