Gabe Black has submitted this change. (
https://gem5-review.googlesource.com/c/public/gem5/+/36278 )
Change subject: sim: Fix API comments for optParamIn.
......................................................................
sim: Fix API comments for optParamIn.
The top level comment was correct, but the parameter comments talked
about writing parameters instead of reading them. Also simplified the
wording of the return value comment.
Change-Id: I156aba5b69c281ee2f34297bf3f75fd0acfb2b6e
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/36278
Maintainer: Gabe Black <gabe.bl...@gmail.com>
Maintainer: Andreas Sandberg <andreas.sandb...@arm.com>
Reviewed-by: Andreas Sandberg <andreas.sandb...@arm.com>
Reviewed-by: Jason Lowe-Power <power...@gmail.com>
Tested-by: kokoro <noreply+kok...@google.com>
---
M src/sim/serialize.hh
1 file changed, 5 insertions(+), 6 deletions(-)
Approvals:
Jason Lowe-Power: Looks good to me, approved
Andreas Sandberg: Looks good to me, approved; Looks good to me, approved
Gabe Black: Looks good to me, approved
kokoro: Regressions pass
diff --git a/src/sim/serialize.hh b/src/sim/serialize.hh
index 22c40aa..b5fb47c 100644
--- a/src/sim/serialize.hh
+++ b/src/sim/serialize.hh
@@ -482,13 +482,12 @@
/**
* This function is used for restoring optional parameters from the
* checkpoint.
- * @param cp The checkpoint to be written to.
- * @param name Name of the parameter to be written.
- * @param param Value of the parameter to be written.
- * @param do_warn If the do_warn is set to true then the function prints
the
+ * @param cp The checkpoint to be read from.
+ * @param name Name of the parameter to be read.
+ * @param param Value of the parameter to be read.
+ * @param do_warn If the warn is set to true then the function prints the
* warning message.
- * @return If the parameter we are searching for does not exist
- * the function returns false else it returns true.
+ * @return Returns if the parameter existed in the checkpoint.
*
* @ingroup api_serialize
*/
--
To view, visit https://gem5-review.googlesource.com/c/public/gem5/+/36278
To unsubscribe, or for help writing mail filters, visit
https://gem5-review.googlesource.com/settings
Gerrit-Project: public/gem5
Gerrit-Branch: develop
Gerrit-Change-Id: I156aba5b69c281ee2f34297bf3f75fd0acfb2b6e
Gerrit-Change-Number: 36278
Gerrit-PatchSet: 4
Gerrit-Owner: Gabe Black <gabebl...@google.com>
Gerrit-Reviewer: Andreas Sandberg <andreas.sandb...@arm.com>
Gerrit-Reviewer: Gabe Black <gabe.bl...@gmail.com>
Gerrit-Reviewer: Giacomo Travaglini <giacomo.travagl...@arm.com>
Gerrit-Reviewer: Jason Lowe-Power <power...@gmail.com>
Gerrit-Reviewer: kokoro <noreply+kok...@google.com>
Gerrit-MessageType: merged
_______________________________________________
gem5-dev mailing list -- gem5-dev@gem5.org
To unsubscribe send an email to gem5-dev-le...@gem5.org
%(web_page_url)slistinfo%(cgiext)s/%(_internal_name)s
