From 64c6740081f45f7e6ce45324014ae3e88dacf277 Mon Sep 17 00:00:00 2001 From: Shraddha Agrawal Date: Thu, 14 May 2020 03:50:33 +0530 Subject: [PATCH] docs: acknowledge py2 and py3 where requirements.txt is mentioned This commit removes mention of deleted file requirements.txt and acknowledges the two separate requirements files, requirements2.txt and requirements3.txt, for python2 and python3 respectively, in the following files: 1. MANIFEST.in 2. docs/INSTALL.rst --- MANIFEST.in | 3 ++- docs/INSTALL.rst | 14 ++++++++------ 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/MANIFEST.in b/MANIFEST.in index bb73d96269..d9d67348ad 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,2 +1,3 @@ include *.rst -include requirements.txt +include requirements2.txt +include requirements3.txt diff --git a/docs/INSTALL.rst b/docs/INSTALL.rst index 2af50af8eb..e0e23e8531 100644 --- a/docs/INSTALL.rst +++ b/docs/INSTALL.rst @@ -33,14 +33,15 @@ First install the non-PyPI dependencies:: Next, clone its `git repository `__, create a `virtualenv `__, and -install dependencies:: +install dependencies. For python3, the instructions are given below. For +python2, replace the ``requirements3.txt`` with ``requirements2.txt`` :: git clone https://github.com/ceph/teuthology/ cd teuthology virtualenv ./virtualenv source virtualenv/bin/activate pip install --upgrade pip - pip install -r requirements.txt + pip install -r requirements3.txt python setup.py develop @@ -65,11 +66,12 @@ interacting with the services to schedule tests and to report the test results. Update Dependencies ------------------- -We track the dependencies using ``requirements.txt``. These packages are tested, -and should work with teuthology. But if you want to bump up the versions of them, -please use the following command to update this file :: +We track the dependencies using ``requirements2.txt`` and ``requirements3.txt`` +for python2 and python3 respectively. These packages are tested, and should work +with teuthology. But if you want to bump up the versions of them, please use the +following command to update these files. For python3 :: - pip-compile -qo- | sed '/^-e / d' > requirements.txt + pip-compile -qo- | sed '/^-e / d' > requirements3.txt Please upgrade pip-tool using following command :: -- 2.39.5