Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Document Code Review Principles #3596

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Aug 29, 2023
Merged

Document Code Review Principles #3596

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6ed88a3
doc: outline code review principles
bradjc Aug 7, 2023
9e67fb0
doc: code review updates
bradjc Aug 9, 2023
0185fe8
doc: code review
bradjc Aug 18, 2023
0fceb7d
doc: code review minor fixes
bradjc Aug 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
doc: code review 
Updates from PR.

Co-authored-by: Pat Pannuto <[email protected]>
  • Loading branch information
@bradjc @ppannuto
bradjc and ppannuto authored Aug 18, 2023
commit 0185fe85f684aae50e9b71809732fb131665541a
17 changes: 12 additions & 5 deletions doc/CodeReview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,8 +241,9 @@ review principles that will be used when evaluating pull requests.
reference other modules and setup exports. Actual OS logic should be in
descriptively named files.
- `static_init!()` (and similar) must only be called from board crates.
- Is any new functionality both publicly exported and harmful to overall safety
(not just correctness) if called at the wrong time? If so, this should likely
- Is any new functionality both publicly exported and have invariants which
cannot be enforced by the type system or other automated means (e.g., they
provide access to sensitive core kernel data structures). If so, this should likely
be guarded with a capability.
- Uses of `#inline` directives should explain why they are needed.

Expand Down Expand Up @@ -308,8 +309,10 @@ Virtualizers multiplex an underlying resource for multiple users.

Syscall drivers implement `SyscallDriver` to provide interfaces for userspace.

- These drivers must support multiple processes. They do not need to be fully
virtualized, but they must not break if multiple processes use them.
- These drivers must support potential calls from multiple processes. They do
not need to be fully virtualized, e.g. a driver which rejects syscalls from all
but the first process to access it is acceptable, but drivers must not break if
multiple processes attempt access.
- They must return `CommandReturn::SUCCESS` for `command_id==0`.
- They should use the first argument to any upcalls as a ReturnCode.
- They should only provide an interface to userspace on top of some resource,
Expand All @@ -324,7 +327,8 @@ the code.

Files in a chip crate should avoid giving the impression of functionality which
is not actually implemented. This means avoiding peripheral files which only
contain registers, or returning `ErrorCode::NOSUPPORT`.
contain registers or return `ErrorCode::NOSUPPORT` for all methods. A peripheral
must implement at least basic functionality to be merged in mainline Tock.

Chip crates should be properly named. Many chips use nested crates to represent
families of chips and to share implementations.
Expand All @@ -335,6 +339,9 @@ likely documented in a datashet, chip-variant configs may be used. They should
be contained to a single file (i.e. not scattered throughout the crate). It
should be entirely unambiguous whether a feature is set or not (i.e. it should
be based on physical hardware where it is obvious which chip a user has).
Generally, this means `cfg` directives should be an explicit list of chips or'd
together. Rarely, if ever, is a `cfg(not ...)` the correct approach for anything
outside of unit tests.

#### Boards

Expand Down