Commits

Felix Krull committed a09e6e1

Update documentation.

Comments (0)

Files changed (3)

 - If the file contains a Musicbrainz album ID, that is used.
 - Otherwise, if the file contains an *album* tag, it is joined with either
 
+  * a MusicBrainz album artist ID, if that exists
   * an *albumartist* tag, if that exists,
   * or the *artist* tag
-  * or nothing if neither tag exists.
+  * or nothing if none of the above tags exist.
 
   The resulting artist-album combination is the album ID for that file.
 - If the file doesn't contain a Musicbrainz album ID or an *album* tag, it is
 processed and had Replay Gain added -- if **collectiongain** thinks so, that
 file will totally ignored for the actual run. This flag is set whenever the file
 is processed in the actual run phase (save for dry runs, which you can enable
-with the **--dry-run** switch) and is cleared whenever a file was changed. You can
-disable these assumptions with the **--ignore-cache** switch; in that case, the
-program will actually physically check every file in your collection for
-Replay Gain data.
+with the **--dry-run** switch) and is cleared whenever a file was changed. You
+can pass the **ignore-cache** switch to make **collectiongain** totally ignore
+the cache; in that case, it will behave as if no cache was present and read your
+collection from scratch.
 
 For the actual run, **collectiongain** will simply look at all files that have
 survived the cleansing described above; for files that don't contain Replay Gain
 - Work around a bug in some pygobject 3.10 releases
   (https://bugzilla.gnome.org/show_bug.cgi?id=710447)
 - Properly recognise file extensions even with different capitalisation.
+- Overhaul album ID algorithm to be hopefully better at grouping files that
+  belong to an album and, conversely, not mis-grouping files. Note that this
+  change will invalidate any cache files you might still have so your entire
+  collection will be re-scanned next time you run **collectiongain**.
 
 rgain 1.2.1 (2013-10-18)
 ------------------------

man/collectiongain.rst

 ===========
 
 **collectiongain** is a script calculating the Replay Gain values of a large set of
-music files inside *music_dir*. Each audio file will be rectified against the
-other files of the same album, which are identified using the file tags.
+music files inside *music_dir*. Files belonging to the same album will be identified
+using the file tags and album Replay Gain data will be calculated for them.
 
 OPTIONS
 =======
 DESCRIPTION
 ===========
 
-**replaygain** applies or displays Replay Gain information for audio files.
+**replaygain** applies or displays Replay Gain information for audio files. By
+default, all given files be assumed to be part of a single album and album gain
+data will be calculated for them.
 
 OPTIONS
 =======