Add references to configuration values in the changelog

docs/changelog.rst

@@ -56,12 +56,13 @@ New features:
   without storing or writing them.
 - :doc:`plugins/convert`: Add a config option to disable writing metadata to
   converted files.
-- :doc:`plugins/discogs`: New config option `strip_disambiguation` to toggle
+- :doc:`plugins/discogs`: New config option
-  stripping discogs numeric disambiguation on artist and label fields.
+  :conf:`plugins.discogs:strip_disambiguation` to toggle stripping discogs
+  numeric disambiguation on artist and label fields.
 - :doc:`plugins/discogs` Added support for featured artists. :bug:`6038`
-- :doc:`plugins/discogs` New configuration option `featured_string` to change
+- :doc:`plugins/discogs` New configuration option
-  the default string used to join featured artists. The default string is
+  :conf:`plugins.discogs:featured_string` to change the default string used to
-  `Feat.`.
+  join featured artists. The default string is `Feat.`.
 - :doc:`plugins/discogs` Support for `artist_credit` in Discogs tags.
   :bug:`3354`
 - :doc:`plugins/discogs` Support for name variations and config options to
@@ -89,9 +90,10 @@ Bug fixes:
 - :doc:`/plugins/fromfilename`: Fix :bug:`5218`, improve the code (refactor
   regexps, allow for more cases, add some logging), add tests.
 - Metadata source plugins: Fixed data source penalty calculation that was
-  incorrectly applied during import matching. The ``source_weight``
+  incorrectly applied during import matching. The
-  configuration option has been renamed to ``data_source_mismatch_penalty`` to
+  :conf:`plugins.index:source_weight` configuration option has been renamed to
-  better reflect its purpose. :bug:`6066`
+  :conf:`plugins.index:data_source_mismatch_penalty` to better reflect its
+  purpose. :bug:`6066`
 
 Other changes:
 
@@ -137,12 +139,13 @@ New features:
   separate plugin. The default :ref:`plugins-config` includes ``musicbrainz``,
   but if you've customized your ``plugins`` list in your configuration, you'll
   need to explicitly add ``musicbrainz`` to continue using this functionality.
-  Configuration option ``musicbrainz.enabled`` has thus been deprecated.
+  Configuration option :conf:`plugins.musicbrainz:enabled` has thus been
-  :bug:`2686` :bug:`4605`
+  deprecated. :bug:`2686` :bug:`4605`
 - :doc:`plugins/web`: Show notifications when a track plays. This uses the Media
   Session API to customize media notifications.
-- :doc:`plugins/discogs`: Add configurable ``search_limit`` option to limit the
+- :doc:`plugins/discogs`: Add configurable :conf:`plugins.discogs:search_limit`
-  number of results returned by the Discogs metadata search queries.
+  option to limit the number of results returned by the Discogs metadata search
+  queries.
 - :doc:`plugins/discogs`: Implement ``track_for_id`` method to allow retrieving
   singletons by their Discogs ID. :bug:`4661`
 - :doc:`plugins/replace`: Add new plugin.
@@ -157,12 +160,13 @@ New features:
   be played for it to be counted as played instead of skipped.
 - :doc:`plugins/web`: Display artist and album as part of the search results.
 - :doc:`plugins/spotify` :doc:`plugins/deezer`: Add new configuration option
-  ``search_limit`` to limit the number of results returned by search queries.
+  :conf:`plugins.index:search_limit` to limit the number of results returned by
+  search queries.
 
 Bug fixes:
 
 - :doc:`plugins/musicbrainz`: fix regression where user configured
-  ``extra_tags`` have been read incorrectly. :bug:`5788`
+  :conf:`plugins.musicbrainz:extra_tags` have been read incorrectly. :bug:`5788`
 - tests: Fix library tests failing on Windows when run from outside ``D:/``.
   :bug:`5802`
 - Fix an issue where calling ``Library.add`` would cause the ``database_change``
@@ -194,9 +198,10 @@ Bug fixes:
 
 For packagers:
 
-- Optional ``extra_tags`` parameter has been removed from
+- Optional :conf:`plugins.musicbrainz:extra_tags` parameter has been removed
-  ``BeetsPlugin.candidates`` method signature since it is never passed in. If
+  from ``BeetsPlugin.candidates`` method signature since it is never passed in.
-  you override this method in your plugin, feel free to remove this parameter.
+  If you override this method in your plugin, feel free to remove this
+  parameter.
 - Loosened ``typing_extensions`` dependency in pyproject.toml to apply to every
   python version.
 
@@ -552,8 +557,9 @@ New features:
   :bug:`4348`
 - Create the parental directories for database if they do not exist. :bug:`3808`
   :bug:`4327`
-- :ref:`musicbrainz-config`: a new :ref:`musicbrainz.enabled` option allows
+- :ref:`musicbrainz-config`: a new :conf:`plugins.musicbrainz:enabled` option
-  disabling the MusicBrainz metadata source during the autotagging process
+  allows disabling the MusicBrainz metadata source during the autotagging
+  process
 - :doc:`/plugins/kodiupdate`: Now supports multiple kodi instances :bug:`4101`
 - Add the item fields ``bitrate_mode``, ``encoder_info`` and
   ``encoder_settings``.
@@ -586,8 +592,8 @@ New features:
   :bug:`4561` :bug:`4600`
 - :ref:`musicbrainz-config`: MusicBrainz release pages often link to related
   metadata sources like Discogs, Bandcamp, Spotify, Deezer and Beatport. When
