Bug #2270 Substitute paths in mysql manpage
Submitted: 3 Jan 2004 12:07 Modified: 21 Jan 2004 3:37
Reporter: Christian Hammers (Silver Quality Contributor) (OCA) Email Updates:
Status: Closed Impact on me:
None 
Category:MySQL Server: Documentation Severity:S3 (Non-critical)
Version:all OS:Linux (Debian GNU/Linux)
Assigned to: Lenz Grimmer CPU Architecture:Any

[3 Jan 2004 12:07] Christian Hammers
Description:
(reference http://bugs.debian.org/223812)

The man page of mysql (man mysql) lists under the FILES section:
> FILES
>       /depot/bin/mysql        executable
>       /depot/bin/mysqld       executable
>       /depot/bin/safe_mysqld
>                               executable shell script for starting
>                               mysqld safely
>       /site/var/mysql/data    location of database files

this could be automatically replaced by the correct paths

> FILES
>       /usr/bin/mysql          executable
>       /usr/sbin/mysqld        executable
>       /usr/bin/safe_mysqld
>                               executable shell script for starting
>                               mysqld safely
>       /var/lib/mysql          location of database files

How to repeat:
man mysql
[20 Jan 2004 8:20] Lenz Grimmer
OK, I have now overhauled the man page building process a bit and these
hard-coded values will now be replaced at build time. A patch has been
sent in for review. It it will be accepted, it will be pushed into the 4.0
BK tree.
[21 Jan 2004 3:37] Lenz Grimmer
Now pushed into the 4.0 tree (so it will be part of 4.0.18 and up): 
 
ChangeSet@1.1685.1.1, 2004-01-20 17:14:02+01:00, lenz@mysql.com 
  What started as an attempt to fix BUG#2270 (Substitute paths in mysql 
  manpage) turned out as a major overhaul of all man pages: 
 
   - renamed all *.1 files to *.1.in to act as templates which are being 
     processed at build time 
   - replaced some hard-coded values with place holder that are being 
     replaced with the proper values at build time 
   - Updated list of available man pages in the SEE ALSO section and added a 
     hint to the manual for more details 
   - Added a BUGS section to all pages, referring to the bugs DB 
   - Updated some obsolete URLs and mail addresses 
 
  The actual content of these man pages should probably be cross-checked for 
  correctness, though...