[MDEV-14130] InnoDB messages should not refer to the MySQL 5.7 manual Created: 2017-10-26  Updated: 2019-04-29  Resolved: 2019-04-29

Status: Closed
Project: MariaDB Server
Component/s: Documentation, Storage Engine - InnoDB
Affects Version/s: 10.2, 10.3
Fix Version/s: 10.2.24, 10.3.15, 10.4.5

Type: Bug Priority: Major
Reporter: Marko Mäkelä Assignee: Marko Mäkelä
Resolution: Fixed Votes: 1
Labels: documentation

Issue Links:
Blocks
is blocked by MDEV-13562 Documentation needed on downgrading f... Closed
Relates
relates to MDEV-12309 Test migration from MySQL 5.7 with na... Stalled

 Description   

InnoDB error log messages in MariaDB 10.2 and later should not refer to MySQL 5.7 documentation.
With MariaDB 10.0 and 10.1 it is a little more acceptable to point to the 5.6 documentation, because the features have not yet diverged that much yet.
The InnoDB source code in 10.2 contains the following links that must be replaced with links to the Knowledge Base:

http://dev.mysql.com/doc/refman/5.7/en/operating-system-error-codes.html (non-existing page!)
http://dev.mysql.com/doc/refman/5.7/en/innodb-file-format.html (only used in deprecation messages; we can simply remove this link)
http://dev.mysql.com/doc/refman/5.7/en/forcing-innodb-recovery.html
http://dev.mysql.com/doc/refman/5.7/en/innodb-troubleshooting.html
http://dev.mysql.com/doc/refman/5.7/en/innodb-troubleshooting-datadict.html
http://dev.mysql.com/doc/refman/5.7/en/error-creating-innodb.html
http://dev.mysql.com/doc/refman/5.7/en/innodb-foreign-key-constraints.html
http://dev.mysql.com/doc/refman/5.7/en/set-transaction.html
http://dev.mysql.com/doc/refman/5.7/en/innodb-parameters.html (should point to https://mariadb.com/kb/en/mariadb/xtradbinnodb-server-system-variables/ instead)
http://dev.mysql.com/doc/refman/5.7/en/upgrading.html
http://dev.mysql.com/doc/refman/5.7/en/upgrading-downgrading.html

We need the https://mariadb.com/kb/en/ equivalents of all the links, so that they can be replaced.
I guess that http://dev.mysql.com/doc/refman/5.7/en/ could be directly replaced with https://mariadb.com/kb/en/ or some InnoDB specific page.



 Comments   
Comment by Ian Gilfillan [ 2017-10-27 ]

http://dev.mysql.com/doc/refman/5.7/en/operating-system-error-codes.html
replaced by
https://mariadb.com/kb/en/library/operating-system-error-codes/

https://dev.mysql.com/doc/refman/5.7/en/innodb-file-format.html
replaced by
https://mariadb.com/kb/en/library/xtradbinnodb-file-format/
(MariaDB page is far less detailed, but sufficient in the context)

https://dev.mysql.com/doc/refman/5.7/en/forcing-innodb-recovery.html
replaced by
https://mariadb.com/kb/en/library/xtradbinnodb-recovery-modes/

https://dev.mysql.com/doc/refman/5.7/en/innodb-troubleshooting.html
no replacement yet

https://dev.mysql.com/doc/refman/5.7/en/innodb-troubleshooting-datadict.html
no replacement yet

https://dev.mysql.com/doc/refman/5.7/en/error-creating-innodb.html
no replacement yet

https://dev.mysql.com/doc/refman/5.7/en/innodb-foreign-key-constraints.html
replaced by
https://mariadb.com/kb/en/library/foreign-keys/
(needs some expansion)

https://dev.mysql.com/doc/refman/5.7/en/set-transaction.html
replaced by
https://mariadb.com/kb/en/library/set-transaction/

https://dev.mysql.com/doc/refman/5.7/en/innodb-parameters.html
replaced by
https://mariadb.com/kb/en/mariadb/xtradbinnodb-server-system-variables/ or
https://mariadb.com/kb/en/library/full-list-of-mariadb-options-system-and-status-variables/
(The former is just InnoDB system variables, the latter is all system and status variables, options (not just InnoDB). There is no exact equivalent listing only InnoDB status and system vars and options

http://dev.mysql.com/doc/refman/5.7/en/upgrading.html
replaced by
https://mariadb.com/kb/en/library/upgrading/

https://dev.mysql.com/doc/refman/5.7/en/upgrading-downgrading.html
no replacement yet

Comment by Marko Mäkelä [ 2018-01-10 ]

greenman, in MariaDB 10.2.13 I replaced the links for which you named replacements. The following remain for now:

dbug-package.html
innochecksum.html
innodb-troubleshooting.html
innodb-troubleshooting-datadict.html
error-creating-innodb.html
upgrading-downgrading.html

Comment by Ian Gilfillan [ 2018-12-03 ]

Also windows-symbolic-links.html

Comment by Ian Gilfillan [ 2018-12-28 ]

innochecksum.html -> https://mariadb.com/kb/en/library/innochecksum/

Comment by Kenneth Dyer (Inactive) [ 2019-01-10 ]

Replacements:

  • InnoDB Troubleshooting, we have the general category page here and the specific data dictionary page here.
  • Our pages on upgrading live here, the specific link would depend on the version in that category.

Otherwise:

  • There's currently no dedicated page on the dbug package, parts are covered in the Connector/C and on creating trace files.
  • There's no dedicated counterpart to `error-creating-innodb.html`.
  • According to this, we don't support downgrading, but you might want to link to it since it gives an overview of how to go about moving down a version.
Comment by Jacob Moorman (Inactive) [ 2019-04-25 ]

I've taken control of this ticket in consultation with Marko and Ian.

Comment by Marko Mäkelä [ 2019-04-29 ]

The windows-symbolic-links.html only appears in a source code comment, so we can ignore that one.
The message string that was referring to error-creating-innodb.html was never output. I removed it.

git grep -liw dev.mysql.com will still returns a number of references, including one in COPYING.thirdparty. Perhaps we can ignore the matches in mysql-test, but I think that the following should be reviewed, possibly as a separate bug, by jacob.moorman:

COPYING.thirdparty
Docs/README-wsrep
Docs/mysql.info
README.md
debian/additions/innotop/innotop
debian/additions/innotop/innotop.1
debian/additions/my.cnf
debian/additions/mysqlreport
mysys/stacktrace.c
scripts/fill_help_tables.sql
scripts/mysql_install_db.sh
scripts/wsrep_sst_mysqldump.sh
sql/ha_partition.cc
sql/signal_handler.cc
storage/oqgraph/ha_oqgraph.cc
storage/rocksdb/README
storage/rocksdb/ha_rocksdb.cc
storage/rocksdb/ha_rocksdb.h
storage/rocksdb/mysql-test/rocksdb/t/partition.test
storage/rocksdb/rdb_datadic.cc
storage/rocksdb/rdb_utils.h
support-files/my-huge.cnf.sh
support-files/my-innodb-heavy-4G.cnf.sh
support-files/my-large.cnf.sh
support-files/my-medium.cnf.sh
support-files/my-small.cnf.sh

Generated at Thu Feb 08 08:11:09 UTC 2024 using Jira 8.20.16#820016-sha1:9d11dbea5f4be3d4cc21f03a88dd11d8c8687422.