Add note to CopyToContainer documentation

Signed-off-by: Brian Schwind <brianmschwind@gmail.com> Upstream-commit: 1c3071e487db96ba8274ac2388eca0002e9cee77 Component: engine
2017-06-20 14:49:38 +09:00
parent 61ed140656
commit 125062e5cf
1 changed files with 1 additions and 0 deletions
@@ -30,6 +30,7 @@ func (cli *Client) ContainerStatPath(ctx context.Context, containerID, path stri
 }

 // CopyToContainer copies content into the container filesystem.
+// Note that `content` must be a Reader for a TAR
 func (cli *Client) CopyToContainer(ctx context.Context, container, path string, content io.Reader, options types.CopyToContainerOptions) error {
 	query := url.Values{}
 	query.Set("path", filepath.ToSlash(path)) // Normalize the paths used in the API.