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 for cherryd should explain what the program does #1617

Open
leggewie opened this issue Aug 5, 2017 · 3 comments
Open

man page for cherryd should explain what the program does #1617

leggewie opened this issue Aug 5, 2017 · 3 comments

Comments

@leggewie
Copy link

leggewie commented Aug 5, 2017

The man page should mention what the program actually does beyond what is already obvious. I came across the program via bash-completion since apparently it's been installed as a dependency to calibre. In other words, I had no idea what it's for (I still don't really know). I did "man cherryTAB" and then saw that cherryd is available on my system. Obviously, it's a daemon. And knowing it starts some kind of a web server still doesn't tell me what I might use it for. It would be nice to see this improved. Thanks.

@webknjaz
Copy link
Member

webknjaz commented Aug 5, 2017

cherryd is just a script for running apps written with CherryPy HTTP microframework.

@leggewie
Copy link
Author

leggewie commented Aug 5, 2017

OK. So what is your argument? That cherryd should not have a man page? Well, I disagree. And well, it does. Or that it doesn't matter what's written in there? I'd disagree again. Or that it's not the biggest fish to fry? I guess we can agree on that. It's a low-hanging, low-priority fruit.

@webknjaz
Copy link
Member

webknjaz commented Aug 5, 2017

I just explained to you what cherryd is. I didn't have time to write better response to you.

Regarding your concerns:

  1. That manpage has been generated a long time ago
  2. Current build process does not contain any steps to generate manpages
  3. I agree that this may (and should) be improved
  4. I'll investigate the possibility of keeping that manpage up-to-date, once I have time
  5. Given the lack of active maintainers/contributors I am not able to keep up with everything needing improvements, so I'd really appreciate any constructive advices/PRs. If you can add smth, do it.

P.S. calibre is used to vendor cherrypy, but several months ago they stopped relying on it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants