-==================================
+.. -*- coding: utf-8-with-signature -*-
+
+==================================
User-Visible Changes in Tahoe-LAFS
==================================
-Release 1.10 (2013-??-??)
-'''''''''''''''''''''''''
+Release 1.10.1 (XXXX-XX-XX)
+'''''''''''''''''''''''''''
+
+Unedited list of all changes after 1.10.0 and up-to 143af61 17-May-2015. This
+list is not yet limited to user-visible ones. It (hopefully) includes all
+tickets closed during this time, even minor non-user-visible ones.
+
+- show git branch in version output #1953
+- packaging fixes #1969 #1960
+- mutable/retrieve: raise NotEnoughSharesError earlier when the sharemap says
+ it's useless, and improve the error message #1742
+- improve user feedback when filing an Incident Report #1974
+- add page-rendering timestamp to WUI #1972
+- improve what-is-my-ipv4 on windows/cygwin #1381
+- remove unused 'human encoding' URI methods #1807
+- check/deep-check learned to accept multiple location args #740
+- tests warn if tree is dirty #1992
+- Travis-CI turned on #2249
+- py2.6 is now unsupported on windows
+- add 'distclean', don't remove egg-info during 'make clean' #2092
+- add "UTF-8 BOM" to all docs #1948
+- various docs cleanups/improvements
+- improve safety of timing_safe_compare() #2165
+- checker reports: remove needs-rebalancing, add count-happiness #1784 #2105
+- improve packaging under pip #2209
+- remove old darcs tooling
+- minor comments #1874 #2086
+- switch to unminified d3/jquery JS files #2208
+- improve test #2048
+- reject furlfiles with "#" #2128
+- rename exit-trigger/self-destruct test feature #1336
+- add coverage.io test-coverage reporting #623
+- hush warnings during dep-checking, stop complaining about missing
+ "service_identity" dep #2248
+- dedup license info in about.rst/README.txt #2067
+- 'tahoe cp -r' copies the top-level directory into new dir #712
+- log roothash in base32 not binary #1800
+- improve welcome page CSS for narrow windows #1931
+- redesign WUI directory pages #1966
+- improve upload tests #2008
+- remove obsolete debian packaging tools #2282
+- add --coverage to setup.py test #1698, remove old coverage uploaders
+- remove trialcoverage plugin #2281
+- tolerate disk-space-used=0 for travis boxes #2290
+- tolerate python subprocess bug #2023
+- remove old build_helpers tools #2305
+- fix "Download" button on welcome page #1901
+- update zetuptoolz
+- hack windows/OpenSSL deps on windows #2249 #2193
+- WAPI: do not report 'size' metadata when unknown #1634
+- new OS-X packaging #182
+- stop using contents of .tac files #1159
+- improve version-number reporting #2340
+- add per-server "(space) Available" column to welcome page #648
+- add public-key auth to SFTP server #1411
+- `tahoe cp -r` changes w.r.t. unnamed directories #2329
+- tolerate PEP440 semantics in dependency specifications #2354
+- replace WUI icons with distinct shapes for accessibility #1961
+- hush DeprecationWarning with twisted.web #2312
+- fix race condition during mutable upload
+- fix handling of long paths on windows #2235 #1674 #2027
+- fix MANIFEST.in warnings #2380
+- use "AUTO" in tahoe.cfg/node/tub.location to mean autodetect IP addresses.
+ Can be combined with static addresses, or turned off entirely. #754
+- 'tahoe cp -r': fix exception #2329
+- put version string into name of OS-X package: #2393
+- improve unicode handling of arguments to (S)FTPServer #2388
+- improve tests of test_mutable #2034
+- fix ftp 'ls' to work with Twisted-15.0.0 #2394
+- add docs/proposed/magic-folder
+- remove named-path upload/download from control-port #1737
+- unicode handling on windows something #2398
+- depend on foolscap >= 0.8.0, which makes better keys #2400
+- zetuptoolz: tolerate single-string requirespec #2242
+- add icon for OS-X/windows #2323
+- initial Docker support PR#165
+- accept newer Twisted (>=13) on windows if pywin32 is manually installed #2416
+- windows: find home directory on multiple versions of windows #2417
+- improve fileutil something #1531
+
+all tickets noted as closed: 1953 1960 1974 1972 1717 1381 898 1707 1918 1807
+740 1842 1992 2165 1847 2086 2208 2048 2128 2245 1336 2248 2067 712 1800 1966
+2008 2282 2281 2290 2023 2121? 2305 1901 2249 2193 1634 1159 2340 1146 648
+1411 2354 1961 2380 754 2393 2394 1737 2398 2400 2242 2416 2415 2417 1969
+1988 1784 2105 2209 2280 623 2249 1698 2028 2005 2312 2235 1674 2027 2034
+2323
+
+tickets referenced but not closed: 1834 1742 982 1064 1536 1935 666 1931 1258
+182 2286 1531
+
+PRs noted as closed: 62 48 57 61 62 63 64 69 73 81 82 84 85 87 91 94 95 96
+103 56 32 50 107 109 114 112 120 122 125 126 133 135 136 137 142 146 149 152
+165
+
+- "tahoe cp" changes:
+
+There are many "cp"-like tools in the unix world (POSIX /bin/cp, the "scp"
+provided by SSH, rsync). They each behave slightly differently in unusual
+circumstances, generally dealing with copying whole directories at a time,
+into a target which may or may not exist already. The usual question is
+whether the user is referring to the source directory as a whole, or to its
+contents. For example, should "cp -r foodir bardir" create a new directory
+named "bardir/foodir"? Or should it behave more like "cp -r foodir/* bardir"?
+Some tools use the presence of a trailing slash to indicate which behavior
+you want. Others ignore trailing slashes.
+
+"tahoe cp" is no exception to having exceptional cases. This release fixes
+some bad behavior and attempts to establish a consistent rationale for its
+behavior.
+
+The new rule is:
+
+- If the thing being copied is a directory, and it has a name (e.g. it's not
+ a raw tahoe directorycap), then you are referring to the directory itself.
+- If the thing being copied is an unnamed directory (e.g. raw dircap or
+ alias), then you are referring to the contents.
+- Trailing slashes do not affect the behavior of the copy (although putting a
+ trailing slash on a file-like target is an error).
+- The "-r" (--recursive) flag does not affect the behavior of the copy
+ (although omitting -r when the source is a directory is an error).
+- If the target refers to something that does not yet exist:
+ - and if the source is a single file, then create a new file;
+ - otherwise, create a directory.
+
+There are two main cases where the behavior of tahoe-1.10.1 differs from that
+of the 1.10.0 release:
+
+- "cp DIRCAP/file.txt ./local/missing" , where "./local" is a directory but
+ "./local/missing" does not exist. The implication is that you want tahoe to
+ create a new file named "./local/missing" and fill it with the contents of
+ the tahoe-side DIRCAP/file.txt. In 1.10.0, a plain "cp" would do just this,
+ but "cp -r" would do "mkdir ./local/missing" and then create a file named
+ "./local/missing/file.txt". In 1.10.1, both "cp" and "cp -r" create a file
+ named "./local/missing".
+- "cp -r PARENTCAP/dir ./local/missing", where PARENTCAP/dir/ contains
+ "file.txt", and again "./local" is a directory but "./local/missing" does
+ not exist. In both 1.10.0 and 1.10.1, this first does "mkdir
+ ./local/missing". In 1.10.0, it would then copy the contents of the source
+ directory into the new directory, resulting in "./local/missing/file.txt".
+ In 1.10.1, following the new rule of "a named directory source refers to
+ the directory itself", the tool creates "./local/missing/dir/file.txt".
+
+
+Compatibility and Dependency Updates
+------------------------------------
+
+- Twisted >= 13.0.0
+- Nevow >= 0.11.1
+- foolscap >= 0.8.0
+- service-identity
+- characteristic >= 14.0.0
+- pyasn1 >= 0.1.4
+- pyasn1-modules >= 0.0.5
+
+On Windows, if pywin32 is not installed then the dependencies on Twisted
+and Nevow become:
+
+- Twisted >= 11.1.0, <= 12.1.0
+- Nevow >= 0.9.33, <= 0.10
+
+On all platforms, if pyOpenSSL >= 0.14 is installed, then it will be used,
+but if not then only pyOpenSSL >= 0.13, <= 0.13.1 will be built when directly
+invoking `setup.py build` or `setup.py install`.
+
+We strongly advise OS packagers to take the option of making a tahoe-lafs
+package depend on pyOpenSSL >= 0.14. In order for that to work, the following
+additional Python dependencies are needed:
+
+- cryptography
+- cffi >= 0.8
+- six >= 1.4.1
+- enum34
+- pycparser
+
+as well as libffi (for Debian/Ubuntu, the name of the needed OS package is
+`libffi6`).
+
+Tahoe-LAFS is now compatible with setuptools version 8 and pip version 6
+or later.
+
+
+Release 1.10.0 (2013-05-01)
+'''''''''''''''''''''''''''
New Features
------------
- The Welcome page has been redesigned. This is a preview of the design style
that is likely to be used in other parts of the WUI in future Tahoe-LAFS
versions. (`#1713`_, `#1457`_, `#1735`_)
-- A new, more extensible Introducer protocol has been added, to act as the
- basis for future improvements such as accounting. Compatibility with older
- nodes is not affected. When server, introducer, and client are all
- upgraded, the welcome page will show node IDs that start with "v0-" instead
- of the old tubid. (`#466`_)
+- A new extensible Introducer protocol has been added, as the basis for
+ future improvements such as accounting. Compatibility with older nodes is
+ not affected. When server, introducer, and client are all upgraded, the
+ welcome page will show node IDs that start with "v0-" instead of the old
+ tubid. See `<docs/nodekeys.rst>`__ for details. (`#466`_)
- The web-API has a new ``relink`` operation that supports directly moving
files between directories. (`#1579`_)
to generate a new FURL, delete the existing ``introducer.furl`` file and
restart it. After doing this, the ``[client]introducer.furl`` setting of
every client and server that should connect to that introducer must be
- updated. (`#1802`_)
+ updated. Note that other users of a shared machine may be able to read
+ ``introducer.furl`` from your ``tahoe.cfg`` file unless you configure the
+ file permissions to prevent them. (`#1802`_)
- Both ``introducer.furl`` and ``helper.furl`` are now censored from the
Welcome page, to prevent users of your gateway from learning enough to
create gateway nodes of their own. For existing guessable introducer
Notable Bugfixes
----------------
-- If an immutable file failed to download, e.g. due to a connection problem,
- subsequent attempts to download the same file could also fail. (`#1679`_)
-- The SFTP frontend now works with recent versions of Twisted, rather than
- giving errors or warnings about use of ``IFinishableConsumer``. (`#1926`_,
- `#1564`_, `#1525`_)
-- Failure handling in the SFTP frontend has been improved. (`#1525`_)
-- Checking a LIT file using ``tahoe check`` no longer results in an
- exception. (`#1758`_)
+- In earlier versions, if a connection problem caused a download failure for
+ an immutable file, subsequent attempts to download the same file could also
+ fail. This is now fixed. (`#1679`_)
- Filenames in WUI directory pages are now displayed correctly when they
contain characters that require HTML escaping. (`#1143`_)
- Non-ASCII node nicknames no longer cause WUI errors. (`#1298`_)
-- Error messages containing tracebacks may be slightly more readable.
- (`#1484`_)
-- ``tahoe cp --verbose`` counts the files being processed correctly.
+- Checking a LIT file using ``tahoe check`` no longer results in an
+ exception. (`#1758`_)
+- The SFTP frontend now works with recent versions of Twisted, rather than
+ giving errors or warnings about use of ``IFinishableConsumer``. (`#1926`_,
+ `#1564`_, `#1525`_)
+- ``tahoe cp --verbose`` now counts the files being processed correctly.
(`#1805`_, `#1783`_)
- Exceptions no longer trigger an unhelpful crash reporter on Ubuntu 12.04
("Precise") or later. (`#1746`_)
-- Improve error message when CLI tools cannot connect to a gateway. (`#974`_)
-- Other minor changes: `#1781`_, `#1812`_
-
-Performance Improvements
-------------------------
-
-- Allow web clients to cache immutable directory pages. (`#443`_)
-
-Documentation
--------------
-
-- docs/helper.rst has been brought up to date. (`#1915`_)
-- docs/convergence_secret.rst was added to document the adminstration of
- convergence secrets. (`#1761`_)
-
-Packaging Changes
------------------
-
-- The flogtool utility, used to read logs, can now be accessed as
- ``tahoe debug flogtool`` even when foolscap is not installed system-wide.
- (`#1693`_)
-- The provisioning/reliability pages were removed from the main client's web
- interface, and moved into a standalone web-based tool in
- misc/operations_helpers/provisioning. Use the ``run.py`` script to access
- them.
+- The error message displayed when a CLI tool cannot connect to a gateway has
+ been improved. (`#974`_)
+- Other minor fixes: `#1781`_, `#1812`_, `#1915`_, `#1484`_, `#1525`_
Compatibility and Dependencies
------------------------------
- Python >= 2.6, except Python 3 (`#1658`_)
- Twisted >= 11.0.0 (`#1771`_)
-- mock >= 0.8
-- pycryptopp >= 0.6.0 (for ed25519)
+- mock >= 0.8 (for unit tests)
+- pycryptopp >= 0.6.0 (for Ed25519 signatures)
+- zope.interface >= 3.6.0 (except 3.6.3 or 3.6.4)
+
+Other Changes
+-------------
+
+- The ``flogtool`` utility, used to read detailed event logs, can now be
+ accessed as ``tahoe debug flogtool`` even when Foolscap is not installed
+ system-wide. (`#1693`_)
+- The provisioning/reliability pages were removed from the main client's web
+ interface, and moved into a standalone web-based tool. Use the ``run.py``
+ script in ``misc/operations_helpers/provisioning/`` to access them.
+- Web clients can now cache (ETag) immutable directory pages. (`#443`_)
+- `<docs/convergence_secret.rst>`__ was added to document the adminstration
+ of convergence secrets. (`#1761`_)
Precautions when Upgrading
--------------------------
-- When upgrading a grid from a recent version of trunk, follow the
+- When upgrading a grid from a recent revision of trunk, follow the
precautions from this `message to the tahoe-dev mailing list`_, to ensure
that announcements to the Introducer are recognized after the upgrade.
- This is not necessary when upgrading from a previous release.
+ This is not necessary when upgrading from a previous release like 1.9.2.
.. _`#166`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/166
.. _`#443`: https://tahoe-lafs.org/trac/tahoe-lafs/ticket/443
.. _`message to the tahoe-dev mailing list`:
https://tahoe-lafs.org/pipermail/tahoe-dev/2013-March/008096.html
+
Release 1.9.2 (2012-07-03)
''''''''''''''''''''''''''