Revision: 293bf05f6653
Author:   anssi.syrjasalo <[email protected]>
Date:     Wed Nov 27 13:56:39 2013 UTC
Log:      Edited wiki page ReleaseNotes through web user interface.
http://code.google.com/p/robotframework-sshlibrary/source/detail?r=293bf05f6653&repo=wiki

Modified:
 /ReleaseNotes.wiki

=======================================
--- /ReleaseNotes.wiki  Wed Nov 27 13:54:30 2013 UTC
+++ /ReleaseNotes.wiki  Wed Nov 27 13:56:39 2013 UTC
@@ -1,7 +1,7 @@
 #summary Release notes for all the SSHLibrary releases
 #labels Featured

-== SSHLibrary 2.0 ==
+= SSHLibrary 2.0 =

 SSHLibrary 2.0 was released on Wednesday the 27th of November, 2013.

@@ -9,59 +9,59 @@
[https://code.google.com/p/robotframework/wiki/MailingLists mailing lists] and possible bugs submitted to the [https://code.google.com/p/robotframework-sshlibrary/issues issue tracker].

-=== Most important enhancements ===
+== Most important enhancements ==

-==== Support for configuring character encoding ====
+=== Support for configuring character encoding ===

SSHLibrary now supports configuring the character encoding. The encoding is applied for all the inputs before they are sent to the remote host. Respectively, all the outputs from the server are decoded before they are handled by the library. This is also includes the file and directory names when using the library's SFTP functionality. If no encoding is defined explicitly, UTF-8 is assumed.

-==== New keywords for getting and putting whole directories ====
+=== New keywords for getting and putting whole directories ===

Keywords `Get Directory` and `Put Directory` were added for downloading and uploading whole directories, additionally including their subdirectories (the keyword argument `recursive`).

-==== New keyword for getting the current connection information ====
+=== New keyword for getting the current connection information ===

Keyword `Get Connection` was added for the purpose of querying the connection index and the configuration. This keyword returns an object identical to the objects returned by `Get Connections`.

-==== Support waiting for more content with `Read` ====
+=== Support waiting for more content with `Read` ===

Keyword `Read` now has an optional argument `delay`. If `delay` is given, `Read` waits that amount of time and reads output again. This wait-read cycle is repeated as long as further reads return more output or the timeout expires. This is to ensure that all the output has been read from the server.

-==== General documentation and example improvements ====
+=== General documentation and example improvements ===

The library documentation was greatly enhanced. The major improvements were done in the documentation related to configuration (issue 73), interactive sessions (issue 77) and reading the command output (issue 59). Also, the most of the keyword examples were rewritten.

-=== Backward incompatible changes ===
+== Backward incompatible changes ==

-==== New keywords listing files, directories or both on the remote host ====
+=== New keywords listing files, directories or both on the remote host ===

Keywords `List Directory`, `List Files In Directory` and `List Directories in Directory` were added for listing the files and the directories on the remote host. The keywords work similarly as the ones in !OperatingSystem library.

If both !OperatingSystem and !SSHLibrary are used in the tests, the keyword names will conflict. This is fixed the easiest by prefixing the keyword with the library name or the abbreviation set explicitly on the library import.

-==== New keywords for checking if a file or a directory (not) exists on the remote host ==== +=== New keywords for checking if a file or a directory (not) exists on the remote host ===

Keywords `File Should Exist`, `File Should Not Exist`, `Directory Should Exist` and `Directory Should Not Exist` were added for asserting if the file or directory (does not) exist on the remote host. The keywords work similarly as the ones in !OperatingSystem library.

If both !OperatingSystem and !SSHLibrary are used in the tests, the keyword names will conflict. This is fixed the easiest by prefixing the keyword with the library name or the abbreviation set explicitly on the library import.

-==== Keywords `Set Timeout`, `Set Prompt`, `Set Newline` and `Set Default Log Level` were removed ==== +=== Keywords `Set Timeout`, `Set Prompt`, `Set Newline` and `Set Default Log Level` were removed ===

Keywords `Set Timeout`, `Set Prompt`, `Set Newline` and `Set Default Log Level`, used for configuring the library defaults were removed in favor of `Set Default Configuration`. The keywords were already deprecated in SSHLibrary 1.1.

-==== Avoid using Robot's deprecated `utils.matches` in `Get File` ===
+=== Avoid using Robot's deprecated `utils.matches` in `Get File` ==

When using `Get File` with glob patterns in the source file path, the file paths are now matched case and space sensitively, earlier being both case and space insensitive.

-=== Depracated features ===
+== Depracated features ==

-==== Path separator should be configurable per connection ====
+=== Path separator should be configurable per connection ===

Path separator is now configurable as the library default or per connection. This makes more sense than passing it as an argument to the every call of `Get File` and `Put File` keywords.

The argument `path_separator` is still effective for `Get File` and `Put File` if given. The argument is now empty by default, thus the library/connection specific setting is then used instead.

-=== Full list of fixes and enhancements in 2.0 ===
+== Full list of fixes and enhancements in 2.0 ==

 || *ID* || *Type* || *Priority* || *Summary* ||
|| Issue 69 || Defect || High || `Execute Command` occasionally returns `None` instead of `0` as the exit status on Jython ||
@@ -86,7 +86,9 @@
|| Issue 83 || Enhancement || Low || Terminal type, width and height are configurable also as library defaults || || Issue 86 || Enhancement || Low || Keywords `Execute Command` and `Read Command Output` automatically log the return code ||

-== SSHLibrary 1.1 ==
+Altogether 21 issues.
+
+= SSHLibrary 1.1 =

 SSHLibrary 1.1 was released on Friday the 31st of August, 2012.

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

 Altogether 10 issues.

-== SSHLibrary 1.0 ==
+= SSHLibrary 1.0 =

 SSHLibrary 1.0 was released on Monday 8th of Novemeber 2010.

--

--- You received this message because you are subscribed to the Google Groups "robotframework-commit" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
For more options, visit https://groups.google.com/groups/opt_out.

Reply via email to