summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAustin Schuh <AustinSchuh@users.noreply.github.com>2020-11-19 17:16:45 -0800
committerGitHub <noreply@github.com>2020-11-19 17:16:45 -0800
commite58c182443ac53c317c12fc8b4017d7816576a3d (patch)
treeddc8c1cb05b365637ee5cb0def84b21b9c243586 /docs
parent69a8b2a5797fa330b8688000b53adfc6e7c79c37 (diff)
downloadflatbuffers-e58c182443ac53c317c12fc8b4017d7816576a3d.tar.gz
flatbuffers-e58c182443ac53c317c12fc8b4017d7816576a3d.tar.bz2
flatbuffers-e58c182443ac53c317c12fc8b4017d7816576a3d.zip
Add --require-explicit-ids to require explicit ids (#6277)
* Add --require-explicit-ids to require explicit ids We just got bit by a well intentioned developer forgetting that field order by default is the field index. 3 people missed it in review. I'm looking at ways to make it harder to mess up. We are requesting that developers explicitly id all fields in tables. Automatic (opt in for others) enforcement of this will help the effort succeed. This patch adds a command line flag which lets the user require ids on all fields in tables. * Added docs to Compiler.md as well
Diffstat (limited to 'docs')
-rw-r--r--docs/source/Compiler.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/source/Compiler.md b/docs/source/Compiler.md
index 4636428c..973c4116 100644
--- a/docs/source/Compiler.md
+++ b/docs/source/Compiler.md
@@ -218,6 +218,8 @@ Additional options:
- `--root-type T` : Select or override the default root_type.
+- `--require-explicit-ids` : When parsing schemas, require explicit ids (id: x).
+
- `--force-defaults` : Emit default values in binary output from JSON.
- `--force-empty` : When serializing from object API representation, force