Skip to content

Commit 47de520

Browse files
committed
Update instructions
1 parent a10852b commit 47de520

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

AGENTS.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -74,10 +74,12 @@ Please follow it if you wish to contribute.
7474

7575
In practice this means:
7676

77-
- Indent with tabs.
77+
- Indent with tabs - not spaces.
7878
- Keep lines within ~80 columns.
79-
- Place braces and other formatting as in the kernel style.
80-
- Add a comment before any new function describing it, input variables, and return codes.
79+
- Place braces and other formatting as in the kernel style. However, if the
80+
basic block is a 1 liner, do not use curly braces for it.
81+
- Add a comment before any new function describing it, input variables, and
82+
return codes.
8183
- Comments within a function may be C++ style.
8284
- Do not do any whitespace adustment of existing code.
8385
- Keep existing function and variable names.
@@ -114,9 +116,11 @@ intended ordering.
114116
## Summary
115117

116118
- Build with `autoreconf`, `configure`, and `make`.
117-
- Run `make check` to execute the self-tests. (auparse tests are failing because of a mismatch in mapping uid to accounts. Igonore these.)
119+
- Run `make check` to execute the self-tests. (auparse tests are failing
120+
because of a mismatch in mapping uid to accounts. Igonore these.)
118121
- Follow Linux Kernel coding style (tabs, 80 columns).
119122
- Keep commit messages short and descriptive.
123+
- Always add comments to explain new code.
120124
- Maintain rule file organization as described in `rules/README-rules`.
121125

122126
These guidelines should help future contributors and automated tools

0 commit comments

Comments
 (0)