instance.snapshot notification samples are assigned to two different Notification classes

Bug #1732685 reported by Balazs Gibizer
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Compute (nova)
Fix Released
Undecided
Stephen Finucane

Bug Description

Here attached to the wrong class: https://github.com/openstack/nova/blob/b28924b8e4115f436d46812877066d5d03ad272a/nova/notifications/objects/instance.py#L414-L415

Here attached to the correct class: https://github.com/openstack/nova/blob/b28924b8e4115f436d46812877066d5d03ad272a/nova/notifications/objects/instance.py#L522-L523

This causes that the sample will appear twice in the table of versioned notifications in the devref: https://docs.openstack.org/nova/latest/reference/notifications.html#existing-versioned-notifications

It also makes both occurrences shown by default instead of hidden as the rest of the sample by default.

The bug only effects the master branch as the patch https://review.openstack.org/#/c/453077/ that caused this was merged after Pike.

description: updated
tags: added: notifications
tags: added: doc
tags: added: docs
Changed in nova:
assignee: nobody → Balazs Gibizer (balazs-gibizer)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to nova (master)

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

Changed in nova:
status: New → In Progress
Changed in nova:
assignee: Balazs Gibizer (balazs-gibizer) → Stephen Finucane (stephenfinucane)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to nova (master)

Reviewed: https://review.openstack.org/520579
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=ff4f58fcd279605998de21405facb2cfcf8ba385
Submitter: Zuul
Branch: master

commit ff4f58fcd279605998de21405facb2cfcf8ba385
Author: Balazs Gibizer <email address hidden>
Date: Thu Nov 16 13:55:39 2017 +0100

    Fix the usage of instance.snapshot notification sample

    The instance.snapshot.start and .end notification sample file was
    attached to two different Notification ovo by mistake. This caused that
    the samples are appeared in the notification dev-ref twice.

    This patch removes the duplication and adds a simple check to the doc
    generation code to detech such problems in the future.

    Change-Id: I8478c134f9cdb08c02a44e1838dbacede5523914
    Closes-Bug: #1732685

Changed in nova:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/nova 17.0.0.0b2

This issue was fixed in the openstack/nova 17.0.0.0b2 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.