Project

Profile

Help

Issue #2256

closed

Document cancel_publish_repo for distributors

Added by rmcgover over 7 years ago. Updated almost 5 years ago.

Status:
CLOSED - WONTFIX
Priority:
Normal
Assignee:
-
Category:
-
Sprint/Milestone:
-
Start date:
Due date:
Estimated time:
Severity:
2. Medium
Version:
2.10.0
Platform Release:
OS:
Triaged:
Yes
Groomed:
No
Sprint Candidate:
No
Tags:
Documentation, Pulp 2
Sprint:
Quarter:

Description

pulp/docs/dev-guide/newtypesupport/plugin/distributors.rst mentions publish_repo and cancel_publish_repo. It doesn't explain what cancel_publish_repo is supposed to do.

Could that please be documented? In particular, the points:

  • is cancel_publish_repo supposed to raise an exception, or cause publish_repo to raise an exception/return a failure, or just return?
  • is cancel_publish_repo expected to undo what's been done up to its cancellation?

The reason why I've raised this issue is that base class implementation pulp.server.pulp.plugins.distributor.Distributor#cancel_publish_repo raises an exception, while the distributors I've looked at which override cancel_publish_repo don't raise, and it's hard to say if one of these is a bug.

Also available in: Atom PDF