docs: code style updates #2797
docs: code style updates #2797
Conversation
battlmonstr
requested review from
chfast,
JacekGlen,
canepat,
Sixtysixter,
yperbasis,
bzawisto and
lupin012
|
|
||
| ### P30 tx vs txn naming | ||
|
|
||
| Use "txn", "txns" abbreviations for Ethereum transactions. |
There was a problem hiding this comment.
Just a comment, not complain: evmone uses tx for Ethereum transactions because it don't have db :). I think tx is uniformly used in all EVM work.
|
|
||
| Accepted styles: | ||
|
|
||
| ValidationResult execute_block( |
There was a problem hiding this comment.
Does clang-format is happy with both variants?
I think you can configure clang-format to have desired formatting but this likely requires putting the line length limit.
There was a problem hiding this comment.
Yes, this is the status quo.
I wanted to be stricter here, but we ended up fixating the status quo, because nobody was sure how to reconfigure clang-format. And in particular, people wanted to have a clear separation of the function signature from the body. E.g. in Go/Swift/Rust style it is possible to have the closing ) { on a separate line, and even have a comma after the last argument.
|
|
||
| ### P25 license boilerplate | ||
|
|
||
| Use SPDX short form like in evmone: |
There was a problem hiding this comment.
Did we confirm we are OK to use the short form?
There was a problem hiding this comment.
Updates with decisions discussed and voted at the workshop meeting.
Andrew confirmed P25 changing to the SPDX short form Apache boilerplate (as in Linux kernel and evmone).