Skip to content

Commit 9318c6c

Browse files
committed
Update Evolution doc
1 parent df287ee commit 9318c6c

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

docs/source/evolution.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -253,3 +253,24 @@ your schema changes have been committed, ensuring consistency with the rest of
253253
the world. If this is not practical for you, use explicit field `id`s, which
254254
should always generate a merge conflict if two people try to allocate the same
255255
id.
256+
257+
## Checking Conformity
258+
259+
To check that schema are properly evolved, the [`flatc`](flatc.md) compiler has
260+
a [option](flatc.md#additional-options) to do just that:
261+
262+
```sh
263+
--conform FILE
264+
```
265+
266+
Where `FILE` is the base schema the rest of the input schemas must evolve from.
267+
It returns `0` if they are properly evolved, otherwise returns a non-zero value
268+
and provides errors on the reason why the schema are not properly evolved.
269+
270+
As an example, the following checks if `schema_v2.fbs` is properly evolved from
271+
`schema_v1.fbs`.
272+
273+
```sh
274+
flatc --conform schema_v1.fbs schema_v2.fbs
275+
```
276+

0 commit comments

Comments
 (0)