From d078214947fe1b5332d02ae4a42a86f84cb049e6 Mon Sep 17 00:00:00 2001 From: Adrian Sampson Date: Mon, 15 Dec 2014 04:34:20 +0000 Subject: [PATCH] Remove migration docs --- docs/changelog.rst | 6 ++--- docs/guides/index.rst | 1 - docs/guides/migration.rst | 52 --------------------------------------- 3 files changed, 2 insertions(+), 57 deletions(-) delete mode 100644 docs/guides/migration.rst diff --git a/docs/changelog.rst b/docs/changelog.rst index ac673d148..36f559e28 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -1015,8 +1015,7 @@ the new configuration system. The album art and lyrics plugins also got a little love. If you're upgrading from 1.0.0 or earlier, this release (like the 1.1 betas) -will automatically migrate your configuration to the new system. See -:doc:`/guides/migration`. +will automatically migrate your configuration to the new system. * :doc:`/plugins/embedart`: The ``embedart`` command now embeds each album's associated art by default. The ``--file`` option invokes the old behavior, @@ -1236,8 +1235,7 @@ Other new stuff: This release entirely revamps beets' configuration system. The configuration file is now a `YAML`_ document and is located, along with other support files, -in a common directory (e.g., ``~/.config/beets`` on Unix-like systems). If -you're upgrading from an earlier version, please see :doc:`/guides/migration`. +in a common directory (e.g., ``~/.config/beets`` on Unix-like systems). .. _YAML: http://en.wikipedia.org/wiki/YAML diff --git a/docs/guides/index.rst b/docs/guides/index.rst index 9269b249e..ff538eec6 100644 --- a/docs/guides/index.rst +++ b/docs/guides/index.rst @@ -11,4 +11,3 @@ guide. main tagger advanced - migration diff --git a/docs/guides/migration.rst b/docs/guides/migration.rst deleted file mode 100644 index c00296e58..000000000 --- a/docs/guides/migration.rst +++ /dev/null @@ -1,52 +0,0 @@ -Upgrading from 1.0 -================== - -Prior to version 1.1, beets used a completely different system for -configuration. The config file was in "INI" syntax instead of `YAML`_ and the -various files used by beets were (messily) stored in ``$HOME`` instead of a -centralized beets directory. If you're upgrading from version 1.0 or earlier, -your configuration syntax (and paths) need to be updated to work with the -latest version. - -Fortunately, this should require very little effort on your part. When you -first run beets 1.1, it will look for an old-style ``.beetsconfig`` to -migrate. If it finds one (and there is no new-style -``config.yaml`` yet), beets will warn you and then -transparently convert one to the other. At this point, you'll likely want to: - -* Look at your new configuration file (find out where in - :doc:`/reference/config`) to make sure everything was migrated correctly. -* Remove your old configuration file (``~/.beetsconfig`` on Unix; - ``%APPDATA%\beetsconfig.ini`` on Windows) to avoid confusion in the future. - -You might be interested in the :doc:`/changelog` to see which configuration -option names have changed. - -What's Migrated ---------------- - -Automatic migration is most important for the configuration file, since its -syntax is completely different, but two other files are also moved. This is to -consolidate everything beets needs in a single directory instead of leaving it -messily strewn about in your home directory. - -First, the library database file was at ``~/.beetsmusic.blb`` on Unix and -``%APPDATA%\beetsmusic.blb`` on Windows. This file will be copied to -``library.db`` in the same directory as your new configuration file. Finally, -the runtime state file, which keeps track of interrupted and incremental -imports, was previously known as ``~/.beetsstate``; it is copied to a file -called ``state.pickle``. - -Feel free to remove the old files once they've been copied to their new homes. - -Manual Migration ----------------- - -If you find you need to re-run the migration process, just type ``beet -migrate`` in your shell. This will migrate the configuration file, the -database, and the runtime state file all over again. Unlike automatic -migration, no step is suppressed if the file already exists. If you already -have a ``config.yaml``, for example, it will be renamed to make room for the -newly migrated configuration. - -.. _YAML: http://en.wikipedia.org/wiki/YAML