From a64dea25b2879ecc069330100bd4e58ab883ab03 Mon Sep 17 00:00:00 2001 From: Adrian Sampson Date: Sun, 15 Apr 2012 14:24:52 -0700 Subject: [PATCH] docs for @djrtl's changes (#30) --- beets/ui/commands.py | 2 +- docs/changelog.rst | 6 ++++++ docs/reference/cli.rst | 11 ++++++++++- docs/reference/pathformat.rst | 11 ++++------- 4 files changed, 21 insertions(+), 9 deletions(-) diff --git a/beets/ui/commands.py b/beets/ui/commands.py index 550bbce6d..9c8fb0e98 100644 --- a/beets/ui/commands.py +++ b/beets/ui/commands.py @@ -732,7 +732,7 @@ import_cmd.parser.add_option('-L', '--library', dest='library', action='store_true', help='retag items matching a query') import_cmd.parser.add_option('-i', '--incremental', dest='incremental', action='store_true', help='skip already-imported directories') -import_cmd.parser.add_option('-I', '--no-incremental', dest='incremental', +import_cmd.parser.add_option('-I', '--noincremental', dest='incremental', action='store_false', help='do not skip already-imported directories') def import_func(lib, config, opts, args): copy = opts.copy if opts.copy is not None else \ diff --git a/docs/changelog.rst b/docs/changelog.rst index 6cdb14934..4d8a9e12e 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -34,6 +34,10 @@ Changelog * New :doc:`/plugins/importfeeds`: Catalog imported files in ``m3u`` playlist files or as symlinks for easy importing to other systems. Thanks to Fabrice Laporte. +* A new command ``beet fields`` displays the available metadata fields (thanks + to Matteo Mecucci). +* The ``import`` command now has a ``--noimport`` or ``-I`` flag to disable + incremental imports (thanks to Matteo Mecucci). * When the autotagger fails to find a match, it now displays the number of tracks on the album (to help you guess what might be going wrong) and a link to the FAQ. @@ -45,6 +49,8 @@ Changelog config option `. * :doc:`/plugins/bpd`: Use Gstreamer's ``playbin2`` element instead of the deprecated ``playbin``. +* :doc:`/plugins/bpd`: Listings are now sorted (thanks once again to Matteo + Mecucci). * Filenames are normalized with Unicode Normal Form D (NFD) on Mac OS X and NFC on all other platforms. diff --git a/docs/reference/cli.rst b/docs/reference/cli.rst index 2d65e93ed..830002c36 100644 --- a/docs/reference/cli.rst +++ b/docs/reference/cli.rst @@ -77,7 +77,7 @@ right now; this is something we need to work on. Read the option to run an *incremental* import. With this flag, beets will keep track of every directory it ever imports and avoid importing them again. This is useful if you have an "incoming" directory that you periodically - add things to. + add things to. (The ``-I`` flag disables incremental imports.) * By default, beets will proceed without asking if it finds a very close metadata match. To disable this and have the importer as you every time, @@ -214,6 +214,15 @@ stats Show some statistics on your entire library (if you don't provide a :doc:`query ` or the matched items (if you do). +fields +`````` +:: + + beet fields + +Show the item and album metadata fields available for use in :doc:`query` and +:doc:`pathformat`. + Global Flags ------------ diff --git a/docs/reference/pathformat.rst b/docs/reference/pathformat.rst index fbc5228be..cc5704d74 100644 --- a/docs/reference/pathformat.rst +++ b/docs/reference/pathformat.rst @@ -104,13 +104,10 @@ like ````. Available Values ---------------- -Here's a (comprehensive?) list of the different values available to path -formats. (I will try to keep it up to date, but I might forget. The current list -can be found definitively `in the source`_.) Note that plugins can add new (or -replace existing) template values (see :ref:`writing-plugins`). - -.. _in the source: - https://github.com/sampsyo/beets/blob/master/beets/library.py#L39 +Here's a list of the different values available to path formats. The current +list can be found definitively by running the command ``beet fields``. Note that +plugins can add new (or replace existing) template values (see +:ref:`writing-plugins`). Ordinary metadata: