chore: fix W:useless-whatis-entry lintian warnings - #8728
Conversation
|
Can you show me an example of the output before and after this |
6e1943e to
8c456eb
Compare
|
Updated commit message. |
sithlord48
left a comment
sithlord48
left a comment
There was a problem hiding this comment.
This is pretty much the CMAKE_PROJECT_DESCRIPTION that is just a few lines down. Instead of repeating the Description for the project we put something else that is more descriptive for each of the executables
|
Next steps? |
|
I would like to see if we can come up with better descriptions then just reusing the project description to describe each application. |
|
@kenhys Any interest in improving your PR? |
By default, help2man generates "manual page for foobar" for manual files. It is useless because there is no addtional information which explains what deskflow is. With --name option, .SH NAME section will be set correctly. Before: .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. .TH DESKFLOW-CLIENT "1" "June 2025" "deskflow-client v1.22.0.109, protocol v1.8" "User Commands" .SH NAME deskflow-client \- manual page for deskflow-client v1.22.0.109, protocol v1.8 .SH SYNOPSIS .B deskflow-client [\fI\,OPTIONS\/\fR] .SH DESCRIPTION After: .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. .TH DESKFLOW-CLIENT "1" "July 2025" "deskflow-client v1.22.0.109, protocol v1.8" "User Commands" .SH NAME deskflow-client \- Keyboard and mouse sharing utility (Client) .SH SYNOPSIS .B deskflow-client [\fI\,OPTIONS\/\fR] .SH DESCRIPTION Signed-off-by: Kentaro Hayashi <[email protected]>
8c456eb to
ff79830
Compare
There was a problem hiding this comment.
I don't think this is the best description but its at least using the cmake project description for the string now (and not a new duplicated string). While not ideal i think its a good start If we think of better descriptive strings we can improve them later on.
3 participants
By default, help2man generates "manual page for foobar" for manual files.
It is useless because there is no addtional information which explains what deskflow is.
With --name option, .SH NAME section will be set correctly.
Before:
After: