Skip to content

Commit

Permalink
MDEV-22023 Update man pages titles to say MariaDB instead of MySQL
Browse files Browse the repository at this point in the history
When reading the man page of e.g. 'mysql' on a system with MariaDB
installed one would actually see the man page of 'mariadb'. However the
man page had no indication of the page being for 'mariadb', which was
confusing for users.

Fix this by updating the man page title lines to use mariadb-* instead
of mysql* for MariaDB binaries that are drop-in replacements for MySQL
equivalents, indicating that the commands are actually of the MariaDB
version.

In long term, all the commands in man pages should be replaced by their
MariaDB counterparts. Update the title lines as a start, and only those
that exist as symlinks to their MariaDB counterparts.

Before:

    man mariadb-upgrade | head -n 1
    MYSQL_UPGRADE(1) ...

After:

    man mariadb-upgrade | head -n 1
    MARIADB-UPGRADE(1) ...

All new code of the whole pull request, including one or several files
that are either new files or modified ones, are contributed under the
BSD-new license. I am contributing on behalf of my employer Amazon Web
Services, Inc.
  • Loading branch information
PhysicsTing authored and grooverdan committed May 23, 2022
1 parent a0f0687 commit 3dd3dcc
Show file tree
Hide file tree
Showing 28 changed files with 28 additions and 28 deletions.
2 changes: 1 addition & 1 deletion man/mysql.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
'\" t
.\"
.TH "\FBMYSQL\FR" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.TH "\FBMARIADB\FR" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion man/mysql_client_test.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
'\" t
.\"
.TH "\FBMYSQL_CLIENT_TEST" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.TH "\FBMARIADB-CLIENT-TEST" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion man/mysql_convert_table_format.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
'\" t
.\"
.TH "\FBMYSQL_CONVERT_TAB" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.TH "\FBMARIADB-CONVERT-TAB" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion man/mysql_find_rows.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
'\" t
.\"
.TH "\FBMYSQL_FIND_ROWS\F" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.TH "\FBMARIADB-FIND-ROWS\F" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion man/mysql_fix_extensions.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
'\" t
.\"
.TH "\FBMYSQL_FIX_EXTENSI" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.TH "\FBMARIADB-FIX-EXTENSI" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion man/mysql_install_db.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
'\" t
.\"
.TH "\FBMYSQL_INSTALL_DB\FR" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.TH "\FBMARIADB-INSTALL-DB\FR" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion man/mysql_ldb.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
'\" t
.\"
.TH "\FBMYSQL_LDB\FR" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.TH "\FBMARIADB-LDB\FR" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion man/mysql_plugin.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
'\" t
.\"
.TH "\FBMYSQL_PLUGIN\FR" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.TH "\FBMARIADB-PLUGIN\FR" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion man/mysql_secure_installation.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
'\" t
.\"
.TH "\FBMYSQL_SECURE_INST" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.TH "\FBMARIADB-SECURE-INST" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion man/mysql_setpermission.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
'\" t
.\"
.TH "\FBMYSQL_SETPERMISSI" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.TH "\FBMARIADB-SETPERMISSI" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion man/mysql_tzinfo_to_sql.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
'\" t
.\"
.TH "\FBMYSQL_TZINFO_TO_S" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.TH "\FBMARIADB-TZINFO-TO-S" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion man/mysql_upgrade.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
'\" t
.\"
.TH "\FBMYSQL_UPGRADE\FR" "1" "20 July 2020" "MariaDB 10\&.5" "MariaDB Database System"
.TH "\FBMARIADB-UPGRADE\FR" "1" "20 July 2020" "MariaDB 10\&.5" "MariaDB Database System"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion man/mysql_waitpid.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
'\" t
.\"
.TH "\FBMYSQL_WAITPID\FR" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.TH "\FBMARIADB-WAITPID\FR" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion man/mysqlaccess.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
'\" t
.\"
.TH "\FBMYSQLACCESS\FR" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.TH "\FBMARIADB-ACCESS\FR" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion man/mysqladmin.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
'\" t
.\"
.TH "\FBMYSQLADMIN\FR" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.TH "\FBMARIADB-ADMIN\FR" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion man/mysqlbinlog.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
'\" t
.\"
.TH "\FBMYSQLBINLOG\FR" "1" "14 April 2021" "MariaDB 10\&.5" "MariaDB Database System"
.TH "\FBMARIADB-BINLOG\FR" "1" "14 April 2021" "MariaDB 10\&.5" "MariaDB Database System"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion man/mysqlcheck.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
'\" t
.\"
.TH "\FBMYSQLCHECK\FR" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.TH "\FBMARIADB-CHECK\FR" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion man/mysqld.8
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
'\" t
.\"
.TH "\FBMYSQLD\FR" "8" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.TH "\FBMARIADBD\FR" "8" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion man/mysqld_multi.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
'\" t
.\"
.TH "\FBMYSQLD_MULTI\FR" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.TH "\FBMARIADB-MULTI\FR" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion man/mysqld_safe.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
'\" t
.\"
.TH "\FBMYSQLD_SAFE\FR" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.TH "\FBMARIADB-SAFE\FR" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion man/mysqld_safe_helper.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
'\" t
.\"
.TH "\FBMYSQLD_SAFE_HELPER\FR" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.TH "\FBMARIADB-SAFE-HELPER\FR" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion man/mysqldump.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
'\" t
.\"
.TH "\FBMYSQLDUMP\FR" "1" "24 October 2020" "MariaDB 10\&.5" "MariaDB Database System"
.TH "\FBMARIADB-DUMP\FR" "1" "24 October 2020" "MariaDB 10\&.5" "MariaDB Database System"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion man/mysqldumpslow.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
'\" t
.\"
.TH "\FBMYSQLDUMPSLOW\FR" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.TH "\FBMARIADB-DUMPSLOW\FR" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion man/mysqlhotcopy.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
'\" t
.\"
.TH "\FBMYSQLHOTCOPY\FR" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.TH "\FBMARIADB-HOTCOPY\FR" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion man/mysqlimport.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
'\" t
.\"
.TH "\FBMYSQLIMPORT\FR" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.TH "\FBMARIADB-IMPORT\FR" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion man/mysqlshow.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
'\" t
.\"
.TH "\FBMYSQLSHOW\FR" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.TH "\FBMARIADB-SHOW\FR" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion man/mysqlslap.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
'\" t
.\"
.TH "\FBMYSQLSLAP\FR" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.TH "\FBMARIADB-SLAP\FR" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion man/mysqltest.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
'\" t
.\"
.TH "\FBMYSQLTEST\FR" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.TH "\FBMARIADB-TEST\FR" "1" "27 June 2019" "MariaDB 10\&.5" "MariaDB Database System"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
Expand Down

0 comments on commit 3dd3dcc

Please sign in to comment.