From eb6833475eeafce1e66b5c6344ac115d114d42b1 Mon Sep 17 00:00:00 2001 From: lilydjwg Date: Thu, 20 Aug 2020 15:23:05 +0800 Subject: [PATCH] partial updates to README --- NEW | 1 - README.rst | 40 ++-------------------------------------- 2 files changed, 2 insertions(+), 39 deletions(-) diff --git a/NEW b/NEW index 226c730..a32414f 100644 --- a/NEW +++ b/NEW @@ -1,5 +1,4 @@ TODO: -* update tests * update README * create source plugin documentation * a script to convert old ini into new toml files diff --git a/README.rst b/README.rst index 9982092..3a1a9aa 100644 --- a/README.rst +++ b/README.rst @@ -240,17 +240,6 @@ regex When multiple version strings are found, the maximum of those is chosen. -proxy - The HTTP proxy to use. The format is ``host:port``, e.g. ``localhost:8087``. - -user_agent - The ``User-Agent`` header value to use. Use something more like a tool (e.g. ``curl/7.40.0``) in Europe or the real web page won't get through because cookie policies (SourceForge has this issue). - -sort_version_key - Sort the version string using this key function. Choose between ``parse_version`` and - ``vercmp``. Default value is ``parse_version``. ``parse_version`` use - ``pkg_resources.parse_version``. ``vercmp`` use ``pyalpm.vercmp``. - This source supports `list options`_. Find with a Command @@ -314,15 +303,8 @@ use_max_tag lightweight ones, and return the largest one sorted by the ``sort_version_key`` option. Will return the tag name instead of date. -proxy - The HTTP proxy to use. The format is ``host:port``, e.g. ``localhost:8087``. - -include_tags_pattern, ignored_tags, sort_version_key - Deprecated. Use `list options`_ instead. - -An environment variable ``NVCHECKER_GITHUB_TOKEN`` or a key named ``github`` -can be set to a GitHub OAuth token in order to request more frequently than -anonymously. +A key named ``github`` can be set to a GitHub OAuth token in order to request +more frequently than anonymously. This source supports `list options`_ when ``use_max_tag`` is set. @@ -347,9 +329,6 @@ host token Gitea authorization token used to call the API. -ignored_tags, sort_version_key - Deprecated. Use `list options`_ instead. - To set an authorization token, you can set: - a key named ``gitea_{host}`` in the keyfile (where ``host`` is formed the @@ -377,9 +356,6 @@ use_max_tag Set this to ``true`` to check for the max tag on BitBucket. Will return the biggest one sorted by ``pkg_resources.parse_version``. Will return the tag name instead of date. -ignored_tags, sort_version_key - Deprecated. Use `list options`_ instead. - max_page How many pages do we search for the max tag? Default is 3. This works when ``use_max_tag`` is set. @@ -407,9 +383,6 @@ host token GitLab authorization token used to call the API. -ignored_tags, sort_version_key - Deprecated. Use `list options`_ instead. - To set an authorization token, you can set: - a key named ``gitlab_{host}`` in the keyfile (where ``host`` is formed the @@ -460,9 +433,6 @@ Check `MetaCPAN `_ for updates. cpan The name used on CPAN, e.g. ``YAML``. -proxy - The HTTP proxy to use. The format is ``host:port``, e.g. ``localhost:8087``. - Check Packagist --------------- Check `Packagist `_ for updates. @@ -571,12 +541,6 @@ use_max_tag Set this to ``true`` to check for the max tag. Currently only supported for ``git``. This option returns the biggest tag sorted by ``pkg_resources.parse_version``. -ignored_tags - Ignore certain tags while computing the max tag. Tags are separate by - whitespaces. This option must be used together with ``use_max_tag``. This can - be useful to avoid some known badly versioned tags, so the newer tags won't - be "overridden" by the old broken ones. - This source supports `list options`_ when ``use_max_tag`` is set. Other