Bug #114875 Keywords manual page mistake for added and removed keywords
Submitted: 3 May 2024 20:35 Modified: 4 May 2024 22:20
Reporter: Evan Elias Email Updates:
Status: Closed Impact on me:
None 
Category:MySQL Server: Documentation Severity:S3 (Non-critical)
Version:8.4.0 OS:Any
Assigned to: CPU Architecture:Any

[3 May 2024 20:35] Evan Elias
Description:
At https://dev.mysql.com/doc/refman/8.4/en/keywords.html#keywords-new-in-current-series , the manual says this is "keywords and reserved words that are added in MySQL 8.4, compared to MySQL 8.3". But really the list shown is relative to MySQL 5.7, not 8.3.

Same issue with the removed keyword section, https://dev.mysql.com/doc/refman/8.4/en/keywords.html#keywords-removed-in-current-series is really relative to 5.7, not 8.3.

Similar issue existed in the manual for 8.1, 8.2, 8.3 when those were online -- the text always mentioned the previous release, but the contents were always relative to MySQL 5.7.

I suspect this just fell through the cracks in the change to innovation and LTS releases?

How to repeat:
Examine https://dev.mysql.com/doc/refman/8.4/en/keywords.html and compare to https://dev.mysql.com/doc/refman/8.0/en/keywords.html for these sections. Lots of duplication since the entries that changed in 8.0 are still being listed as changed in 8.4.

Suggested fix:
In my opinion, this page would be most useful if it reflected differences since the prior LTS. So for example, for innovation releases 8.1-8.3, it would have been useful to show differences relative to 8.0. Similarly, 8.4 could show relative to 8.0 as sort of the previous LTS (granted, 8.0 was prior to new release scheme, but close enough in meaning). And then innovation releases after 8.4 could show keyword changes relative to 8.4.
[3 May 2024 20:50] Marc Reilly
I think it would also be useful to mention new/removed keywords in “ What Is New in MySQL 8.4 since MySQL 8.0”
https://dev.mysql.com/doc/refman/8.4/en/mysql-nutshell.html
[3 May 2024 22:33] Philip Olson
Interesting, thank you we'll look into this but in the meantime you can utilize this:

https://dev.mysql.com/doc/mysqld-version-reference/en/keywords.html
[3 May 2024 23:08] Philip Olson
Thank you for reporting this bug, the following doc changes were made:

* The 8.4 guide now compares keyword changes to 8.0
* The added/removed keyword information was added to What's New in 8.4

These changes will show up online within a few hours.

Also, agreed that 9.0-9.6 Innovation should compare themselves to 8.4 LTS. The 5.7 comparison was indeed an oversight. 

Also, thank you for being part of the extended MySQL QA family :)
[4 May 2024 22:20] Evan Elias
Thank you for the fast turnaround time! And also thanks for the Server Version Reference link -- somehow I've never stumbled across this part of the documentation. This looks extremely useful, I'm bookmarking it now.