Add log format documentation to the book #785
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Just mention that it can be passed as |
|
|
||
| There are several metadata specifiers available that can be used in a format string. | ||
|
|
||
| #### Log - `{s}` |
There was a problem hiding this comment.
Suggested change
| #### Log - `{s}` | |
| ### Log - `{s}` |
I think a 3-# heading is correct here?
There was a problem hiding this comment.
I think I made these level-4 intentionally because it looks better in the book.
| } | ||
| ``` | ||
|
|
||
| #### Timestamp - `{t}` |
There was a problem hiding this comment.
I think #789 means we need some more entries in here now?
There was a problem hiding this comment.
Not really, the {t} specifier prints whatever defmt::timestamp! prints
|
This looks great, thank you so much! Just a couple of minor notes. |
Co-authored-by: Jonathan Pallant <jonathan.pallant@ferrous-systems.com>
Urhengulas
force-pushed
the
log-format-book
branch
from
308378d to
b3adcd6
Compare
Urhengulas
approved these changes
Jan 10, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a chapter to the
defmtbook about customizing logs using the log format functionality. This PR shouldn't be merged until #783 is merged.