From 6aeb09b297860061047fa89b4f1129519cc7cf0b Mon Sep 17 00:00:00 2001 From: Stewart Miles Date: Tue, 4 Aug 2015 11:40:45 -0700 Subject: [PATCH] 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 --- android/jni/include.mk | 2 +- docs/html/md__compiler.html | 2 +- docs/source/Compiler.md | 5 ++++- src/flatc.cpp | 4 +++- 4 files changed, 9 insertions(+), 4 deletions(-) diff --git a/android/jni/include.mk b/android/jni/include.mk index 45edf9d1d..2acae06b7 100644 --- 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 index 8db385dc0..a95d73aef 100644 --- a/docs/html/md__compiler.html +++ b/docs/html/md__compiler.html @@ -75,7 +75,7 @@ $(document).ready(function(){initNavTree('md__compiler.html','');});
  • --strict-json : Require & 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.
  • --defaults-json : Output fields whose value is equal to the default value when writing JSON text.
  • --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++).
  • --gen-mutable : Generate additional non-const accessors for mutating FlatBuffers in-place.
  • --gen-onefile : Generate single output file (useful for C#)
  • diff --git a/docs/source/Compiler.md b/docs/source/Compiler.md index 643f19caa..5d254dfa5 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++). diff --git a/src/flatc.cpp b/src/flatc.cpp index 91ecb25b5..9b8b50d70 100755 --- 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"