Skip to content

Add basic manual page - #521

Open
ottok wants to merge 1 commit into
xo:mainfrom
ottok:man-page
Open

Add basic manual page#521
ottok wants to merge 1 commit into
xo:mainfrom
ottok:man-page

Conversation

@ottok

@ottok ottok commented Apr 12, 2025

Copy link
Copy Markdown
Contributor

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
Copy Markdown

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

ottok commented Apr 12, 2025

Copy link
Copy Markdown
Contributor Author

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
Copy Markdown

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

ottok commented Apr 12, 2025

Copy link
Copy Markdown
Contributor Author

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
Copy Markdown

I assumed it was the reason behind this need 👍

@kenshaw

kenshaw commented Apr 12, 2025

Copy link
Copy Markdown
Member

@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

ottok commented Apr 13, 2025

Copy link
Copy Markdown
Contributor Author

@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

kenshaw commented Apr 13, 2025

Copy link
Copy Markdown
Member

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

@ottok ottok mentioned this pull request Apr 24, 2025
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