[CONC-293] Add mysql_config and mariadb_config man page Created: 2017-11-08  Updated: 2019-03-04

Status: Open
Project: MariaDB Connector/C
Component/s: None
Affects Version/s: 3.0.2
Fix Version/s: None

Type: Task Priority: Major
Reporter: Michal Schorm Assignee: Georg Richter
Resolution: Unresolved Votes: 0
Labels: None
Environment:

Fedora - all



 Description   

If the C/C is build separately, no man page for the config binaries is provided to be packed.



 Comments   
Comment by Michal Schorm [ 2019-03-04 ]

The importance of the issue grows for me.
Now the time comes to have it fixed, or I would have to decide how to address it with a workaround.

The binary is shipped by CONC/C, so I'd expect to have the manual page packed with it.

What may be for you simple move / copy of the manpage form the server, for me means adding it as a new sources to the CONC/C RPM, since it have a standalone (downstrem) git repository. I'd have to check for changes or update of the file and if greater change would come, I'd have make an unnecessary asynchronous release for the CONC/C just because the manpage changed in server.

I'd be happy to debate with you on the possible solutions to satisfy both your use cases and downstream ones.

  • I expect you want to build and ship server and client without CONC/C - in that case the manpage has to be included where it is now.
  • I need to build the server and client on top of CONC/C, but also have standalone CONC/C available - in such case I need a copy here.

Also I don't want to duplicate the stuff I ship - so if I build with CONC/C, I won't ship "mariadb_config" in the server. I'll just add it as a dependency. Same it is with header files - the client ones are only shipped by CONC/C, I can install both server devel and CONC/C devel packages and the won't overlap.

Comment by Georg Richter [ 2019-03-04 ]

Hi Michael,

currently we don't provide man pages for Connector/C, but we're working on it:
A few months ago we moved the documentation to Connector/C's github wiki with the goal to be able to export documentation in several formats (including man page) but also to update and sync documentation on MariaDB Knowledge base.

I can't promise it, but we will try to get it done for the next 10.4 and C/C 3.1 release.

Comment by Michal Schorm [ 2019-03-04 ]

Okay,
thanks for the status update.

That gives me a good hope I won't need to keep the file ripped out of the server sources for a long time

Generated at Thu Feb 08 03:04:16 UTC 2024 using Jira 8.20.16#820016-sha1:9d11dbea5f4be3d4cc21f03a88dd11d8c8687422.