From e6a933e6f66ea619818c696d4f6a93fd42dc0a9b Mon Sep 17 00:00:00 2001 From: Vineet Naik Date: Fri, 17 Apr 2020 00:18:19 +0530 Subject: [PATCH] Add a document explaining option compatibility in old and new vers --- docs/v2beta-opts.org | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 docs/v2beta-opts.org diff --git a/docs/v2beta-opts.org b/docs/v2beta-opts.org new file mode 100644 index 0000000..dd81095 --- /dev/null +++ b/docs/v2beta-opts.org @@ -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 | +|--------------+-----+------------+-----------+--------+------+---------+----------+------+-----------+--------------| +| | | | | | | | | | | | +| 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 | | +|--------------+-----+------------+-----------+--------+----------+----------+----------+----------+-----------+--------------+---| +| | | | | | | | | | | | | +| 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) | | | | |