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

man-page: Fix logfile short option #1063

Merged
merged 2 commits into from
Aug 14, 2022
Merged

Conversation

sbngross
Copy link
Contributor

@sbngross sbngross commented Aug 11, 2022

man synopsis states [-n -logfile] option. Later on in avrdude.1 as well as in
main.c -l is used.
Also '-logfile' is no option alternative but a parameter.
This is a minor issue but still confusing when one uses / to search
through man pages.

Fixing this issue brought another one into light. As it is closely related put this fix on top of this one as agreed upon.

-- Always leave the code cleaner than you found it --

Signed-off-by: brutzzl3r s3b.gr0ss@gmail.com

man synopsis states [-n -logfile] option. Later on in avrdude.1 as well as in
main.c -l is used.
Also '-logfile' is no option alternative but a parameter.
This is a minor issue but still confusing when one uses / to search
through man pages.

-- Always leave the code cleaner than you found it --

Signed-off-by: brutzzl3r <s3b.gr0ss@gmail.com>
@mcuee mcuee added the documentation Improvements or additions to documentation label Aug 12, 2022
@stefanrueger
Copy link
Collaborator

Well spotted and thanks for reporting! I suggest merging this PR next time when two or three have bunched up.

`avrdude.1` is installed into `man` dir instead of its proper section
location.
This is due to the definition of `TYPE MAN` which points to
`<DATAROOT>/man` according to cmake docs.

Use `DESTINATION` and add proper section subdir.

This allows for `man -M <YOUR INSTALL dir>/share/man -w 1 avrdude` to succeed
instead of throwing `No manual entry for avrdude in section 1`

Signed-off-by: brutzzl3r <s3b.gr0ss@gmail.com>
@sbngross
Copy link
Contributor Author

Fixes #1064

@mcuee
Copy link
Collaborator

mcuee commented Aug 13, 2022

I can confirm that this pull requrst fixed #1064.

mcuee@UbuntuSwift3:~/build/avr/avrdude_sbn$ sudo cmake --build build_linux --target install
[ 91%] Built target libavrdude
[100%] Built target avrdude
Install the project...
-- Install configuration: "RelWithDebInfo"
-- Installing: /usr/local/bin/avrdude
-- Set runtime path of "/usr/local/bin/avrdude" to ""
-- Installing: /usr/local/lib/libavrdude.a
-- Installing: /usr/local/include/libavrdude.h
-- Installing: /usr/local/etc/avrdude.conf
-- Installing: /usr/local/share/man/man1/avrdude.1

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.

3 participants