From 88320638b5512e9555539ad6c7af502ea64e06db Mon Sep 17 00:00:00 2001 From: Ingela Anderton Andin Date: Thu, 30 Apr 2015 12:59:49 +0200 Subject: ssh: Fix links --- lib/ssh/doc/src/ssh_sftp.xml | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/lib/ssh/doc/src/ssh_sftp.xml b/lib/ssh/doc/src/ssh_sftp.xml index 02970bfa42..b986d38fea 100644 --- a/lib/ssh/doc/src/ssh_sftp.xml +++ b/lib/ssh/doc/src/ssh_sftp.xml @@ -70,7 +70,7 @@

The function reads from a specified position, combining the and functions.

-

ssh_sftp:apread/4

 +

ssh_sftp:apread/4

@@ -110,7 +110,7 @@

writes on a specified position, combining the and operations.

-

ssh_sftp:awrite/3

+

ssh_sftp:awrite/3

@@ -163,7 +163,7 @@

Deletes the file specified by , like - file:delete/1

+ file:delete/1

 @@ -232,7 +232,7 @@

Creates a symbolic link pointing to with the name , like - file:make_symlink/2

+ file:make_symlink/2

 @@ -297,7 +297,7 @@

Opens a handle to a tar file on the server, associated with ChannelPid. The handle can be used for remote tar creation and extraction, as defined by the - erl_tar:init/3 function. + erl_tar:init/3 function.

For code exampel see Section @@ -387,7 +387,7 @@

The function reads from a specified position, combining the and functions.

-

ssh_sftp:read/4

+

ssh_sftp:read/4

 @@ -406,7 +406,7 @@

The function writes to a specified position, combining the and functions.

-

ssh_sftp:write/3

+

ssh_sftp:write/3

 @@ -449,7 +449,7 @@

Reads a file from the server, and returns the data in a binary, like - file:read_file/1

+ file:read_file/1

 @@ -468,7 +468,7 @@

Returns a record from the file specified by or , - like file:read_file_info/2

+ like file:read_file_info/2

 @@ -485,7 +485,7 @@

Reads the link target from the symbolic link specified by , like - file:read_link/1

+ file:read_link/1

 @@ -504,7 +504,7 @@

Returns a record from the symbolic link specified by or , like - file:read_link_info/2

+ file:read_link_info/2

 @@ -522,7 +522,7 @@

Renames a file named and gives it the name , like - file:rename/2

+ file:rename/2

 @@ -580,7 +580,7 @@

Stops an SFTP channel. Does not close the SSH connection. - Use ssh:close/1 to close it.

+ Use ssh:close/1 to close it.

 @@ -597,7 +597,7 @@

Writes a file to the server, like file:write_file/2 The + marker="kernel:file#write_file-2">file:write_file/2 The file is created if it does not exist. The file is overwritten if it exists.

 @@ -648,7 +648,7 @@

Writes file information from a record to the file specified by , like - file:write_file_info/[2,3]

+ file:write_file_info/[2,3]

 -- cgit v1.2.3 From 609f259646e2ff3ee87d1b4ab47bf0edc9bed19e Mon Sep 17 00:00:00 2001 From: Ingela Anderton Andin Date: Mon, 4 May 2015 12:00:07 +0200 Subject: ssh: Use correct ASCII char for quote --- lib/ssh/doc/src/ssh_channel.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/ssh/doc/src/ssh_channel.xml b/lib/ssh/doc/src/ssh_channel.xml index 429ef3c849..2205eb4279 100644 --- a/lib/ssh/doc/src/ssh_channel.xml +++ b/lib/ssh/doc/src/ssh_channel.xml @@ -259,7 +259,7 @@ State = term() Internal state of the channel. Extra = term() - Passed “as-is” from the {advanced,Extra} + Passed "as-is" from the {advanced,Extra} part of the update instruction. -- cgit v1.2.3 From fd89608b7ae337bc29712c14c90de8d1c82ea667 Mon Sep 17 00:00:00 2001 From: Ingela Anderton Andin Date: Mon, 4 May 2015 12:06:25 +0200 Subject: ssh: Fix missed alphabetic ordering and indentation --- lib/ssh/doc/src/ssh_sftp.xml | 88 ++++++++++++++++++++++---------------------- 1 file changed, 45 insertions(+), 43 deletions(-) diff --git a/lib/ssh/doc/src/ssh_sftp.xml b/lib/ssh/doc/src/ssh_sftp.xml index b986d38fea..643130fe6b 100644 --- a/lib/ssh/doc/src/ssh_sftp.xml +++ b/lib/ssh/doc/src/ssh_sftp.xml @@ -73,6 +73,24 @@