-  enabled via the :ref:`musicbrainz.external_ids` options, release ID's will be
+  enabled via the :conf:`plugins.musicbrainz:external_ids` options, release ID's
-  extracted from those URL's and imported to the library. :bug:`4220`
+  will be extracted from those URL's and imported to the library. :bug:`4220`
 - :doc:`/plugins/convert`: Add support for generating m3u8 playlists together
   with converted media files. :bug:`4373`
 - Fetch the ``release_group_title`` field from MusicBrainz. :bug:`4809`
@@ -941,8 +947,9 @@ Other new things:
 
 - ``beet remove`` now also allows interactive selection of items from the query,
   similar to ``beet modify``.
-- Enable HTTPS for MusicBrainz by default and add configuration option ``https``
+- Enable HTTPS for MusicBrainz by default and add configuration option
-  for custom servers. See :ref:`musicbrainz-config` for more details.
+  :conf:`plugins.musicbrainz:https` for custom servers. See
+  :ref:`musicbrainz-config` for more details.
 - :doc:`/plugins/mpdstats`: Add a new ``strip_path`` option to help build the
   right local path from MPD information.
 - :doc:`/plugins/convert`: Conversion can now parallelize conversion jobs on
@@ -962,8 +969,8 @@ Other new things:
   server.
 - :doc:`/plugins/subsonicupdate`: The plugin now automatically chooses between
   token- and password-based authentication based on the server version.
-- A new :ref:`extra_tags` configuration option lets you use more metadata in
+- A new :conf:`plugins.musicbrainz:extra_tags` configuration option lets you use
-  MusicBrainz queries to further narrow the search.
+  more metadata in MusicBrainz queries to further narrow the search.
 - A new :doc:`/plugins/fish` adds `Fish shell`_ tab autocompletion to beets.
 - :doc:`plugins/fetchart` and :doc:`plugins/embedart`: Added a new ``quality``
   option that controls the quality of the image output when the image is
@@ -1017,9 +1024,9 @@ Other new things:
   (and now deprecated) separate ``host``, ``port``, and ``contextpath`` config
   options. As a consequence, the plugin can now talk to Subsonic over HTTPS.
   Thanks to :user:`jef`. :bug:`3449`
-- :doc:`/plugins/discogs`: The new ``index_tracks`` option enables incorporation
+- :doc:`/plugins/discogs`: The new :conf:`plugins.discogs:index_tracks` option
-  of work names and intra-work divisions into imported track titles. Thanks to
+  enables incorporation of work names and intra-work divisions into imported
-  :user:`cole-miller`. :bug:`3459`
+  track titles. Thanks to :user:`cole-miller`. :bug:`3459`
 - :doc:`/plugins/web`: The query API now interprets backslashes as path
   separators to support path queries. Thanks to :user:`nmeum`. :bug:`3567`
 - ``beet import`` now handles tar archives with bzip2 or gzip compression.
@@ -1033,9 +1040,9 @@ Other new things:
   :user:`logan-arens`. :bug:`2947`
 - There is a new ``--plugins`` (or ``-p``) CLI flag to specify a list of plugins
   to load.
-- A new :ref:`genres` option fetches genre information from MusicBrainz. This
+- A new :conf:`plugins.musicbrainz:genres` option fetches genre information from
-  functionality depends on functionality that is currently unreleased in the
+  MusicBrainz. This functionality depends on functionality that is currently
-  python-musicbrainzngs_ library: see PR `#266
+  unreleased in the python-musicbrainzngs_ library: see PR `#266
   <https://github.com/alastair/python-musicbrainzngs/pull/266>`_. Thanks to
   :user:`aereaux`.
 - :doc:`/plugins/replaygain`: Analysis now happens in parallel using the
@@ -1075,9 +1082,10 @@ Fixes:
   :bug:`3867`
 - :doc:`/plugins/web`: Fixed a small bug that caused the album art path to be
   redacted even when ``include_paths`` option is set. :bug:`3866`
-- :doc:`/plugins/discogs`: Fixed a bug with the ``index_tracks`` option that
+- :doc:`/plugins/discogs`: Fixed a bug with the
-  sometimes caused the index to be discarded. Also, remove the extra semicolon
+  :conf:`plugins.discogs:index_tracks` option that sometimes caused the index to
-  that was added when there is no index track.
+  be discarded. Also, remove the extra semicolon that was added when there is no
+  index track.
 - :doc:`/plugins/subsonicupdate`: The API client was using the ``POST`` method
   rather the ``GET`` method. Also includes better exception handling, response
   parsing, and tests.
@@ -2693,9 +2701,9 @@ Major new features and bigger changes:
   analysis tool. Thanks to :user:`jmwatte`. :bug:`1343`
 - A new ``filesize`` field on items indicates the number of bytes in the file.
   :bug:`1291`
-- A new :ref:`search_limit` configuration option allows you to specify how many
+- A new :conf:`plugins.index:search_limit` configuration option allows you to
-  search results you wish to see when looking up releases at MusicBrainz during
+  specify how many search results you wish to see when looking up releases at
-  import. :bug:`1245`
+  MusicBrainz during import. :bug:`1245`
 - The importer now records the data source for a match in a new flexible
   attribute ``data_source`` on items and albums. :bug:`1311`
 - The colors used in the terminal interface are now configurable via the new