From 97950ced81edfbef3f8501d3b887bf909668271c Mon Sep 17 00:00:00 2001
From: Carmi Grushko <carmi@google.com>
Date: Thu, 9 Mar 2017 17:25:38 +0000
Subject: Document the descriptor set output of proto_library.

--
PiperOrigin-RevId: 149659956
MOS_MIGRATED_REVID=149659956
---
 .../devtools/build/lib/rules/proto/BazelProtoLibraryRule.java  | 10 ++++++++++
 1 file changed, 10 insertions(+)

(limited to 'src')

diff --git a/src/main/java/com/google/devtools/build/lib/rules/proto/BazelProtoLibraryRule.java b/src/main/java/com/google/devtools/build/lib/rules/proto/BazelProtoLibraryRule.java
index cbb09fd149..c0a6eb00aa 100644
--- a/src/main/java/com/google/devtools/build/lib/rules/proto/BazelProtoLibraryRule.java
+++ b/src/main/java/com/google/devtools/build/lib/rules/proto/BazelProtoLibraryRule.java
@@ -94,4 +94,14 @@ public final class BazelProtoLibraryRule implements RuleDefinition {
    in the <code>deps</code> clause of supported rules, such as <code>java_proto_library</code>.
 </p>
 
+<p>When compiled on the command-line, a <code>proto_library</code> creates a file named
+<code>foo-descriptor-set.proto.bin</code>, which is the descriptor set for the
+messages the rule srcs. The file is a serialized <code>FileDescriptorSet</code>, which is described
+in https://developers.google.com/protocol-buffers/docs/techniques#self-description.</p>
+
+<p>It only contains information about the <code>.proto</code> files directly mentioned by a
+<code>proto_library</code> rule; the collection of transitive descriptor sets is available through
+the <code>proto.transitivedescriptorsets</code> Skylark provider.
+See documentation in <code>ProtoSourcesProvider.java</code>.</p>
+
 <!-- #END_BLAZE_RULE -->*/
-- 
cgit v1.2.3