Merge pull request #307 from guidovranken/fix-wsScpSendCallback-comments

Correct references to return values in comments around wsScpSendCallback
pull/312/head
JacobBarthelmeh 2021-01-27 03:25:43 +07:00 committed by GitHub
commit d7bffed780
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 7 deletions

View File

@ -2292,10 +2292,10 @@ static int ScpProcessEntry(WOLFSSH* ssh, char* fileName, word64* mTime,
* If the peer requests a directory of files be transferred, in a recursive * If the peer requests a directory of files be transferred, in a recursive
* request, WOLFSSH_SCP_RECURSIVE_REQUEST will be passed to the callback. The * request, WOLFSSH_SCP_RECURSIVE_REQUEST will be passed to the callback. The
* callback is then responsible for traversing through the requested directory * callback is then responsible for traversing through the requested directory
* one directory or file at a time, returning WS_SCP_ENTER_DIRECTORY when * one directory or file at a time, returning WS_SCP_ENTER_DIR when a new
* a new directory is entered, WS_SCP_EXIT_DIRECTORY when a directory is * directory is entered, WS_SCP_EXIT_DIR when a directory is exited (not
* exited (not including the final directory exit), and * including the final directory exit), and WS_SCP_EXIT_DIR_FINAL when the
* WS_SCP_EXIT_DIRECTORY_FINAL when the final directory is done. * final directory is done.
* *
* At any time, the callback can abort the transfer by returning WS_SCP_ABORT. * At any time, the callback can abort the transfer by returning WS_SCP_ABORT.
* This will send an error confirmation message to the peer. When returning * This will send an error confirmation message to the peer. When returning
@ -2344,13 +2344,13 @@ static int ScpProcessEntry(WOLFSSH* ssh, char* fileName, word64* mTime,
* *
* Return number of bytes copied into buf, if doing a file transfer, otherwise * Return number of bytes copied into buf, if doing a file transfer, otherwise
* one of: * one of:
* WS_SCP_ENTER_DIRECTORY - send directory name to peer - fileName, * WS_SCP_ENTER_DIR - send directory name to peer - fileName,
* mode (optional), mTime (optional), and * mode (optional), mTime (optional), and
* aTime (optional) should be set. Return * aTime (optional) should be set. Return
* when callback and "entered" a directory. * when callback and "entered" a directory.
* WS_SCP_EXIT_DIRECTORY - return when recursive directory traversal * WS_SCP_EXIT_DIR - return when recursive directory traversal
* has "exited" a directory. * has "exited" a directory.
* WS_SCP_EXIT_DIRECTORY_FINAL - return when recursive directory transfer * WS_SCP_EXIT_DIR_FINAL - return when recursive directory transfer
* is complete. * is complete.
* WS_SCP_ABORT - abort file transfer request * WS_SCP_ABORT - abort file transfer request
*/ */