ssh_sftp:apread/4

 + + apwrite(ChannelPid, Handle, Position, Data) -> ok | {error, Reason} + Writes asynchronously to an open file. + + ChannelPid = pid() + Handle = term() + Position = integer() + Len = integer() + Data = binary() + Timeout = timeout() + Reason = term() + + +

writes on a specified position, combining + the and operations.

+

ssh_sftp:awrite/3

+ + aread(ChannelPid, Handle, Len) -> {async, N} | {error, Error} Reads asynchronously from an open file. @@ -95,23 +113,7 @@ - - apwrite(ChannelPid, Handle, Position, Data) -> ok | {error, Reason} - Writes asynchronously to an open file. - - ChannelPid = pid() - Handle = term() - Position = integer() - Len = integer() - Data = binary() - Timeout = timeout() - Reason = term() - - -

writes on a specified position, combining - the and operations.

-

ssh_sftp:awrite/3

- + awrite(ChannelPid, Handle, Data) -> ok | {error, Reason} @@ -584,25 +586,6 @@ - - write_file(ChannelPid, File, Iolist) -> - write_file(ChannelPid, File, Iolist, Timeout) -> ok | {error, Reason} - Writes a file. - - ChannelPid = pid() - File = string() - Iolist = iolist() - Timeout = timeout() - Reason = term() - - -

Writes a file to the server, like file:write_file/2 The - file is created if it does not exist. The file is overwritten - if it exists.

- - - write(ChannelPid, Handle, Data) -> write(ChannelPid, Handle, Data, Timeout) -> ok | {error, Error} @@ -617,9 +600,9 @@

Writes to the file referenced by . - The file is to be opened with or - flag. Returns if successful or - otherwise.

+ The file is to be opened with or + flag. Returns if successful or + otherwise.

Typical error reasons:

@@ -633,7 +616,26 @@ - + + + write_file(ChannelPid, File, Iolist) -> + write_file(ChannelPid, File, Iolist, Timeout) -> ok | {error, Reason} + Writes a file. + + ChannelPid = pid() + File = string() + Iolist = iolist() + Timeout = timeout() + Reason = term() + + +

Writes a file to the server, like file:write_file/2 The + file is created if it does not exist. The file is overwritten + if it exists.

+ + + write_file_info(ChannelPid, Name, Info) -> write_file_info(ChannelPid, Name, Info, Timeout) -> ok | {error, Reason} @@ -647,11 +649,11 @@

Writes file information from a record to the - file specified by , like - file:write_file_info/[2,3]

+ file specified by , like + file:write_file_info/[2,3]

 - + -- cgit v1.2.3 From 5d6805703035d88a44265b3e0e1337d4e8388c10 Mon Sep 17 00:00:00 2001 From: Ingela Anderton Andin Date: Tue, 5 May 2015 11:59:07 +0200 Subject: ssh: No description in v-tag --- lib/ssh/doc/src/ssh_channel.xml | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/lib/ssh/doc/src/ssh_channel.xml b/lib/ssh/doc/src/ssh_channel.xml index 2205eb4279..b8a03c350a 100644 --- a/lib/ssh/doc/src/ssh_channel.xml +++ b/lib/ssh/doc/src/ssh_channel.xml @@ -88,7 +88,7 @@ Makes a synchronous call to a channel. ChannelRef = pid() - As returned by start_link/4 + As returned by ssh_channel:start_link/4 Msg = term() Timeout = timeout() Reply = term() @@ -112,7 +112,7 @@ ChannelRef and returns ok. ChannelRef = pid() - As returned by start_link/4 + As returned by ssh_channel:start_link/4 Msg = term() @@ -129,8 +129,8 @@ enter_loop(State) -> _ Makes an existing process an ssh_channel process. - State = term() - as returned by - ssh_channel:init/1 + State = term() + as returned by ssh_channel:init/1

Makes an existing process an ssh_channel @@ -188,7 +188,7 @@ reply(Client, Reply) -> _ Sends a reply to a client. - Client - opaque to the user, see explanation below + Client = opaque() Reply = term() @@ -313,13 +313,15 @@ ssh_channel:call/[2,3]. Msg = term() - From = Opaque to the user, is to be used as argument to - ssh_channel:reply/2 + From = opaque() + Is to be used as argument to + ssh_channel:reply/2 State = term() Result = {reply, Reply, NewState} | {reply, Reply, NewState, timeout()} | {noreply, NewState} | {noreply , NewState, timeout()} | {stop, Reason, Reply, NewState} | {stop, Reason, NewState} - Reply = term() - will be the return value of ssh_channel:call/[2,3] + Reply = term() + Will be the return value of ssh_channel:call/[2,3] NewState = term() Reason = term() @@ -418,7 +420,7 @@ Module:terminate(Reason, State) -> _ Does cleaning up before channel process termination. - + Reason = term() State = term() -- cgit v1.2.3