docs: clean up config docs #12296
docs: clean up config docs #12296
Conversation
onbjerg
requested review from
0xrusowsky,
DaniPopes,
grandizzy,
mattsse and
zerosnacks
as code owners
| /// Whether to print the names of the compiled contracts. | ||
| // todo(onbjerg): this seems unused. | ||
| pub names: bool, | ||
| /// Whether to print the sizes of the compiled contracts. | ||
| // todo(onbjerg): this seems unused. | ||
| pub sizes: bool, |
There was a problem hiding this comment.
These should not be unused; should correspond with the forge build --sizes / forge build --names / forge build --names --sizes flags
I am not sure if this ever worked
| // todo(onbjerg): this seems unused. | ||
| pub memory_limit: u64, |
There was a problem hiding this comment.
revm does allow configuring this and we are passing the value into it; must not be wired correctly
There was a problem hiding this comment.
it is, it goes through the serialize config->deserialize into evmopts dance
There was a problem hiding this comment.
actually it's broken but for a different reason, we set it correctly in cfg env #12299
| /// List of file paths to ignore. | ||
| // todo(onbjerg): how is this different from `skip`? | ||
| #[serde(rename = "ignored_warnings_from")] | ||
| pub ignored_file_paths: Vec<PathBuf>, |
There was a problem hiding this comment.
There was a problem hiding this comment.
needs test update https://github.com/foundry-rs/foundry/actions/runs/18835768742/job/53744380691?pr=12296#step:14:1513
and please update todos
Looking at the config struct, I noticed some fields seem to no longer be used, so I marked them as potential removal candidates. I also cleaned up some of the comments.
PR Checklist