docs(cc_raspberry_pi): Better phrasing of config descriptions#6488
Conversation
Signed-off-by: paulober <paul.oberosler@raspberrypi.com>
github-actions
Bot
added
the
documentation
| This example will enable the serial console on Raspberry Pi 5 | ||
| while disabling the UART hardware (only Pi 5 allows this combination). |
There was a problem hiding this comment.
Perhaps it's worth mentioning that (IIRC) this is because Pi 5 runs the serial console on a separate UART? (the one between the microHDMI ports)
There was a problem hiding this comment.
Hrm the example3 provided has the hardware: false and console: true yet the runtime code automatically resets enable_hw = True. Am I misreading the docs or the runtime behavior?
There was a problem hiding this comment.
@blackboxsw You're right but it should only automatically enable hw if the platform is not a Pi 5 as the comment and the docs state:
There was a problem hiding this comment.
Oops ok I inverted the logic and missed the not. Looks good thank you.
blackboxsw
left a comment
blackboxsw
left a comment
There was a problem hiding this comment.
Thanks for the clarification @paulober LGTM
| This example will enable the serial console on Raspberry Pi 5 | ||
| while disabling the UART hardware (only Pi 5 allows this combination). |
There was a problem hiding this comment.
Oops ok I inverted the logic and missed the not. Looks good thank you.
…cal#6488) Signed-off-by: paulober <paul.oberosler@raspberrypi.com>
Signed-off-by: paulober <paul.oberosler@raspberrypi.com>
3 participants
Proposed Commit Message
Merge type
@tdewey-rpi @lurch