Skip to content

Commit c68ca96

Browse files
committed
ExternalDependencies: Make the tock-registers section a bit more generic, now that we're up to 4 crates.
1 parent f982179 commit c68ca96

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

doc/ExternalDependencies.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ External Dependencies
1717
* [Capsule Crate-Specific External Dependencies](#capsule-crate-specific-external-dependencies)
1818
* [Core Kernel External Dependencies](#core-kernel-external-dependencies)
1919
+ [Approved Exceptions for Core Kernel External Dependencies](#approved-exceptions-for-core-kernel-external-dependencies)
20-
- [**tock-registers** and **tock-registers-macros**](#tock-registers-and-tock-registers-macros)
20+
- [**tock-registers**](#tock-registers)
2121
- [**flux-rs**](#flux-rs)
2222
- [Including the Dependency](#including-the-dependency)
2323
* [Including Capsule Crate-Specific External Dependencies](#including-capsule-crate-specific-external-dependencies)
@@ -210,12 +210,12 @@ crates. All exceptions will be considered independently.
210210

211211
#### Approved Exceptions for Core Kernel External Dependencies
212212

213-
##### **tock-registers** and **tock-registers-macros**
214-
`tock-registers` provides an interface for using MMIO registers which is
215-
extensively used in `chips/` crates.
213+
##### **tock-registers**
214+
The `tock-registers` crates provide an interface for using MMIO registers which
215+
is extensively used in `chips/` crates.
216216

217217
- **Repository:** https://github.com/tock/tock-registers
218-
- **Justification:** This crate has moved to an external dependency to
218+
- **Justification:** This project has moved to an external dependency to
219219
encourage its development and use in projects beyond Tock. Specifically, the
220220
benefits of development in a separate repository include:
221221
1. Encouraging more rigorous backwards compatibility considerations for
@@ -234,17 +234,17 @@ extensively used in `chips/` crates.
234234
repository makes it clear it is a standalone project and can be developed
235235
independently of Tock. This should help contributions that benefit
236236
tock-registers but not necessarily Tock as well.
237-
- **Dependencies:** `tock-registers-macros` may have dev-dependencies on
237+
- **Dependencies:** `tock-registers` crates may have dev-dependencies on
238238
external crates to support unit testing, as those dev-dependencies are not
239-
included in a Tock kernel build. Additionally, `tock-registers-macros` may
239+
included in a Tock kernel build. Additionally, `tock-registers` crates may
240240
depend on the `syn`, `quote`, and `proc-macro2` crates for the following
241241
reasons:
242242
1. **Important functionality:** Procedural macros need to parse nontrivial
243243
Rust code and generate nontrivial Rust code, and `syn` and `quote` provide
244-
that functionality. For us to implement that ourself — and maintain it as
245-
the Rust language evolves — would require considerable effort. `quote` has
246-
a hard dependency on `proc-macro2`, which is also useful to support
247-
`tock-registers-macros`' unit tests, so that is included as well.
244+
that functionality. It would require considerable effort for us to
245+
implement and maintain that ourselves. `quote` has a hard dependency on
246+
`proc-macro2`, which is also useful to support the procedural macros' unit
247+
tests, so that is included as well.
248248
2. **Project maturity:** These crates are core Rust ecosystem mechanisms, and
249249
have been stable for years. All three crates are in the top 10
250250
all-time-most-downloaded crates on crates.io.

0 commit comments

Comments
 (0)