[MDEV-32274] "Symlink" mentioning in the command line tool documentation Created: 2023-09-28 Updated: 2023-10-30 |
|
| Status: | Open |
| Project: | MariaDB Server |
| Component/s: | Documentation |
| Affects Version/s: | None |
| Fix Version/s: | N/A |
| Type: | Bug | Priority: | Major |
| Reporter: | Vladislav Vaintroub | Assignee: | Ian Gilfillan |
| Resolution: | Unresolved | Votes: | 0 |
| Labels: | None | ||
| Description |
|
A bulk of documentation for the command line tools such as mysql_upgrade, mysqldump etc is dedicated to documentation of what is symlink of what. E.g for mysqldump, we got MariaDB starting with 10.5.2 MariaDB starting with 11.0.1 First, it is generally incorrect. On Windows, there were never symlinks. These executables are created during the build as hardlinks, and gets packaged as full copies. ZIP can't package symlinks or hardlinks, the archive format does not support it. Ditto MSI. Second, who cares about it? It is a tiny implementation defail that can be mentioned for all executables in small font somewhere else. Can we change the wording, so it is less confusing, and correct, even if we are on Windows? For the end user, again, it is too much information, and an unimportant detail. Whether it is a symlink, a hardlink, or a full copy, an alias, or a shell wrapper, or a .bat wrapper, functionality remains the same. If someone is curious, there is a Unix command "file", and Unix command "ls -l", an Windows "dir" that would reveal what link points where. I do not think I ever read user documentation of any software mentioning in such detail what kind of link every installed file would be. Of course people care if file is removed. For Docker, one does not need to say removed file was a symlink , one does not even need to say it got deprecated, because, well, it is not there anymore. |