pedro/cdist
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

__package_pip: update man.rst

Browse source 
Adjusted comments for `explorer/extras` and updated the man page for the
new behaviour of updating the extras.
This commit is contained in:
matze 2021-02-12 13:42:51 +01:00
commit 951712740f
2 changed files with 20 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

7
cdist/conf/type/__package_pip/explorer/extras
View file

@ -35,15 +35,16 @@ then
pip3 freeze > "$pip_freeze" pip3 freeze > "$pip_freeze"
# If all is set, it searches all available extras to separatly check them. # If all is set, it searches all available extras to separatly check them.
# It would work with just 'all' (cause dependencies are given), but will # It would work with just 'all' (cause dependencies are specified for
# not update if one extra is already present. Side effect is that it will # 'all'), but will not update if one extra is already present. Side effect
# not use [all] but instead name all extras seperatly. # is that it will not use [all] but instead name all extras seperatly.
for extra in $(if grep -qFx all "$__object/parameter/extra"; for extra in $(if grep -qFx all "$__object/parameter/extra";
then awk -F': ' '$1 == "Provides-Extra" && $2 != "all"{print $2}' "$distinfo_dir/METADATA"; then awk -F': ' '$1 == "Provides-Extra" && $2 != "all"{print $2}' "$distinfo_dir/METADATA";
else tr ',' '\n' < "$__object/parameter/extra"; else tr ',' '\n' < "$__object/parameter/extra";
fi) fi)
do do
# create a grep BRE pattern to search all packages # create a grep BRE pattern to search all packages
# maybe a file full of patterns for -F could be written
grep_pattern="$( grep_pattern="$(
awk -F'(: | ; )' -v check="$extra" ' awk -F'(: | ; )' -v check="$extra" '
$1 == "Requires-Dist" { $1 == "Requires-Dist" {

25
cdist/conf/type/__package_pip/man.rst
View file

@ -24,8 +24,14 @@ name
extra extra
Extra optional dependencies which should be installed along the selected Extra optional dependencies which should be installed along the selected
package. Can be specified multiple times. Will only be applied if the package. Can be specified multiple times. Multiple extra optional
package actually will be installed, but will not explicitly checked. dependencies can also be specified in a comma-separated list to provide
a more pip-natvie style.
Extra optional dependencies will be installed even when the base package
is already installed. Notice that the type will not remove installed extras
that are not explicitly named for the type because pip does not offer a
management for orphaned packages and they may be used by other packages.
pip pip
Instead of using pip from PATH, use the specific pip path. Instead of using pip from PATH, use the specific pip path.
@ -53,8 +59,8 @@ EXAMPLES
# Install package with optional dependencies # Install package with optional dependencies
__package_pip mautrix-telegram --extra speedups --extra webp_convert --extra hq_thumbnails __package_pip mautrix-telegram --extra speedups --extra webp_convert --extra hq_thumbnails
# or do a little cheating # the extras can also be specified comma-separated
__package_pip mautrix-telegram --extra speedups,webp_convert,hq_thumbnails __package_pip mautrix-telegram --extra speedups,webp_convert,hq_thumbnails --extra postgres
# or take all extras # or take all extras
__package_pip mautrix-telegram --extra all __package_pip mautrix-telegram --extra all
@ -67,12 +73,13 @@ SEE ALSO
AUTHORS AUTHORS
------- -------
Nico Schottelius <nico-cdist--@--schottelius.org> | Nico Schottelius <nico-cdist--@--schottelius.org>
| Matthias Stecher <matthiasstecher--@--gmx.de>
COPYING COPYING
------- -------
Copyright \(C) 2012 Nico Schottelius. You can redistribute it Copyright \(C) 2012 Nico Schottelius, 2021 Matthias Stecher. You can
and/or modify it under the terms of the GNU General Public License as redistribute it and/or modify it under the terms of the GNU General
published by the Free Software Foundation, either version 3 of the Public License as published by the Free Software Foundation, either
License, or (at your option) any later version. version 3 of the License, or (at your option) any later version.