From 2e7a6b7cfcf69ac8da10b157dc66a969aa19a8c0 Mon Sep 17 00:00:00 2001 From: "Aaron S. Hawley" Date: Sun, 20 Oct 2019 19:19:49 -0400 Subject: [PATCH] Add CHANGELOG file for 2.0.0-M1 --- CHANGELOG.md | 61 ++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 4 ++++ 2 files changed, 65 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 000000000..c725ae694 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,61 @@ +# Scala XML Changes + +## 2.0.0-M1 (2019-10-21) + +Not binary compatible with Scala XML 1.2.0. + +Published for Scala 2.12, 2.13 and Scala.js 0.6, 1.0.0-M8. +Artifacts are no longer published for Scala 2.11. + +There have been a number of deprecated elements that have been +removed, see the "[Removed](#Removed)" section below. + +### Added + +- The `apiURL` is now published in ivy metadata so that hyperlinks + exist in downstream projects that reference Scala XML in their + Scaladocs. + +### Changed + +- Changed use of `scala.collection.mutable.Stack` in `FactoryAdapter` to a + `scala.collection.immutable.List`. These members were affected. + - `attribStack` + - `hStack` + - `tagStack` + - `scopeStack` +- The abstract class `FactoryAdapter`, see above, is used elsewhere + within the library, as well, so the previous changes are also + inherited by: + - `scala.xml.parsing.NoBindingFactoryAdapter` implemented class + - `scala.xml.factory.XMLLoader.adapter` static member + +### Fixed + +- Attribute order is preserved for XML elements, not reversed. +- Don't escape quotes in `scala.xml.PCData` and `CDATA` as an XML `"` + +### Removed + +Most of these deletions are of vestigial code that is either unused, +of poor quality or both. Very few users of Scala XML will even notice +the removed parts. Most users will not be affected. + +The deletions represent about one thousand lines of code (sloc). By +comparison Scala XML is 10,000 sloc, so this is about 10% reduction in +sloc. The code that supports XML literals is maintained upstream in +the Scala compiler, not in the Scala XML library. + +- Remove deprecated `scala.xml.pull.XMLEventReader` +- Remove deprecated versions of `scala.xml.Elem` constructors +- Remove deprecated `scala.xml.Elem.xmlToProcess` and + `scala.xml.Elem.processXml` +- Remove deprecated definitions under `scala.xml.persistent` + - `CachedFileStorage` + - `Index` + - `SetStorage` +- Remove `scala.xml.dtd.impl.PointedHedgeExp` +- Remove `scala.xml.dtd.Scanner` +- Remove `scala.xml.dtd.ContentModelParser` +- Remove `scala.xml.factory.Binder` +- Remove `scala.xml.parsing.ValidatingMarkupHandler` diff --git a/README.md b/README.md index adfde8bae..84bcfe1ef 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,10 @@ API documentation is available [here](https://scala.github.io/scala-xml/api/1.2. How to documentation is available in the [wiki](https://github.com/scala/scala-xml/wiki) +The latest stable release of Scala XML is 1.2.0. + +Milestone releases of Scala XML version 2.0 are available, starting with 2.0.0-M1. See the changes for 2.0 in `CHANGELOG.md`. + ## Maintenance status This library is community-maintained. The lead maintainer is [@aaron_s_hawley](https://github.com/ashawley).