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

avrdude documentation improvement #1674

Open
mcuee opened this issue Feb 7, 2024 · 5 comments
Open

avrdude documentation improvement #1674

mcuee opened this issue Feb 7, 2024 · 5 comments
Labels
documentation Improvements or additions to documentation

Comments

@mcuee
Copy link
Collaborator

mcuee commented Feb 7, 2024

https://avrdudes.github.io/avrdude/7.3/avrdude.html

Some of the information are a bit outdated.

  1. Windows installation -- maybe we want to point to the Wiki. We do not really recommend using Cygwin. We do not really support MinGW.org now (website down) but rather MSYS2 mingw project.
    https://avrdudes.github.io/avrdude/7.3/avrdude_34.html#Windows-Installation

  2. Windows Configuration File Location -- I guess we can forget about 16bit Windows NT now. avrdude only works under Windows 7 and later.
    https://avrdudes.github.io/avrdude/7.3/avrdude_37.html#Windows-Configuration-File-Location

  3. Windows port name -- no more parallel port support.
    https://avrdudes.github.io/avrdude/7.3/avrdude_39.html#Serial-Ports --> not so sure we want to mention libserialport improvement (only for MinGW build).
    https://avrdudes.github.io/avrdude/7.3/avrdude_40.html#Parallel-Ports

  4. We need to remove Windows Parallel Port info here as well.
    https://avrdudes.github.io/avrdude/7.3/avrdude_4.html#Option-Descriptions

@mcuee mcuee added the documentation Improvements or additions to documentation label Feb 7, 2024
@mcuee
Copy link
Collaborator Author

mcuee commented Feb 7, 2024

Status: Done. PR #1689 merged.


I think some of the info below about serialupdi needs updates as well.
https://avrdudes.github.io/avrdude/7.3/avrdude_21.html#SerialUPDI-Programmer

@dbuchwald
Would you be able to help here? Thanks.

@mcuee mcuee changed the title AVR Documentation Improvement avrdude documentation improvement Feb 7, 2024
@mcuee
Copy link
Collaborator Author

mcuee commented Feb 7, 2024

More documentation update

From @stefanrueger

I still think it would be wonderful if we had a short section in the .pdf/.html documentation about (current) limitations.

I have documented the knows limitations here and I just did some updates to list down the issues I know of.
https://github.com/avrdudes/avrdude/wiki/Known-limitations-of-avrdude

FAQ page may need some updates.
https://github.com/avrdudes/avrdude/wiki/FAQ

@dbuchwald
Copy link
Contributor

Sorry, took me a while, but you can find updates to SerialUPDI documentation in PR #1689

@mcuee
Copy link
Collaborator Author

mcuee commented Feb 16, 2024

Sorry, took me a while, but you can find updates to SerialUPDI documentation in PR #1689

You are very fast already. Thanks.
PR #1689 looks good to me.

@mcuee
Copy link
Collaborator Author

mcuee commented Feb 23, 2024

I think some of the info below about serialupdi needs updates as well. https://avrdudes.github.io/avrdude/7.3/avrdude_21.html#SerialUPDI-Programmer

@dbuchwald Would you be able to help here? Thanks.

Done. PR #1689 has been merged.

@mcuee mcuee pinned this issue Mar 17, 2024
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
Projects
None yet
Development

No branches or pull requests

2 participants