Skip to content

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add basic manual page #521

wants to merge 1 commit into from

Conversation

ottok
Copy link
Contributor

@ottok ottok commented Apr 12, 2025

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.

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.
@ccoVeille
Copy link

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

@ottok
Copy link
Contributor Author

ottok commented Apr 12, 2025

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 usql --help to generate a full man page worth of contents, feel free to copy code from https://salsa.debian.org/debian/debcraft/-/blob/main/Makefile?ref_type=heads#L28-40 to automate the man page maintenance.

@ccoVeille
Copy link

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.

@ottok
Copy link
Contributor Author

ottok commented Apr 12, 2025

This man page is planned to be included in upcoming Debian package of usql. Debian packaging draft visible at https://salsa.debian.org/go-team/packages/usql/-/merge_requests/1

@ccoVeille
Copy link

I assumed it was the reason behind this need 👍

@kenshaw
Copy link
Member

kenshaw commented Apr 12, 2025

@ottok appreciate the work, thanks. Please be aware that it's the release-19 branch that releases are currently being cut from. I'll review and merge, assuming everything is OK.

@ottok
Copy link
Contributor Author

ottok commented Apr 13, 2025

@ottok appreciate the work, thanks. Please be aware that it's the release-19 branch that releases are currently being cut from. I'll review and merge, assuming everything is OK.

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.

@kenshaw
Copy link
Member

kenshaw commented Apr 13, 2025

@ottok no need to retarget. I was just mentioning the branch as you mentioned you were rolling this into a Debian release.

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

Successfully merging this pull request may close these issues.

3 participants