Rooba
/
pipdeptree
mirror of https://github.com/tox-dev/pipdeptree.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add a document explaining option compatibility in old and new vers

This commit is contained in:
Vineet Naik 2020-04-17 00:18:19 +05:30
parent d4fccb2a71
commit e6a933e6f6
1 changed files with 43 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
docs/v2beta-opts.org Normal file
View File

@ -0,0 +1,43 @@
* Options in version 0.x v/s 2.x (upcoming release)
Until version 0.13.2, the some of the options that pipdeptree supports
didn't work in combination with other options. In fact this was the
primary reason behind refactoring the code.
The upcoming version 2.x plans to fix this as shown in the tables below.
Note: The changes for upcoming 2.x release can be found in the
~v2beta~ branch.
** Until version 0.13.2
| *Features* | all | local-only | user-only | freeze | warn | reverse | packages | json | json-tree | graph-output |
|--------------+-----+------------+-----------+--------+------+---------+----------+------+-----------+--------------|
| | <c> | <c> | <c> | <c> | <c> | <c> | <c> | <c> | <c> | <c> |
| all | | | | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| local-only | | | | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| user-only | | | | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
| freeze | ✓ | ✓ | ✓ | ✓ | | ✓ | ✓ | | | |
| warn | ✓ | ✓ | ✓ | | | | | ✗ | ✗ | |
| reverse | ✓ | ✓ | ✓ | ✓ | | | ✓ | | ✗ | ✗ |
| packages | ✓ | ✓ | ✓ | ✓ | | ✓ | | ✗ | ✗ | ✗ |
| json | ✓ | ✓ | ✓ | | ✗ | | ✗ | | | |
| json-tree | ✓ | ✓ | ✓ | | ✗ | ✗ | ✗ | | | |
| graph-output | ✓ | ✓ | ✓ | | | ✗ | ✗ | | | |
** Plan for version 2.0.0 (work in progress)
| *Features* | all | local-only | user-only | freeze | warn | reverse | packages | json | json-tree | graph-output | |
|--------------+-----+------------+-----------+--------+----------+----------+----------+----------+-----------+--------------+---|
| | <c> | <c> | <c> | <c> | <c> | <c> | <c> | <c> | <c> | <c> | |
| all | | | | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
| local-only | | | | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
| user-only | | | | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | |
| freeze | ✓ | ✓ | ✓ | ✓ | | ✓ | ✓ | | | | |
| warn | ✓ | ✓ | ✓ | | | | | ✓ (todo) | ✓ (todo) | | |
| reverse | ✓ | ✓ | ✓ | ✓ | | | ✓ | | ✓ (done) | ✓ (done) | |
| packages | ✓ | ✓ | ✓ | ✓ | | ✓ | | ✓ (done) | ✓ (done) | ✓ (done) | |
| json | ✓ | ✓ | ✓ | | ✓ (todo) | | ✓ (done) | | | | |
| json-tree | ✓ | ✓ | ✓ | | ✓ (todo) | ✓ (done) | ✓ (done) | | | | |
| graph-output | ✓ | ✓ | ✓ | | | ✓ (done) | ✓ (done) | | | | |