Update ios_framework rule doc to emphasize the current issues.

--
MOS_MIGRATED_REVID=117018073

1 files changed, 10 insertions, 4 deletions

diff --git a/src/main/java/com/google/devtools/build/lib/rules/objc/IosFrameworkRule.java b/src/main/java/com/google/devtools/build/lib/rules/objc/IosFrameworkRule.java
index 11d75c7b2b..424090598a 100644
--- a/src/main/java/com/google/devtools/build/lib/rules/objc/IosFrameworkRule.java
+++ b/src/main/java/com/google/devtools/build/lib/rules/objc/IosFrameworkRule.java
@@ -70,13 +70,19 @@ public class IosFrameworkRule implements RuleDefinition {
 /*<!-- #BLAZE_RULE (NAME = ios_framework, TYPE = BINARY, FAMILY = Objective-C) -->
 
 <p>This rule produces a bundled binary for a framework from a compiled binary and bundle
-metadata.</p>
+metadata. It is still in experimental stage.</p>
 
 <p>A framework is a bundle that contains a dynamic library (the "binary"), public headers (that
-clients of the framework can use) and any resources. Framework headers are stripped out of the
-final app bundle and only used during compilation stage.
+clients of the framework can use) and any resources.</p>
 
 <p>Bundles generated by this rule use a bundle directory called
-<code>Frameworks/<var>framework_name</var>.framework</code>.
+<code>Frameworks/<var>framework_name</var>.framework</code>.</p>
+
+<p>Please be aware that in the current implementation, frameworks created by this rule can only be
+used during compilation and linking phase of the app with the intention of including the framework
+in the app bundle, not for standalone distribution.</p>
+
+<p>Due to this, when built as a direct target, the resulting bundle will not have headers, only the
+dynamic library.</p>
 
 <!-- #END_BLAZE_RULE -->*/