Move RELEASE_NOTES into the docs subdirectory
authorDan Scott <dscott@laurentian.ca>
Tue, 20 Dec 2011 16:54:30 +0000 (11:54 -0500)
committerBill Erickson <berick@esilibrary.com>
Fri, 20 Jan 2012 18:54:56 +0000 (13:54 -0500)
We will begin maintaining release notes inside the source directory,
with one RELEASE_NOTES.txt file per major release series (2.2, 2.3,
etc). The release notes will primarily consist of an overview of new
features and important behaviour changes in that particular release
series, as well as a cumulative list of bugs that have been fixed in the
point releases for that series.

Also, mention the existence of the release notes in the top-level
README.

Signed-off-by: Dan Scott <dscott@laurentian.ca>
Signed-off-by: Bill Erickson <berick@esilibrary.com>
README
RELEASE_NOTES [deleted file]
docs/RELEASE_NOTES_2_2.txt [new file with mode: 0644]

diff --git a/README b/README
index e476035..3339df7 100644 (file)
--- a/README
+++ b/README
@@ -1,6 +1,9 @@
 README for Evergreen master
 ===========================
 
+See `docs/RELEASE_NOTES_2_2.txt` for new features, changes to behavior, and
+bug fixes for the 2.2 release series.
+
 Preamble: referenced user accounts
 ----------------------------------
 
diff --git a/RELEASE_NOTES b/RELEASE_NOTES
deleted file mode 100644 (file)
index 61d0a7a..0000000
+++ /dev/null
@@ -1,53 +0,0 @@
-Release notes
-=============
-
-Upgrade notes
--------------
-
-Located URI search scope
-~~~~~~~~~~~~~~~~~~~~~~~~
-Recognizing that electronic resources are often licensed for an entire library
-system rather than just a single library, the search scope for located URIs has
-changed to match from the highest point in the hierarchy down, rather than from
-the bottom up. In previous releases of Evergreen, if you had a MARC record with
-a URI located at 'BR1', a search for that record at the 'SYS1' scope would
-include the record in its results. The current release of Evergreen would not
-include the record in its results; the scope needs to be set at the level of
-'BR1' in the hierarchy or below.
-
-Therefore, you may want to run a SQL statement like the following, edited to
-match the short names of your branches and systems, to change the located
-URIs so that searches at the system level continue to return results for
-located URIs:
-
-------------------------------------------------------------------------------
-UPDATE biblio.record_entry
-    SET marc = replace(
-        replace(
-            marc, 
-            '<subfield code="9">BR1</subfield>',
-            '<subfield code="9">SYS1</subfield>'
-        ),
-        '<subfield code="9">BR3</subfield>',
-        '<subfield code="9">SYS2</subfield>'
-    ) WHERE marc LIKE '<subfield code="9">BR1</subfield>'
-        OR marc LIKE '<subfield code="9">BR3</subfield>'
-;
-------------------------------------------------------------------------------
-
-New features
-------------
-
-Cataloging
-~~~~~~~~~~
-
-Prevent bibliographic records from having attached copies
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-To enable libraries to designate specific sets of records as only for use
-as electronic resources, it is possible to configure a bibliographic source
-such that physical copies or MFHD records may not be attached to records
-from that source. The 'config.bib_source' table now includes a new Boolean
-column, 'can_have_copies', that controls this behavior. If 'can_have_copies'
-for a given bibliographic source is 'TRUE', then the staff client will prevent
-a cataloger from adding volumes or MFHD records to records belonging to that
-source.
diff --git a/docs/RELEASE_NOTES_2_2.txt b/docs/RELEASE_NOTES_2_2.txt
new file mode 100644 (file)
index 0000000..61d0a7a
--- /dev/null
@@ -0,0 +1,53 @@
+Release notes
+=============
+
+Upgrade notes
+-------------
+
+Located URI search scope
+~~~~~~~~~~~~~~~~~~~~~~~~
+Recognizing that electronic resources are often licensed for an entire library
+system rather than just a single library, the search scope for located URIs has
+changed to match from the highest point in the hierarchy down, rather than from
+the bottom up. In previous releases of Evergreen, if you had a MARC record with
+a URI located at 'BR1', a search for that record at the 'SYS1' scope would
+include the record in its results. The current release of Evergreen would not
+include the record in its results; the scope needs to be set at the level of
+'BR1' in the hierarchy or below.
+
+Therefore, you may want to run a SQL statement like the following, edited to
+match the short names of your branches and systems, to change the located
+URIs so that searches at the system level continue to return results for
+located URIs:
+
+------------------------------------------------------------------------------
+UPDATE biblio.record_entry
+    SET marc = replace(
+        replace(
+            marc, 
+            '<subfield code="9">BR1</subfield>',
+            '<subfield code="9">SYS1</subfield>'
+        ),
+        '<subfield code="9">BR3</subfield>',
+        '<subfield code="9">SYS2</subfield>'
+    ) WHERE marc LIKE '<subfield code="9">BR1</subfield>'
+        OR marc LIKE '<subfield code="9">BR3</subfield>'
+;
+------------------------------------------------------------------------------
+
+New features
+------------
+
+Cataloging
+~~~~~~~~~~
+
+Prevent bibliographic records from having attached copies
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+To enable libraries to designate specific sets of records as only for use
+as electronic resources, it is possible to configure a bibliographic source
+such that physical copies or MFHD records may not be attached to records
+from that source. The 'config.bib_source' table now includes a new Boolean
+column, 'can_have_copies', that controls this behavior. If 'can_have_copies'
+for a given bibliographic source is 'TRUE', then the staff client will prevent
+a cataloger from adding volumes or MFHD records to records belonging to that
+source.