Commit graph

219 commits

Author SHA1 Message Date
x1ppy
19d6dfc8f3 Support extra tags for MusicBrainz queries 2020-03-20 14:13:40 -04:00
Ian Pickering
dd85a88ba5 Correct documentation of incremental_skip_later flag
The behavior is actually the opposite of what is documented.
2019-09-11 20:14:30 -07:00
FichteFoll
aa31fea037
Update a lot of URLs to use HTTPS
*All* URLs were checked manually, but only once per domain!

I mostly concerned myself with URLs in documentation rather than source
code because the latter may or may not have impactful changes, while the
former should be straight forward.

Changes in addition to simply adding an s:

- changed pip and pypi references as their location has changed
- MPoD (iOS app) url redirects to Regelian, so I replaced those
- updated homebrew references

Notable observations:

- beets.io does have HTTPS set up properly (via gh-pages)
- beatport.py uses the old HTTP url for beatport
- as does lyrics.py for lyrics.wikia.com
- https://tomahawk-player.org/ expired long ago, but the http page
  redirects to https regardless
- none of the sourceforge subdomains have https (in 2019!)
2019-06-05 03:11:49 +02:00
Carl Suster
aa9e39327d docs: document 'quiet' config item 2019-06-02 22:25:26 +10:00
Thomas McWork
0e93b0f58d
follow comment explanation 2019-04-06 09:29:15 +02:00
Thomas McWork
4cbe116e42
use most simple syntax 2019-04-01 09:13:36 +02:00
Thomas McWork
1916fe0ad5
Provide an example for the languages list
It's hard to impossible to figure out the correct syntax for non python users.
2019-03-31 13:06:27 +02:00
jroitgrund
6a8444a3fd
Further clarify 2019-03-23 15:03:57 +00:00
jroitgrund
a46d5282be
Clarify description of incremental_skip_later 2019-03-23 14:57:56 +00:00
malan88
d1ba56e246
Simplify wording, exclude ref to distance_weights
Per conversation with Adrian, simplify the wording of the change.
2019-03-07 10:41:37 -05:00
malan88
2cef079603
Improve specifications in the matches.ignored setting
The setting is quite confusing. After having difficulty getting the autotagger to accept an id for a specific release that I knew was correct, I investigated and count [this closed issue][0] that totally explains the problem.

To clarify the issue, I quoted Adrian from the issue and elaborated a bit, providing the solution. Unfortunately, the solution is undocumented. I'd like to document it, but I am unsure what the actual weighting system in `distance_weights` is. Adrian says 0.9 to ignore missing_tracks, which implies it's similar to the distance weighting in the other settings, but other settings in the default config are set to multiples of 1, implying it is not.

[0]: https://github.com/beetbox/beets/issues/3064
2019-03-07 09:39:34 -05:00
David Logie
604616050b Address PR comments.
- Rename config option to overwrite_null
- Leave overwrite_null empty by default
- Handle more potentially null fields for both album and tracks
- Remove documentation and changelog entries for now
2019-01-26 11:17:17 +00:00
David Logie
1f356d66a6 First attempt at fixing #3132.
Add a new `no_clobber` config option that contains a list of
"miscellaneous" metadata fields not to be overwritten by empty values.

I'm not entirely happy with the `no_clobber` name. Suggestions welcome.
2019-01-25 14:07:43 +00:00
Adrian Sampson
d35a68d0d8 Refine writing/links for #3116 2019-01-12 14:20:16 -08:00
RollingStar
1d0af470a5
More details on self-hosting musicbrainz
Document important facts for self-hosting musicbrainz with beets. I don't want the beets docs to be the go-to reference for hosting MusicBrainz, but the search index requirement is not explained well on the beets wiki.

