Discuss the usage of the `log` crate

Open
#344 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
rust

Research direction

Start by locating the book's existing logging guidance and check whether it discusses no_std environments or embedded handlers. Done means documenting that log works with no_std, can support RTT, semihosting, ITM, and UART, and explaining why supporting crates can defer output handling to the parent binary.

Written by the indexing model from the issue text.

Description

It would likely be good to point out in this book that log works in no_std environments, and can have handlers for RTT, semihosting, ITM, UART, etc.

Imho this is kind of important and isn't mentioned anywhere. It's much nicer for supporting crates to just use the log macro and allow the parent binary crate to determine how they should be printed.

Dominant language
No language data
Stars
1.3k
Forks
223
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from rust-embedded/book

All issues in rust-embedded/book

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.