aboutsummaryrefslogtreecommitdiff
path: root/objectivec/README.md
diff options
context:
space:
mode:
authorThomas Van Lenten <thomasvl@google.com>2016-06-14 13:23:37 -0400
committerThomas Van Lenten <thomasvl@google.com>2016-06-15 11:36:52 -0400
commita2a3399a6f84e29ab2dfc8c55739bbd495c314ce (patch)
tree9a72979f27d09aa268485a208bc9802b45157d56 /objectivec/README.md
parent71f4a9c6f35007609ef423ab643c05c1f88731ce (diff)
downloadprotobuf-a2a3399a6f84e29ab2dfc8c55739bbd495c314ce.tar.gz
protobuf-a2a3399a6f84e29ab2dfc8c55739bbd495c314ce.tar.bz2
protobuf-a2a3399a6f84e29ab2dfc8c55739bbd495c314ce.zip
Add support for generation sources into a framework.
- Add a protoc objc option (generate_for_named_framework) to set the name of the framework all generated sources will be in. - Tweak some comments/naming to make it clear what is the Protobuf framework vs. the framework for generated code. - Update the objc README to document the new generation option to protoc. This is working towards https://github.com/google/protobuf/issues/1457.
Diffstat (limited to 'objectivec/README.md')
-rw-r--r--objectivec/README.md17
1 files changed, 15 insertions, 2 deletions
diff --git a/objectivec/README.md b/objectivec/README.md
index c7313e4f..beda2cb6 100644
--- a/objectivec/README.md
+++ b/objectivec/README.md
@@ -123,8 +123,8 @@ never included when the message is encoded.
The Objective C classes/enums can be used from Swift code.
-Objective C Generator Options
------------------------------
+Objective C Generator Proto File Options
+----------------------------------------
**objc_class_prefix=\<prefix\>** (no default)
@@ -133,6 +133,19 @@ be collisions. This option provides a prefix that will be added to the Enums
and Objects (for messages) generated from the proto. Convention is to base
the prefix on the package the proto is in.
+Objective C Generator `protoc` Options
+--------------------------------------
+
+When generating Objective C code, `protoc` supports a `--objc_opt` argument; the
+argument is comma-delimited name/value pairs (_key=value,key2=value2_). The
+_keys_ are used to change the behavior during generation. The currently
+supported keys are:
+
+ * `generate_for_framework_named`: The `value` used for this key will be used
+ when generating the `#import` statements in the generated code. Instead
+ of being plain `#import "some/path/file.pbobjc.h"` lines, they will be
+ framework based, i.e. - `#import <VALUE/file.pbobjc.h>`.
+
Contributing
------------