Remove CLI option true defaults to enable negation
@wrwg @davidiw @gregnazario @alinush
Per #5581 , DocGen CLI options defaulting to true prohibit negation.
Did you ensure that all existing instances of DocgenOptions still choose the same values as before?
@wrwg
Are you referring to instances in other files, like aptos-move/framework/src/aptos.rs? Here, I have not modified anything, so it looks like this:
build_options: BuildOptions {
with_srcs,
with_abis: true,
with_source_maps: false,
with_error_map: true,
named_addresses: Default::default(),
install_dir: None,
with_docs: true,
docgen_options: Some(DocgenOptions {
include_impl: true,
include_specs: true,
specs_inlined: false,
include_dep_diagram: false,
collapsed_sections: true,
landing_page_template: Some("doc_template/overview.md".to_string()),
references_file: Some("doc_template/references.md".to_string()),
}),
},
Would these also need to be updated?
Alternatively, if you could make it so the CLI accepts a negation modifier on an option that would rectify the problem too. The real issue here is that there seems to be no way in practice to negate the options that were defaulted to true, which I modified in the commit.
Is there something I'm missing here?
Did you ensure that all existing instances of DocgenOptions still choose the same values as before?
@wrwg
Are you referring to instances in other files, like
aptos-move/framework/src/aptos.rs? Here, I have not modified anything, so it looks like this:build_options: BuildOptions { with_srcs, with_abis: true, with_source_maps: false, with_error_map: true, named_addresses: Default::default(), install_dir: None, with_docs: true, docgen_options: Some(DocgenOptions { include_impl: true, include_specs: true, specs_inlined: false, include_dep_diagram: false, collapsed_sections: true, landing_page_template: Some("doc_template/overview.md".to_string()), references_file: Some("doc_template/references.md".to_string()), }), },Would these also need to be updated?
Alternatively, if you could make it so the CLI accepts a negation modifier on an option that would rectify the problem too. The real issue here is that there seems to be no way in practice to negate the options that were defaulted to true, which I modified in the commit.
Is there something I'm missing here?
Just want to be sure that there is no behavioral change but this case looks OK to me, so I think we are fine.
Forge is running suite compat on testnet_2d8b1b57553d869190f61df1aaf7f31a8fc19a7b ==> f732de99a5f59227628a2f0cbdee6e3afea6ff71
- Grafana dashboard (auto-refresh)
- Humio Logs
- Test runner output
- Test run is land-blocking
Forge is running suite land_blocking on f732de99a5f59227628a2f0cbdee6e3afea6ff71
- Grafana dashboard (auto-refresh)
- Humio Logs
- Test runner output
- Test run is land-blocking
:white_check_mark: Forge suite compat success on testnet_2d8b1b57553d869190f61df1aaf7f31a8fc19a7b ==> f732de99a5f59227628a2f0cbdee6e3afea6ff71
Compatibility test results for testnet_2d8b1b57553d869190f61df1aaf7f31a8fc19a7b ==> f732de99a5f59227628a2f0cbdee6e3afea6ff71 (PR)
1. Check liveness of validators at old version: testnet_2d8b1b57553d869190f61df1aaf7f31a8fc19a7b
compatibility::simple-validator-upgrade::liveness-check : 7606 TPS, 5134 ms latency, 7100 ms p99 latency,no expired txns
2. Upgrading first Validator to new version: f732de99a5f59227628a2f0cbdee6e3afea6ff71
compatibility::simple-validator-upgrade::single-validator-upgrade : 4672 TPS, 8449 ms latency, 11700 ms p99 latency,no expired txns
3. Upgrading rest of first batch to new version: f732de99a5f59227628a2f0cbdee6e3afea6ff71
compatibility::simple-validator-upgrade::half-validator-upgrade : 4812 TPS, 8554 ms latency, 11500 ms p99 latency,no expired txns
4. upgrading second batch to new version: f732de99a5f59227628a2f0cbdee6e3afea6ff71
compatibility::simple-validator-upgrade::rest-validator-upgrade : 6777 TPS, 5635 ms latency, 9300 ms p99 latency,no expired txns
5. check swarm health
Compatibility test for testnet_2d8b1b57553d869190f61df1aaf7f31a8fc19a7b ==> f732de99a5f59227628a2f0cbdee6e3afea6ff71 passed
Test Ok
- Grafana dashboard
- Humio Logs
- Test runner output
- Test run is land-blocking
:white_check_mark: Forge suite land_blocking success on f732de99a5f59227628a2f0cbdee6e3afea6ff71
performance benchmark with full nodes : 6620 TPS, 5871 ms latency, 25300 ms p99 latency,(!) expired 4370 out of 2831520 txns
Test Ok
- Grafana dashboard
- Humio Logs
- Test runner output
- Test run is land-blocking
Forge is running suite land_blocking on 911593435aa58a7b76f539fe4f09843deb40b262
- Grafana dashboard (auto-refresh)
- Humio Logs
- Test runner output
- Test run is land-blocking
Forge is running suite compat on testnet_2d8b1b57553d869190f61df1aaf7f31a8fc19a7b ==> 911593435aa58a7b76f539fe4f09843deb40b262
- Grafana dashboard (auto-refresh)
- Humio Logs
- Test runner output
- Test run is land-blocking
:white_check_mark: Forge suite land_blocking success on 911593435aa58a7b76f539fe4f09843deb40b262
performance benchmark with full nodes : 6601 TPS, 6018 ms latency, 8400 ms p99 latency,no expired txns
Test Ok
- Grafana dashboard
- Humio Logs
- Test runner output
- Test run is land-blocking
:white_check_mark: Forge suite compat success on testnet_2d8b1b57553d869190f61df1aaf7f31a8fc19a7b ==> 911593435aa58a7b76f539fe4f09843deb40b262
Compatibility test results for testnet_2d8b1b57553d869190f61df1aaf7f31a8fc19a7b ==> 911593435aa58a7b76f539fe4f09843deb40b262 (PR)
1. Check liveness of validators at old version: testnet_2d8b1b57553d869190f61df1aaf7f31a8fc19a7b
compatibility::simple-validator-upgrade::liveness-check : 7444 TPS, 5168 ms latency, 7500 ms p99 latency,no expired txns
2. Upgrading first Validator to new version: 911593435aa58a7b76f539fe4f09843deb40b262
compatibility::simple-validator-upgrade::single-validator-upgrade : 4581 TPS, 9073 ms latency, 11600 ms p99 latency,no expired txns
3. Upgrading rest of first batch to new version: 911593435aa58a7b76f539fe4f09843deb40b262
compatibility::simple-validator-upgrade::half-validator-upgrade : 4460 TPS, 8953 ms latency, 11800 ms p99 latency,no expired txns
4. upgrading second batch to new version: 911593435aa58a7b76f539fe4f09843deb40b262
compatibility::simple-validator-upgrade::rest-validator-upgrade : 6939 TPS, 5565 ms latency, 9800 ms p99 latency,no expired txns
5. check swarm health
Compatibility test for testnet_2d8b1b57553d869190f61df1aaf7f31a8fc19a7b ==> 911593435aa58a7b76f539fe4f09843deb40b262 passed
Test Ok
- Grafana dashboard
- Humio Logs
- Test runner output
- Test run is land-blocking