Wrong path of rpc_api.rst in class docstring

Bug #1722072 reported by Sapna Jadhav
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
neutron
Fix Released
Low
Sapna Jadhav

Bug Description

In few class docstrings rpc_api.rst file path is not correct.
Given path is "doc/source/devref/rpc_api.rst" but, I found this file at this path "/doc/source/contributor/internals/rpc_api.rst" (https://github.com/openstack/neutron/blob/master/doc/source/contributor/internals/rpc_api.rst)

test@test-Standard-PC-i440FX-PIIX-1996:~/bug/neutron$ grep -nri rpc_api.rst
neutron/agent/dhcp/agent.py:78: changing rpc interfaces, see doc/source/devref/rpc_api.rst.
neutron/agent/dhcp/agent.py:538: about changing rpc interfaces, see doc/source/devref/rpc_api.rst.
neutron/agent/rpc.py:72: information on changing rpc interfaces, see doc/source/devref/rpc_api.rst.
neutron/agent/metadata/agent.py:56: doc/source/devref/rpc_api.rst.
neutron/api/rpc/handlers/securitygroups_rpc.py:40:interfaces, see doc/source/devref/rpc_api.rst.
neutron/api/rpc/handlers/securitygroups_rpc.py:68: rpc interfaces, see doc/source/devref/rpc_api.rst.
neutron/api/rpc/handlers/securitygroups_rpc.py:129:rpc interfaces, see doc/source/devref/rpc_api.rst.
neutron/api/rpc/handlers/securitygroups_rpc.py:167: changing rpc interfaces, see doc/source/devref/rpc_api.rst.
neutron/api/rpc/handlers/dvr_rpc.py:33: rpc interfaces, see doc/source/devref/rpc_api.rst.
neutron/api/rpc/handlers/dvr_rpc.py:74: interfaces, see doc/source/devref/rpc_api.rst.
neutron/api/rpc/handlers/dhcp_rpc.py:51:changing rpc interfaces, see doc/source/devref/rpc_api.rst.
neutron/api/rpc/handlers/metadata_rpc.py:29: doc/source/devref/rpc_api.rst.
neutron/api/rpc/agentnotifiers/dhcp_rpc_agent_api.py:39:rpc interfaces, please see doc/source/devref/rpc_api.rst.
neutron/db/agents_db.py:400: information on changing rpc interfaces, see doc/source/devref/rpc_api.rst.

If this is valid bug then, Can I prepare a patch for this?

Revision history for this message
Miguel Lavalle (minsel) wrote :

@Sapana,

Thanks for the report. Yes, please propose a fix for this bug. Is this going to be your first contribution to OpenStack or Neutron?

Changed in neutron:
status: New → Confirmed
importance: Undecided → Low
assignee: nobody → Sapana Jadhav (sapana45)
Revision history for this message
Sapna Jadhav (sapana45) wrote :

Yes, this is going to be my first contribution to Openstack.

Sapna Jadhav (sapana45)
Changed in neutron:
status: Confirmed → In Progress
Revision history for this message
Sapna Jadhav (sapana45) wrote :

I have given patch for this https://review.openstack.org/#/c/510783/
because this is my first patch can anyone tell me what i have to do next?
I mean is everything fine from my side?

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to neutron (master)

Reviewed: https://review.openstack.org/510783
Committed: https://git.openstack.org/cgit/openstack/neutron/commit/?id=d8807e2fa921f179f6d89cc2ec32f4af2fa14682
Submitter: Jenkins
Branch: master

commit d8807e2fa921f179f6d89cc2ec32f4af2fa14682
Author: SapanaJadhav <email address hidden>
Date: Tue Oct 10 12:02:28 2017 +0530

    Wrong path of rpc_api.rst in class docstring

    Changing rpc_api.rst file path from doc/source/devref/rpc_api.rst
    to /doc/source/contributor/internals/rpc_api.rst. Because rpc_api.rst
    file is located at this path
    doc/source/contributor/internals/rpc_api.rst.

    Closes-Bug #1722072

    Change-Id: Ic243aab9e3428bfec69db61a94b4129cd768e233

Changed in neutron:
status: In Progress → Fix Released
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.