Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

unclear coding standard examples #536

Open
yamt opened this issue Mar 11, 2020 · 4 comments
Open

unclear coding standard examples #536

yamt opened this issue Mar 11, 2020 · 4 comments
Labels
Area: Documentation Improvements or additions to documentation

Comments

@yamt
Copy link
Contributor

yamt commented Mar 11, 2020

NuttXCCodingStandard.html lists the following examples in both of "Preferred" and "Acceptable".

extern int g_someint;
static int g_anotherint;
@davids5
Copy link
Contributor

davids5 commented Mar 11, 2020

I think the problem is bigger then just this one.

Why do we have N ways? Acceptable, Discouraged, Correct, Preferred,

In the past if you choose to do it the any way other then Preferred, your contribution would be modified to be the Preferred way.

This sort of thing is what makes having or creating a formatting tool a complex mess for NO ADDED value.

Why not remove all the ambiguity from the fix the CS document and fix the tool?

@patacongo
Copy link
Contributor

We should carefully entertain any PR to modify the coding standard. Remember that the version in Confluence is NOT the master. The master is in the nuttx repository at Documents/NuttXCCCodingStandard.html and can be updated via PR as with any other file. The verion on Confluence is then a copy of that. Any changes made in Confluence will be lost the next time that the Documents are updated.

@davids5
Copy link
Contributor

davids5 commented Mar 11, 2020

@patacongo good to know - Should we add this note to the repo so that that never happens?

@patacongo
Copy link
Contributor

Should we add this note to the repo so that that never happens?

It is true of all of the documents under the documents tabs. These are only copies. The really should just be read-only

@patacongo patacongo added the Area: Documentation Improvements or additions to documentation label Mar 12, 2020
@protobits protobits changed the title unclear NuttXCCodingStandard examples unclear coding standard examples Mar 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants