Skip to content

Commit c51d4ee

Browse files
committed
Rename flags to enable field access order checking.
The aim of this change is to avoid naming collisions with other flags, particularly in financial domains where "order" is used frequently.
1 parent ce9d314 commit c51d4ee

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

Safe-Flyweight-Usage.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,16 @@ When decoding, failure to follow the contract can result in the misinterpretatio
1212

1313
SBE can generate runtime checks that ensure the correct usage of flyweight encoders/decoders/codecs (w.r.t. field access order) in Java, C++ and C#.
1414

15-
To generate these runtime checks, pass `-Dsbe.generate.access.order.checks=true` when running the SBE tool.
15+
To generate these runtime checks, pass `-Dsbe.generate.sequencing.checks=true` when running the SBE tool.
1616

1717
By default, the generated checks are disabled, using conditional compilation, as they have a significant performance overhead.
1818
We expect that teams will enable these runtime checks in non-production environments and in their tests.
1919

2020
To enable the runtime checks:
2121

22-
* In Java, set the `sbe.generate.access.order.checks` system property to `true`.
23-
* In C++, define the `ENABLE_ACCESS_ORDER_CHECKS` symbol when compiling.
24-
* In C#, define the `ENABLE_ACCESS_ORDER_CHECKS` symbol when building.
22+
* In Java, set the `sbe.enable.sequencing.checks` system property to `true`.
23+
* In C++, define the `SBE_ENABLE_SEQUENCING_CHECKS` symbol when compiling.
24+
* In C#, define the `SBE_ENABLE_SEQUENCING_CHECKS` symbol when building.
2525

2626
### Checking complete encoding
2727

0 commit comments

Comments
 (0)