-
Notifications
You must be signed in to change notification settings - Fork 363
Add basic manual page #521
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
base: master
Are you sure you want to change the base?
Conversation
Create a minimal manual page for Linux/Unix systems. Also improve the README to be explicit about increasingly more popular MySQL alternatives MariaDB and TiDB.
While I understand the need, I'm a bit worried about the maintenance that this man file would require. I would like to see the generation of this file being added to the Makefile or the CI |
I did the initial version with help2man, but it isn't complete enough. Thus this man page cannot be generated automatically right now. If you later decide to expand the output of |
I'm a simple reviewer here. A random Gopher, using the tool. I shared my concern, your reply is clear and documented. I like that. Let's wait for a maintainer feedbacks. |
This man page is planned to be included in upcoming Debian package of |
I assumed it was the reason behind this need 👍 |
@ottok appreciate the work, thanks. Please be aware that it's the |
The PR targets the default branch in this repository. I am happy to change target branch, rebase and polish as many time as needed once you have feedback. |
@ottok no need to retarget. I was just mentioning the branch as you mentioned you were rolling this into a Debian release. |
Create a minimal manual page for Linux/Unix systems. Also improve the README to be explicit about increasingly more popular MySQL alternatives MariaDB and TiDB.