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

Use correct file locations in the documentation #1637

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ndim
Copy link
Contributor

@ndim ndim commented Jan 23, 2024

The avrdude documentation (avrdude.1 man page, avrdude.info page, html+pdf docs) contains references to file locations.

Some of those file locations have changed over time without the documentation completely reflecting those changes, and this PR wants to fix that.

Both automake and cmake builds install the documentation somewhere
in <prefix>/share/doc.

This fixes the former mention of <prefix>/doc in the avrdude.1 man page
FILES section.
@mcuee mcuee added the documentation Improvements or additions to documentation label Jan 24, 2024
@stefanrueger
Copy link
Collaborator

@ndim Thanks for looking carefully through the source and matching that with the documentation. Do you want to further progress this PR? I'd be happy to merge this in its current state.

@ndim
Copy link
Contributor Author

ndim commented Jan 28, 2024

At this time, this only fixes a single place. That one commit does not depend on anything and can therefore be cherry-picked or merged immediately for 7.3.

There is still the main 95% of the work to be done, and I do plan on doing that work, but that will take me several weeks at the minimum, aiming for the next release after 7.3.

@mcuee mcuee added this to the AVRDUDE 7.4 milestone Feb 24, 2024
@mcuee mcuee removed this from the AVRDUDE 7.4 milestone May 20, 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

Successfully merging this pull request may close these issues.

None yet

3 participants