rfc7: amend C style recommendations #435
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Problem: the C section has subsections but the original whitespace oriented content is not in a subsection. Create a "whitespace" subsection.
Problem: we've adopted a defacto guideline that long parameter lists should be broken to one per line but it is not documented. Add this to RFC 7.
Problem: we have internalized an expectation that functions do not have side effects on error, but this is undocumented. Add this to RFC 7.
chu11
reviewed
Dec 2, 2024
Comment on lines
+70
to
+87
| 9. Long parameter lists in function declarations or calls SHOULD be broken | ||
| to one parameter per line, at the same indent level. Example: | ||
|
|
||
| .. code-block:: c | ||
|
|
||
| flux_future_t *flux_rpc (flux_t *h, | ||
| const char *topic, | ||
| const char *s, | ||
| uint32_t nodeid, | ||
| int flags); | ||
|
|
||
| .. code-block:: c | ||
|
|
||
| f = flux_rpc (h, | ||
| "service.do-something", | ||
| NULL, | ||
| FLUX_NODEID_ANY, | ||
| FLUX_RPC_RESPONSE); |
There was a problem hiding this comment.
little late to the party no this, but do we also want to add a similar thing for complex branch statements? i.e
if (foobar == 1
|| boobar > something
|| cow < 123434343)
...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem: we have organically adopted some project norms for C code that are not documented.
Update RFC 7.