MusicPlayerDaemon / mpc

Command-line client for MPD
GNU General Public License v2.0
191 stars 36 forks source link

Confusing description of mount command #74

Closed maxmitti closed 2 years ago

maxmitti commented 2 years ago

When doing mpc help (version 0.33) the description for the mount command is kind of confusing. Specifically the meaning of the uri and storage parameters is unclear:

mpc mount [<uri> <storage>]                           List mounts or add a new mount.

My first intuition was that uri is the uri of the storage that should be mounted. Possibly one of the outputs from listneighbors. This would leave the only meaning of storage to be the directory where it should be mounted inside MPD’s music_directory.

However, the opposite is true, as I have found out thanks to the MPD documentation. When doing it the wrong way it results in a “MPD error: Bad mount point”, which can be even more confusing, although it is true.

I would suggest to change the naming of the parameters, because I don’t think that a plain directory path is even considered as a URI. While what is currently called storage is, as it includes the protocol at the beginning. It might also be useful to add a short description what the parameters mean.

It would also make sense to adjust the description of the unmount command if this gets addressed.