Bug #84348 ha_example.cc and ha_example.h confusing comments in source
Submitted: 27 Dec 2016 19:17 Modified: 27 Dec 2016 21:51
Reporter: Shahriyar Rzayev (OCA) Email Updates:
Status: Verified Impact on me:
None 
Category:MySQL Server: Storage Engines Severity:S3 (Non-critical)
Version:5.5/5.6/5.7/8.0 OS:Any
Assigned to:

[27 Dec 2016 19:17] Shahriyar Rzayev
Description:
Hi dear all.

There is something funny with comments in ha_example.cc and ha_example.h

https://github.com/mysql/mysql-server/blob/5.7/storage/example/ha_example.cc#L43
Please read the object definition in ha_example.h before reading the rest of this file.

And in https://github.com/mysql/mysql-server/blob/5.7/storage/example/ha_example.h#L25
Please read ha_example.cc before reading this file.

So which one to read first? :)

How to repeat:
See description

Suggested fix:
Just let to read both :)
[27 Dec 2016 21:51] Godofredo Miguel Solorzano
Thank you for the bug report.

c:\build\2016DEC25>cat mysql-5.5\storage\example\ha_example.cc | grep Please
  Please read the object definition in ha_example.h before reading the rest

c:\build\2016DEC25>cat mysql-5.5\storage\example\ha_example.h | grep Please
  Please read ha_example.cc before reading this file.

c:\build\2016DEC25>cat mysql-5.6\storage\example\ha_example.cc | grep Please
  Please read the object definition in ha_example.h before reading the rest

c:\build\2016DEC25>cat mysql-5.6\storage\example\ha_example.h | grep Please
  Please read ha_example.cc before reading this file.

c:\build\2016DEC25>cat mysql-5.7\storage\example\ha_example.cc | grep Please
  Please read the object definition in ha_example.h before reading the rest

c:\build\2016DEC25>cat mysql-5.7\storage\example\ha_example.h | grep Please
  Please read ha_example.cc before reading this file.

c:\build\2016DEC25>cat mysql-trunk\storage\example\ha_example.cc | grep Please
  Please read the object definition in ha_example.h before reading the rest

c:\build\2016DEC25>cat mysql-trunk\storage\example\ha_example.h | grep Please
  Please read ha_example.cc before reading this file.