Hi,
I would like to open a conversation about TF-M coding guidelinehttps://git.trustedfirmware.org/trusted-firmware-m.git/tree/docs/coding_guide.rst. I have these proposals:
* Change the rule of the 80 character column width: * Max 80 characters length. * Column length is max 80 character in first place, but there are exceptions when length could be MAX 120 character: * Degrades code understandability: short, obscured variable names; awkward line breaks * Maximum 1% of the lines can exceed 80 charter length. * Might remove this rule, because in many cases we are not complaint with it. For example PSA Crypto API:
o Order function parameters so that input params are before output params.
o https://git.trustedfirmware.org/trusted-firmware-m.git/tree/interface/includ...
I'm interested in your opinions! Other rules also can be revisited!
Tamas
For line length I’m following these rules for t_cose https://github.com/laurencelundblade/t_cose - All comments blocks are 80 columns or less - 2% of code lines can be over 80 columns (1% is too few) - No lines over 120 columns
I am much happier and think the code is much better by allowing 2% of code lines over 80 columns. I don’t have to make variable names short and obscure, break up if statements in unnatural places, break up for(;;) statements unnaturally and such.
LL
On Nov 18, 2019, at 8:31 AM, Tamas Ban Tamas.Ban@arm.com wrote:
Hi, I would like to open a conversation about TF-M coding guideline https://git.trustedfirmware.org/trusted-firmware-m.git/tree/docs/coding_guide.rst. I have these proposals: Change the rule of the 80 character column width: Max 80 characters length. Column length is max 80 character in first place, but there are exceptions when length could be MAX 120 character: Degrades code understandability: short, obscured variable names; awkward line breaks Maximum 1% of the lines can exceed 80 charter length. Might remove this rule, because in many cases we are not complaint with it. For example PSA Crypto API: o Order function parameters so that input params are before output params. o https://git.trustedfirmware.org/trusted-firmware-m.git/tree/interface/includ... https://git.trustedfirmware.org/trusted-firmware-m.git/tree/interface/include/psa/crypto.h I’m interested in your opinions! Other rules also can be revisited! Tamas
tf-m@lists.trustedfirmware.org