Bug #78724 Release notes don't point to public bugs
Submitted: 6 Oct 2015 22:37 Modified: 6 Oct 2015 22:54
Reporter: Domas Mituzas Email Updates:
Status: Closed Impact on me:
None 
Category:MySQL Server: Documentation Severity:S3 (Non-critical)
Version:5.7 OS:Any
Assigned to: CPU Architecture:Any

[6 Oct 2015 22:37] Domas Mituzas
Description:
There's a very nasty habit not to mention publicly accessible bugs (on this bugs system) in release notes and only point to internal bugs system. 

For example:

"MySQL was unnecessarily decompressing pages in the buffer pool related to the table as part of the DROP operation. (Bug #16067973)"

Was originally reported here:

https://bugs.mysql.com/bug.php?id=68022

Please have pointers to public bugs in release notes especially for bugs that have been first reported on public system, as otherwise one might think you guys are bad people.

How to repeat:
read documentation

Suggested fix:
link to public bug reports in release notes
[6 Oct 2015 22:54] Todd Farmer
Thanks for noting this, Domas.  Our standard process is to reference both public and internal bug identifiers in the change logs.  For example, from the same 5.7.1 release notes:

"Important Change; Replication: The version number reported by mysqlbinlog --version has been increased to 3.4. (Bug #15894381, Bug #67643)"

This particular issue was caused by a process failure, which resulted in the association between the bugs.mysql.com record and the internal bug report being lost.  When the internal bug report was closed, there was no link back to the public record for the docs team to note.  We'll reinforce the importance of this process with staff to try to avoid future mistakes.