LSaddon::ssh: Add doc about $mode parameter of function createDirsBySFTP

This parameter must be an octal number, with a leading zero (ex: 0640 or 
02755).
This commit is contained in:
Benjamin Renard 2020-05-19 11:21:06 +02:00
parent c120e76822
commit 69eaf31598

View file

@ -184,7 +184,8 @@ LSerror :: defineError('SSH_07',
* *
* @param[in] $connection_params array Connection parameters * @param[in] $connection_params array Connection parameters
* @param[in] $dirs array|string The directory/ies to add * @param[in] $dirs array|string The directory/ies to add
* @param[in] $mode integer The directory/ies mode (default : default umask on the SSH server) * @param[in] $mode integer The directory/ies mode as an octal number (do not forget leading zero,
* example: 0755 or 02755, default : default umask on the SSH server)
* @param[in] $recursive boolean Enable recursive mode (default : false) * @param[in] $recursive boolean Enable recursive mode (default : false)
* @param[in] $continue boolean Enable continue mode : do not on error (default : false) * @param[in] $continue boolean Enable continue mode : do not on error (default : false)
* *