Full disclosure, I haven't finished building my index yet so I'm not sure if that is actually why I can't self-host right now. But I remember doing it before to fix beets integration with my Musicbrainz server.
2019-01-12 16:04:13 -05:00
Frederik “Freso” S. Olesen
b380a4c9a3
docs: Fix typo: anique → aunique
Reported by M1dgard on IRC
2018-11-04 12:02:06 +01:00
Adrian Sampson
3ddf3ef58a
Merge pull request #3022 from beetbox/default-ignore-data-tracks
Make `ignore_data_tracks` `yes` by default
2018-09-05 23:13:44 -04:00
David Logie
57b268923f Split release and release-group disambiguation into separate fields. 2018-09-05 12:45:19 +01:00
David Logie
86d75cfad7 Allow setting default options for %unique in the configuration file. 2018-09-04 18:14:24 +01:00
Filipe Fortes
1701aefe5c Make ignore_data_tracks yes by default 2018-09-04 10:04:17 -04:00
Filipe Fortes
5e518c7d9e Set bug number 2018-09-02 11:02:56 -04:00
Filipe Fortes
210b9d316f Allow ignoring of audio data tracks on import 2018-09-02 10:09:10 -04:00
Denis Defreyne
0202d762bf
Add artist_credit config option 2018-04-08 08:29:06 +02:00
Adrian Sampson
bfeb678e41 No media are ignored by default (#2776)
We determined on the PR thread that ignoring video tracks is enough, and
ignoring typically-video media has more pitfalls.
2018-02-08 17:28:05 -05:00
Michael Yoo
94b779e7b4 New importer option incremental_skip_later, fixes #2773 2018-01-04 21:53:45 +10:30
Nicolas Guillaumin
816de1c3da Rename setting to ignored_media for consistency 2018-01-02 15:04:00 -08:00
Nicolas Guillaumin
22c4f9cb97 Added a setting to control which formats are ignored
This is related to #2688 where a list of hard-coded non-audio formats to
ignore has been added. Some users may want to rip the audio portion of
video tracks (e.g. DVD-Video) so it would be beneficial to let them
control exactly which formats to ignore.

I added a `ignored_formats` setting for that purpose and moved the
hard-coded list into the config. Test and documentation have been
updated accordingly.

Aside: I also clarified the changelog a bit regarding this change and
the related one for #1210.
2018-01-02 11:03:02 -08:00
Nicolas Guillaumin
d325bceb1d Added a setting to control if video tracks are ignored
Users may want to keep tracking video tracks, for example if they rip
the audio part of the video tracks. Added a setting to allow this.
2017-12-31 10:46:48 -08:00
Adrian Sampson
0fd27e1c54 Fix tiny typo in #2755 2017-12-16 15:00:50 -05:00
tummychow
e848adab04 Implement from_scratch option
Fixes #934, and also helps with #1173.
2017-12-07 14:46:40 -05:00
Meet Udeshi
1646da4d9c Add comments and explain merge feature in config docs and guide 2017-11-04 03:08:53 +05:30
Adrian Sampson
71d6dc3544 Docs refinements for #2581 2017-06-13 09:27:42 -04:00
Bart Kleijngeld
52d5d2310b refactoring according to feedback in pull request 2017-06-12 16:46:09 +02:00
Bart Kleijngeld
91722aea36 added documentation 2017-05-30 21:29:49 +02:00
Matt Murch
e224621e83 Add default replace for - to _
Also updated changelog and docs.

Resolves: #549
2017-04-12 13:48:37 -04:00
Adrian Sampson
70ef6e7df8 Fix heading underline length 2017-03-27 23:23:23 -04:00
SpirosChadoulos
218968235e small changes for the bell issue 2017-03-28 01:09:14 +03:00
SpirosChadoulos
c605a918c8 Added an if statement that allows the bell ring according to the user's configuration. 2017-03-27 20:49:28 +03:00
Adrian Sampson
d10bfa1af6 Changelog & thanks for #2445 2017-02-20 22:11:34 -05:00
Jacob Gillespie
4e77ef4484 Address review comments 2017-02-19 20:48:34 -06:00
Jacob Gillespie
1fd22604fb Fix linter issues 2017-02-19 17:33:26 -06:00
Jacob Gillespie
b4efecb709 Add option to hardlink when importing 2017-02-19 15:56:13 -06:00
A.L. Kleijngeld
24027d1bf8 Update config.rst: see issue #2410
`When a match is above the *medium* recommendation threshold`
->
`When a match is below the *medium* recommendation threshold`

As discussed in issue #2410, which is fixed by this edit.
2017-01-27 21:48:46 +01:00
diomekes
5ee89666b6 fix typo in config docs 2017-01-07 09:54:54 -05:00
Adrian Sampson
f621d7f4f1 Merge pull request #1992 from jackwilsdon/add-write-bpm
Add write option to bpm plugin
2017-01-01 23:09:41 -05:00
Adrian Sampson
8cb6ff3892 Simplify the example config
I never meant for people to copy and paste this example---it's redundant and
probably wrong---but lots of people do! Removing a few weird options makes the
example clearer, I think, and will result in less-strange initial configs for
people who do copy & paste.
2017-01-01 19:18:25 -05:00
Stefano Rivera
bcb1f8036a Correct a typo
Spotted by lintian which runs spellchecks on man pages.
2016-08-29 16:29:32 -07:00
Dixon Xavier
80ca527f76 Fix typo in documentation 2016-06-19 13:20:54 +05:30
Dixon Xavier
fbcc8dbf1e Update changelog and documentation 2016-06-19 12:54:27 +05:30
Adrian Sampson
a440e44abd Proofread the changelog 2016-05-31 10:33:56 -07:00
Johnny Robeson
c1a168590c add lost+found directory to default ignore list 2016-05-06 20:51:37 -04:00
Jack Wilsdon
2d5c68cec9 Remove write option from bpm and use import.write 2016-05-06 17:50:27 +01:00
Jack Wilsdon
38a3726b1b Add documentation 2016-05-06 00:45:45 +01:00
Guilherme Danno
8c471581e0 Use the 'terminal_encoding' option for overriding the sys.stdin.encoding in some cases (#1964)
* Use the 'terminal_encoding' option for overriding the `sys.stdin.encoding` in some cases
* Add the documentation
2016-04-28 00:17:19 -03:00
Sven-Hendrik Haase
a942719ffc Fix grammar 2016-02-03 20:38:29 +01:00
Adrian Sampson
98f48237f5 Tiny docs tweaks for #1708 2015-11-08 13:04:26 -08:00
Manfred Urban
95b80b37aa Updated documentation 2015-11-08 17:04:36 +01:00
Adrian Sampson
80bfd186ae Use should_write for modify, update, and mbsync
This should address the surprising situation in #1697, where `import` went
fine but then `update` unexpectedly changed filenames.
2015-11-07 13:34:47 -08:00
Adrian Sampson
f4a617e641 Move color option in config example (fix #1653) 2015-10-19 13:44:52 -07:00
David Logie
bfc5a1b803 Add new `include` config option.
This new option allows users to provide a list of external config files
which will be evaluated when beets starts.

This is useful for keeping private settings (e.g. API keys) out of the
main configuration file.
2015-10-05 14:01:26 +01:00
Adrian Sampson
f8d9019d1b Better explanation of threaded option
It was pointed out that the old wording was too worrisome.
2015-09-06 17:14:55 -07:00
Ben Boeckel
323f79ecdb colors: support standard terminal colors
Fixes #1548.

Signed-off-by: Ben Boeckel <mathstuf@gmail.com>
2015-08-05 22:00:25 -04:00
Ben Ockmore
1f1e0f7240 Added warning message and paragraph about replacements/max length interaction in documentation. 2015-07-07 17:46:42 +01:00
Adrian Sampson
419a12a2f2 Further clarify docs for #1493 2015-06-02 19:54:16 -07:00
Adrian Sampson
bc9caa5845 Update docs for #1493/#1104 2015-06-02 19:38:30 -07:00
Rui Gonçalves
93c8f834f0 Add support for pregap tracks 2015-06-03 00:54:25 +01:00
Adrian Sampson
7f5c274c46 Grouped-album tasks have paths
Close #1475, fix #825.
2015-05-25 12:57:23 -07:00
Tom Jaspers
0302c44909 Docs & changelog for case insensitive sort 2015-04-18 10:27:56 +02:00
Bruno Cauet
679b0a586b Remove list_format_{album,item} sections from docs 2015-03-07 13:45:58 +01:00
Bruno Cauet
f14f47f059 Renamed list_format_* into format_* 2015-03-04 16:51:28 +01:00
Tom Jaspers
ea687baebd Configurable colors: update documentation and changelog 2015-01-29 14:05:00 +01:00
Frederik “Freso” S. Olesen
ad00c5dc7b docs: Fix hyperlink targets.
I inserted musicbrainz.searchlimit at the wrong place, breaking the
hyperlink target `match-config` - and I also forgot to add a hyperlink
target for `searchlimit`.
2015-01-19 02:24:32 +01:00
Frederik “Freso” S. Olesen
7c429e8c58 docs: New entry for musicbrainz.searchlimit config option. 2015-01-19 02:19:43 +01:00
Adrian Sampson
a197a12c3a Mention #130 in docs 2014-12-15 04:36:01 +00:00
Adrian Sampson
c6af552703 docs: item_linked event (#710) 2014-11-15 12:21:14 -08:00
Adrian Sampson
1eebb6af3c Docs for link option (#710) 2014-11-15 12:07:49 -08:00
Adrian Sampson
5f2ca0b75b Rename smartartist to artist/albumartist (#953)
This is basically always what you want, so now you can just use the name of
the field without "smart".
2014-09-16 14:53:16 -07:00
Adrian Sampson
eb579cf14b Merge pull request #823 from PierreRust/sortquery
Sorting support in beets query mecanism (dbcore)
2014-08-22 14:59:44 -07:00
Adrian Sampson
d5910b4e85 Docs tweaks 2014-08-10 16:20:17 -07:00
Thomas Scholtes
f1388eb23d docs: Add note for 'replace' config and unicode 2014-08-06 18:00:18 +02:00
Thomas Scholtes
76c7ba9186 Add asciify_paths configuration option 2014-08-06 17:53:44 +02:00
Adrian Sampson
b6582e417f Changelog and doc fixes for #852 2014-07-02 14:51:41 -07:00
oprietop
8a4c668218 Documenting #852 2014-07-02 09:27:58 +02:00
Adrian Sampson
16f6a3daa7 Note about group-albums and import log (#825) 2014-06-25 10:05:31 -07:00
Pierre Rust
486289b11a Add documentation about default sort configuration. 2014-06-15 22:32:25 +02:00
Adrian Sampson
9101b88499 Slightly shorter description of autotag
Brevity is the soul of documentation.
2014-04-29 21:57:39 -07:00
Evan Purkhiser
63fc7e04e6 docs: Document 'import.autotag' configuration 2014-04-30 00:14:49 -04:00
Adrian Sampson
882d2305c0 docs: emphasize that you create config.yaml
This is, shockingly, the #1 question I get asked. I hope this helps.
2014-03-21 17:55:18 -07:00
Adrian Sampson
b0fd64662d update docs for #619 2014-03-19 10:34:03 -07:00
Adrian Sampson
f71307f87e changelog for #570 2014-03-06 11:00:00 -08:00
Adrian Sampson
692645466e documentation expansion for config command (#552) 2014-02-28 09:31:10 -08:00
Thomas Scholtes
c345df9155 Merge branch 'config_command'
Conflicts:
	beets/ui/commands.py
	docs/reference/config.rst
	test/_common.py
2014-02-28 16:50:06 +01:00
Adrian Sampson
8ddf04e711 refine config location discussion (#513) 2014-02-21 21:22:55 -05:00
Adrian Sampson
622ca2b244 Unixy location is fallback on OS X
This is mainly for backwards compatibility. It's also an effort to reduce the
support burden; this way, I can say "your config directory is ~/.config/beets"
without needing to ascertain whether someone is on a Mac.
2014-02-21 20:57:06 -05:00
Thomas Scholtes
575dc9d0c1 Documentation for config command 2014-02-18 21:29:31 +01:00
Thomas Scholtes
d0e5b411cf Documentation for configuration location 2014-02-18 18:24:49 +01:00
Adrian Sampson
5d55312fdb add TOCs to some documentation 2014-02-16 19:25:26 -08:00
Adrian Sampson
276a09bad7 clean up --config handling
In reference to a363d9672f. This helps preserve
modularity/readability by avoiding contamination of the subcommand logic with
beets-specific logic.
2014-02-13 13:46:20 -08:00
Thomas Scholtes
ba226f566d Update docs for fix a363d967 2014-02-10 17:29:23 +01:00
Adrian Sampson
5e2f7d6fcc remove some anachronisms from the docs 2014-02-07 19:55:07 -08:00