PEL: On remove() call, return the removed LogID
Have Repository::remove(const LogID& id), which is used to remove
a PEL, return the full LogID of the removed PEL instead of not
returning anything.
That input id only has to have a filled in PEL ID or OpenBMC event log
ID field, but not both, so returning the full LogID of the removed PEL
ensure the calling code will have both values.
Signed-off-by: Matt Spinler <spinler@us.ibm.com>
Change-Id: If869c59acd59563db137d7c9523210539b51a040
diff --git a/extensions/openpower-pels/repository.hpp b/extensions/openpower-pels/repository.hpp
index c7cb39a..96f951c 100644
--- a/extensions/openpower-pels/repository.hpp
+++ b/extensions/openpower-pels/repository.hpp
@@ -176,9 +176,15 @@
/**
* @brief Removes a PEL from the repository
*
+ * Note that the returned LogID is the fully filled in LogID, i.e.
+ * it has both the PEL and OpenBMC IDs, unlike the passed in LogID
+ * which can just have one or the other.
+ *
* @param[in] id - the ID (either the pel ID, OBMC ID, or both) to remove
+ *
+ * @return std::optional<LogID> - The LogID of the removed PEL
*/
- void remove(const LogID& id);
+ std::optional<LogID> remove(const LogID& id);
/**
* @brief Generates the filename to use for the PEL ID and BCDTime.