Skip to content

Commit

Permalink
Docs: Clarify Transport.copy requires recursive=True if source is…
Browse files Browse the repository at this point in the history
… a directory (#6495)
  • Loading branch information
khsrali authored Jun 29, 2024
1 parent 1d104d0 commit 310ff1d
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions src/aiida/transports/plugins/ssh.py
Original file line number Diff line number Diff line change
Expand Up @@ -1118,11 +1118,13 @@ def copy(self, remotesource, remotedestination, dereference=False, recursive=Tru
Flags used: ``-r``: recursive copy; ``-f``: force, makes the command non interactive;
``-L`` follows symbolic links
:param remotesource: file to copy from
:param remotesource: file to copy from
:param remotedestination: file to copy to
:param dereference: if True, copy content instead of copying the symlinks only
Default = False.
:param recursive: if True copy directories recursively, otherwise only copy the specified file(s)
:param recursive: if True copy directories recursively.
Note that if the `remotesource` is a directory, `recursive` should always be set to True.
Default = True.
:type recursive: bool
:raise OSError: if the cp execution failed.
Expand Down

0 comments on commit 310ff1d

Please sign in to comment.