freezer API document error in README.rst

Bug #1597560 reported by Shangzhong Zhu
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Backup/Restore and DR (Freezer)
Fix Released
Low
Shangzhong Zhu

Bug Description

Chapter "1 Installation" in the README.rst, the command "pip install -r requirements.txt" should be used for "1.1 Install required packages". For "1.2 Install freezer_api" should be used these command as follow:
# git clone https://git.openstack.org/openstack/freezer-api.git
# cd freezer-api && sudo python setup.py install

Revision history for this message
Shangzhong Zhu (zhusz) wrote :

The current freezer API README.rst: https://github.com/openstack/freezer-api
...
1. Installation

1.1 Install required packages

# git clone https://git.openstack.org/openstack/freezer-api.git
# cd freezer-api && sudo python setup.py install
1.2 Install freezer_api

# pip install -r requirements.txt
...

Shangzhong Zhu (zhusz)
Changed in freezer:
assignee: nobody → shangzhong.zhu (shangzhong.zhu)
status: New → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to freezer-api (master)

Fix proposed to branch: master
Review: https://review.openstack.org/337621

Shangzhong Zhu (zhusz)
tags: added: low-hanging-fruit
Changed in freezer:
milestone: none → newton-2
importance: Undecided → Low
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to freezer-api (master)

Reviewed: https://review.openstack.org/337621
Committed: https://git.openstack.org/cgit/openstack/freezer-api/commit/?id=afe97aa31541727f92da3c6c1e61176b1986eb56
Submitter: Jenkins
Branch: master

commit afe97aa31541727f92da3c6c1e61176b1986eb56
Author: shangzhong.zhu <email address hidden>
Date: Tue Jul 5 18:44:24 2016 +0800

    freezer API document error in README.rst

    1. Installation
    1.1 Install required packages
        # git clone https://git.openstack.org/openstack/freezer-api.git
        # cd freezer-api && sudo python setup.py install
    1.2 Install freezer_api
        # pip install -r requirements.txt

    The command for installing the freezer-api and its dependencies is
    contrary.

    The command "pip install ./" should be used to install freezer-api
    and its dependencies instead of "pip install -r requirement.txt" and
    "sudo python setup.py install".

    Change-Id: Iea1ba7d7f6f6a3995988eec1d0bec5e7fb84ef9c
    Closes-Bug: #1597560

Changed in freezer:
status: In Progress → Fix Released
Revision history for this message
Thierry Carrez (ttx) wrote : Fix included in openstack/freezer-api 3.0.0.0b3

This issue was fixed in the openstack/freezer-api 3.0.0.0b3 development milestone.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.