Revision: 8c1993988041
Author: anssi.syrjasalo <[email protected]>
Date: Wed Nov 27 15:11:26 2013 UTC
Log: Edited wiki page ReleaseNotes through web user interface.
http://code.google.com/p/robotframework-sshlibrary/source/detail?r=8c1993988041&repo=wiki
Modified:
/ReleaseNotes.wiki
=======================================
--- /ReleaseNotes.wiki Wed Nov 27 14:54:11 2013 UTC
+++ /ReleaseNotes.wiki Wed Nov 27 15:11:26 2013 UTC
@@ -7,7 +7,7 @@
SSHLibrary 2.0 was released on Wednesday the 27th of November, 2013.
-This release introduces several new keywords, mainly for the SFTP
functionality, adds support for character encodings and now has extensive
documentation and examples.
+This release introduces several new keywords, mainly for the SFTP
functionality, adds support for character encodings and now has extensive
documentation and usage examples.
Questions and comments related to the release can be sent to the
[https://code.google.com/p/robotframework/wiki/MailingLists mailing lists]
and possible bugs
@@ -18,31 +18,31 @@
=== Support for configuring the character encoding ===
SSHLibrary now supports configuring the character encoding as the library
default or per
-connection. All the inputs are encoded before they are sent to the remote
host. Respectively, all the outputs from the server are decoded before they
are handled by the library and the test data. This also applies to the file
and directory names on the remote host. If no encoding is explicitly
defined, UTF-8 is assumed.
+connection (issue 60). All the inputs are encoded before they are sent to
the remote host. Respectively, all the outputs from the server are decoded
before they are handled by the library and the test data. This also applies
to the file and directory names on the remote host. If no encoding is
explicitly defined, UTF-8 is assumed.
-=== New keywords for transferring whole directories ===
+=== New keywords for transferring directories ===
-Keywords `Get Directory` and `Put Directory` were added for downloading
and uploading directories including their content, additionally with their
subdirectories recursively included.
+Keywords `Get Directory` and `Put Directory` were added for downloading
and uploading directories including their content, additionally with their
subdirectories recursively included (issue 66).
-=== New keyword for getting the current connection information ===
+=== New keyword for getting the connection information ===
-Keyword `Get Connection` was added for the purpose of querying the
connection index and the connection specific configuration. This keyword
returns an object identical to the objects returned by keyword `Get
Connections`.
+Keyword `Get Connection` was added for the purpose of querying the
connection index and the connection specific configuration (issue 72). The
keyword returns an object identical to the objects returned by keyword `Get
Connections`.
-=== Possible to wait for more content with `Read` ===
+=== Possible to wait for more content with keyword `Read` ===
-Keyword `Read` now has an optional argument `delay`. If `delay` is given,
the keyword waits that amount of time and reads output from the server
again. This wait-read cycle is repeated as long as further reads return
more output or the timeout expires. This is to help ensuring that all the
output has been read from the server.
+Keyword `Read` now has an optional argument `delay` (issue 90). If `delay`
is given, the keyword waits that amount of time and reads output from the
server again. This wait-read cycle is repeated as long as further reads
return more output or the timeout expires. This is to help ensuring that
all the output has been read from the server.
-=== The library documentation enhancements ===
+=== General documentation enhancements ===
-The library documentation was greatly improved. The major additions were
done in the documentation related to configuration (issue 73), interactive
sessions (issue 77) and handling the command output (issue 59). Also, the
most of the keyword examples were rewritten to match their practical use
case better. The old runnable examples, included in the source repository,
were removed or merged with the keyword usage examples.
+The library documentation was greatly improved. The major documentation
improvements were done related to configuration (issue 73), interactive
sessions (issue 77) and handling the command output (issue 59). Also, the
most of the keyword usage examples were rewritten to match their practical
use case better. The old runnable examples, formerly included in the source
distribution, were removed and merged with the keyword examples (issue 61).
== Backward incompatible changes ==
=== New keywords for listings and for asserting if a file/directory (not)
exists ===
-Keywords `List Directory`, `List Files In Directory` and `List Directories
in Directory` were added for content 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 exists or does not exist on the remote host. All of these
keywords work similarly as the ones in !OperatingSystem library.
+Keywords `List Directory`, `List Files In Directory` and `List Directories
in Directory` were added for content on the remote host (issue 75).
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 exists or does not exist on the remote host (issue 74).
All of these keywords work similarly as the ones in !OperatingSystem
library.
-If both !OperatingSystem and SSHLibrary are brought into use in the test
data, the keyword names will conflict. This is fixed easiest by prefixing
the keyword with the library name, such as `OperatingSystem.List Directory`
or `SSHLibrary.List Directory`. Because the lines can then grow quite long,
it might be a good idea to import the library with a shorter name, e.g. as
following:
+If both !OperatingSystem and SSHLibrary are used in the test data, the
keyword names will conflict. This is fixed easiest by prefixing the keyword
with the library name, such as `OperatingSystem.List Directory` or
`SSHLibrary.List Directory`. Because lines can then grow quite long, it
might be a good idea to import the libraries with shorter names, e.g. as
following:
{{{
*** Settings ***
Library SSHLibrary WITH NAME Remote
@@ -57,19 +57,19 @@
=== Deprecated keywords for configuring the defaults 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 removed keywords were already deprecated
in SSHLibrary 1.1.
+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` (issue 76). The removed keywords were already
deprecated in SSHLibrary 1.1.
=== Keyword `Get File` now matches patterns case sensitively ==
-When using keyword `Get File` with glob patterns given in the source file
path, the paths are now matched case and space sensitively. Earlier the
matching was both case and space insensitive.
+When using keyword `Get File` with glob patterns given in the source file
path, the paths are now matched case and space sensitively (issue 70).
Earlier the matching was both case and space insensitive.
== Deprecated features ==
=== Keyword-specific path separators are now deprecated ===
-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 keywords `Get File` and `Put File`.
+Path separator is now configurable as the library default or per
connection (issue 93). This makes more sense than passing it as an argument
to the every call of keywords `Get File` and `Put File`.
-It is still possible to use argument `path_separator` with `Get File` and
`Put File` as before but this will trigger a deprecation warning. The
argument value is now empty by default which in practice means that the
library or the connection specific `path_separator` is then used instead.
+It is still possible to use argument `path_separator` with keywords `Get
File` and `Put File` as before but this will print a deprecation warning.
The argument value is now empty by default, which in practice means that
the library or the connection specific `path_separator` is then used
instead.
== Full list of fixes and enhancements in 2.0 ==
--
---
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.
