Bug 279234 - databases/mysql80-client: can we install the man pages?
Summary: databases/mysql80-client: can we install the man pages?
Status: Open
Alias: None
Product: Ports & Packages
Classification: Unclassified
Component: Individual Port(s) (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Only Me
Assignee: Jochen Neumeister
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2024-05-22 20:18 UTC by Dan Langille
Modified: 2025-11-17 10:48 UTC (History)
4 users (show)

See Also:
bugzilla: maintainer-feedback? (joneum)


Attachments
patch for mysql80-server/files/patch-CMakeLists.txt (352 bytes, patch)
2025-06-24 12:51 UTC, Robert Schulze
no flags Details | Diff
remove @comment directives for man pages (1.55 KB, patch)
2025-11-14 16:06 UTC, Dan Langille
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Dan Langille freebsd_committer freebsd_triage 2024-05-22 20:18:25 UTC
With the update to 8.0.33 [1], the man pages previously installed by databases/mysql80-client are no longer available. One of my users asked me about this today. Queries on social media led to this PR.

I tried and failed by merely removing the @comment directives but that failed.

What is the problem we need to solve to get them into the next update please?


[1] https://cgit.freebsd.org/ports/commit/databases/mysql80-server/pkg-plist?id=9fd5647e0711e28ba4b5702815103dc8eaeb11c7
Comment 1 Dan Langille freebsd_committer freebsd_triage 2024-05-25 18:55:20 UTC
See also recently added databases/mysql84-client which has no man pages

https://cgit.freebsd.org/ports/tree/databases/mysql84-client/pkg-plist
Comment 2 Oleksii Samorukov freebsd_committer freebsd_triage 2024-07-31 14:14:03 UTC
Did some testing/troubleshooting

1. Man pages are in the source tree, so they were not removed by upstream
2. It seems that CMake is not picking up this target (why?), so they are not getting installed. 

Need more time to find the root cause, any help is welcome
Comment 3 Dan Langille freebsd_committer freebsd_triage 2024-07-31 15:42:27 UTC
(In reply to Oleksii Samorukov from comment #2)
I looked, tried to figure it out, and could not Looking at commit history, it was commit, which does not mention docs.

https://cgit.freebsd.org/ports/commit/databases/mysql80-client/pkg-plist?id=9fd5647e0711e28ba4b5702815103dc8eaeb11c7

That is what prompted me to try remove @comment

I fear it may be something deeper in the MySQL Makefiles which changed.
Comment 4 Oleksii Samorukov freebsd_committer freebsd_triage 2024-08-01 19:17:56 UTC
I fount the root cause, there is a patch added which removes man target. I will try to remove it and see how it goes
Comment 5 Dan Langille freebsd_committer freebsd_triage 2024-10-25 15:59:58 UTC
(In reply to Oleksii Samorukov from comment #4)
Did it work?
Comment 6 Dan Langille freebsd_committer freebsd_triage 2025-04-22 16:04:22 UTC
One day, maybe?
Comment 7 Robert Schulze 2025-06-24 12:51:24 UTC
Created attachment 261537 [details]
patch for mysql80-server/files/patch-CMakeLists.txt

The problem here is a patch for mysql80-server, it simply disables man pages.
The patch above re-enables manpages, afterwards the @comment-ed entries for share/man/man1 in pkg-plist for mysql80-client can be uncommented.
Comment 8 Oleksii Samorukov freebsd_committer freebsd_triage 2025-06-25 09:53:17 UTC
Not really. Mans are not rendered correctly by freebsd man. MariaDB fixed this already, but MySQL upstream seems to not
Comment 9 Robert Schulze 2025-06-25 10:56:12 UTC
(In reply to Oleksii Samorukov from comment #8)
This is wrong, you just have to install groff to view them. The server-side Makefile already has groff:run in USES.
Comment 10 Dan Langille freebsd_committer freebsd_triage 2025-07-28 22:07:39 UTC
(In reply to Robert Schulze from comment #7)
I tried the patch file (which doesn't create the file, it IS the file which goes in the files/ directory).

I failed

===> Checking for items in pkg-plist which are not in STAGEDIR
Error: Missing: share/man/man1/mysql.1.gz
Error: Missing: share/man/man1/mysql_config.1.gz
Error: Missing: share/man/man1/mysql_config_editor.1.gz
Error: Missing: share/man/man1/mysqladmin.1.gz
Error: Missing: share/man/man1/mysqlbinlog.1.gz
Error: Missing: share/man/man1/mysqlcheck.1.gz
Error: Missing: share/man/man1/mysqldump.1.gz
Error: Missing: share/man/man1/mysqlimport.1.gz
Error: Missing: share/man/man1/mysqlman.1.gz
Error: Missing: share/man/man1/mysqlpump.1.gz
Error: Missing: share/man/man1/mysqlshow.1.gz
Error: Missing: share/man/man1/mysqlslap.1.gz
===> Error: Plist issues found.
Comment 11 Dan Langille freebsd_committer freebsd_triage 2025-07-28 22:15:09 UTC
(In reply to Dan Langille from comment #10)

Oh wait, I did it wrong. That's a patch, as it clearly says, for mysql80-server

My apologies.

Now I have:

nobody@143R-dvl-FreeBSD:/usr/ports/databases/mysql80-client $ pkg info -l mysql80-client | grep man
	/usr/local/include/mysql/my_command.h
	/usr/local/share/man/man1/mysql.1.gz
	/usr/local/share/man/man1/mysql_config.1.gz
	/usr/local/share/man/man1/mysql_config_editor.1.gz
	/usr/local/share/man/man1/mysqladmin.1.gz
	/usr/local/share/man/man1/mysqlbinlog.1.gz
	/usr/local/share/man/man1/mysqlcheck.1.gz
	/usr/local/share/man/man1/mysqldump.1.gz
	/usr/local/share/man/man1/mysqlimport.1.gz
	/usr/local/share/man/man1/mysqlman.1.gz
	/usr/local/share/man/man1/mysqlpump.1.gz
	/usr/local/share/man/man1/mysqlshow.1.gz
	/usr/local/share/man/man1/mysqlslap.1.gz
nobody@143R-dvl-FreeBSD:/usr/ports/databases/mysql80-client $ 




nobody@143R-dvl-FreeBSD:/usr/ports/databases/mysql80-client $ ls /usr/local/share/man/man1/mysql*
/usr/local/share/man/man1/mysql.1.gz			/usr/local/share/man/man1/mysqladmin.1.gz		/usr/local/share/man/man1/mysqldump.1.gz		/usr/local/share/man/man1/mysqlpump.1.gz
/usr/local/share/man/man1/mysql_config.1.gz		/usr/local/share/man/man1/mysqlbinlog.1.gz		/usr/local/share/man/man1/mysqlimport.1.gz		/usr/local/share/man/man1/mysqlshow.1.gz
/usr/local/share/man/man1/mysql_config_editor.1.gz	/usr/local/share/man/man1/mysqlcheck.1.gz		/usr/local/share/man/man1/mysqlman.1.gz			/usr/local/share/man/man1/mysqlslap.1.gz


Anyone see a reason not to commit this?

We are long past maintainer timeout.
Comment 12 Jochen Neumeister freebsd_committer freebsd_triage 2025-08-26 10:43:57 UTC
(In reply to Dan Langille from comment #11)


Can you please create a patch for me, then I'll commit it.
Comment 13 Dan Langille freebsd_committer freebsd_triage 2025-08-26 12:52:08 UTC
(In reply to Jochen Neumeister from comment #12)

The attached patch supplied by Robert Schulze worked for me.  It installs to mysql80-server/files/patch-CMakeLists.txt
Comment 14 commit-hook freebsd_committer freebsd_triage 2025-09-20 13:29:43 UTC
A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/ports/commit/?id=c2a3355f8a0f8f3df742c44c3ac6d4d78addf6fa

commit c2a3355f8a0f8f3df742c44c3ac6d4d78addf6fa
Author:     Jochen Neumeister <joneum@FreeBSD.org>
AuthorDate: 2025-09-20 13:16:07 +0000
Commit:     Jochen Neumeister <joneum@FreeBSD.org>
CommitDate: 2025-09-20 13:28:38 +0000

    databases/mysql80-client: Fix man pages

    PR:     279234
    Sponsored by:   Netzkommune GmbH

 databases/mysql80-server/files/patch-CMakeLists.txt | 8 --------
 1 file changed, 8 deletions(-)
Comment 15 Dan Langille freebsd_committer freebsd_triage 2025-11-14 16:06:38 UTC
Created attachment 265415 [details]
remove @comment directives for man pages

I'm not seeing the fix here.

$ pkg info -l mysql80-client | grep man
	/usr/local/include/mysql/my_command.h
$ pkg info -x mysql
mysql80-client-8.0.44

I think the cause is the @comment directives:

$ grep man pkg-plist 
include/mysql/my_command.h
@comment share/man/man1/comp_err.1.gz
@comment share/man/man1/lz4_decompress.1.gz
@comment share/man/man1/mysql.1.gz
@comment share/man/man1/mysql_config.1.gz
@comment share/man/man1/mysql_config_editor.1.gz
@comment share/man/man1/mysqladmin.1.gz
@comment share/man/man1/mysqlbinlog.1.gz
@comment share/man/man1/mysqlcheck.1.gz
@comment share/man/man1/mysqldump.1.gz
@comment share/man/man1/mysqlimport.1.gz
@comment share/man/man1/mysqlman.1.gz
@comment share/man/man1/mysqlpump.1.gz
@comment share/man/man1/mysqlshow.1.gz
@comment share/man/man1/mysqlslap.1.gz
@comment share/man/man1/perror.1.gz
@comment share/man/man1/zlib_decompress.1.gz
Comment 16 Dan Langille freebsd_committer freebsd_triage 2025-11-14 16:08:22 UTC
and, FWIW, databases/mysql84-client also has no man pages:

$ pkg info -l mysql84-client | grep man
	/usr/local/include/mysql/my_command.h
Comment 17 Robert Schulze 2025-11-17 10:48:26 UTC
(In reply to Dan Langille from comment #15)
Yes, the commented entries in pkg-plist have to be uncommented to complete the fix. This is what I wrote in comment #7.