Clarified the use of the deprecated flatc --gen-includes flag.
authorStewart Miles <smiles@google.com>
Tue, 4 Aug 2015 18:40:45 +0000 (11:40 -0700)
committerStewart Miles <smiles@google.com>
Wed, 5 Aug 2015 20:26:13 +0000 (13:26 -0700)
Also, removed the flag from the Android makefile.

Tested:
Verified flatc builds successfully on Linux and regenerated the docs.

Change-Id: I7140daa10b7cb9a29b5ffd63c6b20489e72a5899

android/jni/include.mk
docs/html/md__compiler.html
docs/source/Compiler.md
src/flatc.cpp

index 45edf9d..2acae06 100644 (file)
@@ -66,7 +66,7 @@ FLATBUFFERS_FLATC_PATH?=$(FLATBUFFERS_CMAKELISTS_DIR)
 FLATBUFFERS_FLATC := $(FLATBUFFERS_FLATC_PATH)/Debug/flatc
 endif
 
-FLATBUFFERS_FLATC_ARGS?=--gen-includes
+FLATBUFFERS_FLATC_ARGS?=
 
 # Search for cmake.
 CMAKE_ROOT := $(realpath $(LOCAL_PATH)/../../../../../../prebuilts/cmake)
index 8db385d..a95d73a 100644 (file)
@@ -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>
index 643f19c..5d254df 100755 (executable)
@@ -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++).
 
index 91ecb25..9b8b50d 100755 (executable)
@@ -90,7 +90,9 @@ static void Error(const std::string &err, bool usage, bool show_exe_name) {
       "  --defaults-json Output fields whose value is the default when\n"
       "                  writing JSON\n"
       "  --no-prefix     Don\'t prefix enum values with the enum type in C++.\n"
-      "  --gen-includes  (deprecated), instead use:\n"
+      "  --gen-includes  (deprecated), this is the default behavior.\n"
+      "                  If the original behavior is required (no include\n"
+         "                  statements) use --no-includes.\n"
       "  --no-includes   Don\'t generate include statements for included\n"
       "                  schemas the generated file depends on (C++).\n"
       "  --gen-mutable   Generate accessors that can mutate buffers in-place.\n"