[openstack-dev] [nova] "DocImpact" => bug report

Markus Zoeller mzoeller at de.ibm.com
Fri Mar 4 14:08:06 UTC 2016

Since 1-2 weeks each merged change which has a "DocImpact" in its
commit message will open a new bug report in Nova, for example [1].

Those bug reports will be forwarded to the "manuals" project *IF*
they provide enough information for the manuals team to work with.
If they do not, they will cause extra work to the nova bugs team.
This is avoidable by providing enough information in the commit 
message *what* should be documented (which manual, which section,
example phrasing, anything that helps the manual team).

If you have a reno file in the commit and the manuals *don't* need
an update, "DocImpact" is not necessary. IOW, saying "DocImpact"
is shorthand for "the manuals need to be updated".

@(core-)reviewers: Please consider this also in the reviews of patches.

[1] https://bugs.launchpad.net/nova/+bug/1551782

Regards, Markus Zoeller (markus_z)

More information about the OpenStack-dev mailing list