Skip to content

Commit cb5becd

Browse files
hnj2lschuermann
authored andcommitted
tock-register-interface: remove warning about disabled offset tests
Removes warnings about disabled unit tests checking offsets and alignments on `make ci-travis` from tock-register-interface's README. These tests are indeed run on a `make ci-job-chips`. As referenced in here: tock/tock#2618 (comment)
1 parent 2a14cf8 commit cb5becd

File tree

1 file changed

+0
-30
lines changed

1 file changed

+0
-30
lines changed

libraries/tock-register-interface/README.md

Lines changed: 0 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -104,36 +104,6 @@ version = "0.4.x"
104104
features = ["no_std_unit_tests"]
105105
```
106106

107-
WARNING: For now, the **unit tests checking offsets and alignments are not yet
108-
run** on `make ci-travis`. This means that leaving an unintentional gap between
109-
registers will **not** be caught. Instead, the `register_structs` macro will
110-
generate a struct with invalid offsets without warning. Please follow the
111-
discussion on https://github.com/tock/tock/pull/1393.
112-
113-
For example, the following call to the macro:
114-
115-
```rust
116-
register_structs! {
117-
Registers {
118-
(0x000 => foo: ReadOnly<u8>),
119-
(0x008 => bar: ReadOnly<u8>),
120-
(0x009 => @END),
121-
}
122-
}
123-
```
124-
125-
will generate the following struct, even though there is an unintentional gap of
126-
4 bytes between addresses `0x004` (the end of register `foo`) and `0x008` (the
127-
intended beginning of register `bar`).
128-
129-
```rust
130-
#[repr(C)]
131-
struct Registers {
132-
foo: ReadOnly<u32>,
133-
bar: ReadOnly<u32>,
134-
}
135-
```
136-
137107
By default, the visibility of the generated structs and fields is private. You
138108
can make them public using the `pub` keyword, just before the struct name or the
139109
field identifier.

0 commit comments

Comments
 (0)