aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorStewart Miles <smiles@google.com>2015-08-04 11:40:45 -0700
committerStewart Miles <smiles@google.com>2015-08-05 13:26:13 -0700
commit6aeb09b297860061047fa89b4f1129519cc7cf0b (patch)
tree9a6044f9c9f1bea428fc20ca191762586093df06 /docs
parent210c0ece5498a381ceb5cdde6cc78862143aeed8 (diff)
downloadflatbuffers-6aeb09b297860061047fa89b4f1129519cc7cf0b.tar.gz
Clarified the use of the deprecated flatc --gen-includes flag.
Also, removed the flag from the Android makefile. Tested: Verified flatc builds successfully on Linux and regenerated the docs. Change-Id: I7140daa10b7cb9a29b5ffd63c6b20489e72a5899
Diffstat (limited to 'docs')
-rw-r--r--docs/html/md__compiler.html2
-rwxr-xr-xdocs/source/Compiler.md5
2 files changed, 5 insertions, 2 deletions
diff --git a/docs/html/md__compiler.html b/docs/html/md__compiler.html
index 8db385dc..a95d73ae 100644
--- a/docs/html/md__compiler.html
+++ b/docs/html/md__compiler.html
@@ -75,7 +75,7 @@ $(document).ready(function(){initNavTree('md__compiler.html','');});
<li><code>--strict-json</code> : Require &amp; generate strict JSON (field names are enclosed in quotes, no trailing commas in tables/vectors). By default, no quotes are required/generated, and trailing commas are allowed.</li>
<li><code>--defaults-json</code> : Output fields whose value is equal to the default value when writing JSON text.</li>
<li><code>--no-prefix</code> : Don't prefix enum values in generated C++ by their enum type.</li>
-<li><code>--gen-includes</code> : (deprecated), instead use:</li>
+<li><code>--gen-includes</code> : (deprecated), this is the default behavior. If the original behavior is required (no include statements) use <code>--no-includes.</code></li>
<li><code>--no-includes</code> : Don't generate include statements for included schemas the generated file depends on (C++).</li>
<li><code>--gen-mutable</code> : Generate additional non-const accessors for mutating FlatBuffers in-place.</li>
<li><code>--gen-onefile</code> : Generate single output file (useful for C#)</li>
diff --git a/docs/source/Compiler.md b/docs/source/Compiler.md
index 643f19ca..5d254dfa 100755
--- a/docs/source/Compiler.md
+++ b/docs/source/Compiler.md
@@ -51,7 +51,10 @@ be generated for each file processed:
- `--no-prefix` : Don't prefix enum values in generated C++ by their enum
type.
-- `--gen-includes` : (deprecated), instead use:
+- `--gen-includes` : (deprecated), this is the default behavior.
+ If the original behavior is required (no include
+ statements) use `--no-includes.`
+
- `--no-includes` : Don't generate include statements for included schemas the
generated file depends on (C++).