BigfootDev/flatbuffers
1
0
Fork 1
mirror of https://github.com/google/flatbuffers.git synced 2026-06-07 22:03:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added long form options for all generators (--cpp etc.)

Browse Source 
Short-form versions are still supported, but are deprecated.

Change-Id: I15f70ca8d69ba5790368205caa9603b65e1b7fff
Tested: on Linux.
This commit is contained in:
Wouter van Oortmerssen
2015-11-25 17:26:34 -08:00
parent b7d8c2af1a
commit d7b4a31e93
6 changed files with 68 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
docs/source/Compiler.md
View File

@@ -2,7 +2,7 @@
Usage:
flatc [ -c ] [ -j ] [ -b ] [ -t ] [ -o PATH ] [ -I PATH ] [ -S ] FILES...
flatc [ GENERATOR OPTIONS ] [ -o PATH ] [ -I PATH ] [ -S ] FILES...
[ -- FILES...]
The files are read and parsed in order, and can contain either schemas
@@ -16,21 +16,34 @@ Incompatible binary files currently will give unpredictable results (!)
Depending on the flags passed, additional files may
be generated for each file processed:
- `-c` : Generate a C++ header for all definitions in this file (as
`filename_generated.h`). Skipped for data.
For any schema input files, one or more generators can be specified:
- `-j` : Generate Java classes. Skipped for data.
- `--cpp`, `-c` : Generate a C++ header for all definitions in this file (as
`filename_generated.h`).
- `-n` : Generate C# classes. Skipped for data.
- `--java`, `-j` : Generate Java code.
- `-g` : Generate Go classes. Skipped for data.
- `--csharp`, `-n` : Generate C# code.
- `-b` : If data is contained in this file, generate a
`filename.bin` containing the binary flatbuffer.
- `--go`, `-g` : Generate Go code.
- `-t` : If data is contained in this file, generate a
- `--python`, `-p`: Generate Python code.
- `--javascript`, `-s`: Generate JavaScript code.
- `--php`: Generate PHP code.
For any data input files:
- `--binary`, `-b` : If data is contained in this file, generate a
`filename.bin` containing the binary flatbuffer (or a different extension
if one is specified in the schema).
- `--json`, `-t` : If data is contained in this file, generate a
`filename.json` representing the data in the flatbuffer.
Additional options:
- `-o PATH` : Output all generated files to PATH (either absolute, or
relative to the current directory). If omitted, PATH will be the
current directory. PATH should end in your systems path separator,
@@ -82,3 +95,6 @@ be generated for each file processed:
output a binary version of the specified schema that itself corresponds
to the reflection/reflection.fbs schema. Loading this binary file is the
basis for reflection functionality.
NOTE: short-form options for generators are deprecated, use the long form
whenever possible.