Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

pico-sdk documentation issues #283

Closed
pingufreak opened this issue Oct 15, 2022 · 5 comments
Closed

pico-sdk documentation issues #283

pingufreak opened this issue Oct 15, 2022 · 5 comments
Labels
documentation Improvements or additions to documentation pdf

Comments

@pingufreak
Copy link

Hello together,

I'm currently going through the pico-sdk documentation and I've notice some really basic faults. For example in chaper 1.2. Anatomy of a SDK Application "int main()" is mentioned with a PICO_DEFAULT_LED_PIN macro. The main method main() must return an int. Else some strange behaviours can appear (for example the internals of the uC does wait for an int... , the usb serial output will not work, putty will crash!).

Where can I contribute to improve the documentation? If I find other issues, I would like to send updates.

Thank you!

Kind regards,

pingu

@lurch
Copy link
Contributor

lurch commented Oct 15, 2022

Where can I contribute to improve the documentation? If I find other issues, I would like to send updates.

The source of the documentation isn't public, but please report any updates or corrections by opening issues at https://github.com/raspberrypi/pico-feedback/
Thanks.

P.S. Did you read the parts where it says "It’s quite common for the main() function not to return, as is shown here." and "The return code of main() is ignored by the SDK runtime, and the default behaviour is to hang the processor on exit." ?

@pingufreak
Copy link
Author

Thank you for the fast answer! I will report there then. I've read this, but it seems that usb-serial is not working properly if main doesn't returns something.

@lurch
Copy link
Contributor

lurch commented Oct 15, 2022

Could you provide more details about "usb-serial is not working properly"? Are you perhaps running into the same "problem" I described here? If so, you might want to try increasing PICO_STDIO_USB_CONNECT_WAIT_TIMEOUT_MS (or set it to -1).

@aallan aallan transferred this issue from raspberrypi/pico-sdk Oct 16, 2022
@aallan aallan added documentation Improvements or additions to documentation pdf labels Oct 16, 2022
@aallan
Copy link
Contributor

aallan commented Oct 16, 2022

Transferred from pico-sdk

@aallan aallan added waiting for external comment Waiting for comment from third-party idle No activity on Issue, will close after 7 days unless a reply is recieved. labels Nov 5, 2022
@aallan
Copy link
Contributor

aallan commented Mar 2, 2023

Closing after no response from OP.

@aallan aallan closed this as completed Mar 2, 2023
@aallan aallan removed waiting for external comment Waiting for comment from third-party idle No activity on Issue, will close after 7 days unless a reply is recieved. labels Mar 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation pdf
Projects
None yet
Development

No branches or pull requests

3 participants