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
RAldrich · Aug 5, 2015 · 6aeb09b · 6aeb09b
1 parent 210c0ec
commit 6aeb09b
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 4 deletions.
diff --git a/android/jni/include.mk b/android/jni/include.mk
@@ -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)

diff --git a/docs/html/md__compiler.html b/docs/html/md__compiler.html
@@ -75,7 +75,7 @@
 <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
@@ -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++).
 

diff --git a/src/flatc.cpp b/src/flatc.cpp
@@ -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"