[PATCH] kvm_main: fix some comments

[PATCH] kvm_main: fix some comments

[Jiang Biao]

is_dirty has been rename to flush, but the comment for it is
outdated. And the description about @flush parameter for
kvm_clear_dirty_log_protect() is missing, add it in this patch
also.

Signed-off-by: Jiang Biao <benbjiang@tencent.com>
---
 virt/kvm/kvm_main.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/virt/kvm/kvm_main.c b/virt/kvm/kvm_main.c
index dc8edc97ba85..40b435e77672 100644
--- a/virt/kvm/kvm_main.c
+++ b/virt/kvm/kvm_main.c
@@ -1138,7 +1138,7 @@ EXPORT_SYMBOL_GPL(kvm_get_dirty_log);
  *	and reenable dirty page tracking for the corresponding pages.
  * @kvm:	pointer to kvm instance
  * @log:	slot id and address to which we copy the log
- * @is_dirty:	flag set if any page is dirty
+ * @flush:	if TLB flush is needed by caller
  *
  * We need to keep it in mind that VCPU threads can write to the bitmap
  * concurrently. So, to avoid losing track of dirty pages we keep the
@@ -1223,6 +1223,7 @@ EXPORT_SYMBOL_GPL(kvm_get_dirty_log_protect);
  *	and reenable dirty page tracking for the corresponding pages.
  * @kvm:	pointer to kvm instance
  * @log:	slot id and address from which to fetch the bitmap of dirty pages
+ * @flush:	if TLB flush is needed by caller
  */
 int kvm_clear_dirty_log_protect(struct kvm *kvm,
 				struct kvm_clear_dirty_log *log, bool *flush)
-- 
2.17.2 (Apple Git-113)

Re: [PATCH] kvm_main: fix some comments

[Cornelia Huck]

On Tue, 23 Apr 2019 17:40:08 +0800
Jiang Biao <benbjiang@tencent.com> wrote:

> is_dirty has been rename to flush, but the comment for it is

s/rename/renamed/

> outdated. And the description about @flush parameter for
> kvm_clear_dirty_log_protect() is missing, add it in this patch
> also.
> 
> Signed-off-by: Jiang Biao <benbjiang@tencent.com>
> ---
>  virt/kvm/kvm_main.c | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/virt/kvm/kvm_main.c b/virt/kvm/kvm_main.c
> index dc8edc97ba85..40b435e77672 100644
> --- a/virt/kvm/kvm_main.c
> +++ b/virt/kvm/kvm_main.c
> @@ -1138,7 +1138,7 @@ EXPORT_SYMBOL_GPL(kvm_get_dirty_log);
>   *	and reenable dirty page tracking for the corresponding pages.

BTW: Not seen in the diff, but this line and the preceding one do not
really form a sentence that makes sense :) Maybe fix that as well, as
you are touching the area anyway?

>   * @kvm:	pointer to kvm instance
>   * @log:	slot id and address to which we copy the log
> - * @is_dirty:	flag set if any page is dirty
> + * @flush:	if TLB flush is needed by caller

Hm, maybe "true if TLB flush is needed by caller"?

>   *
>   * We need to keep it in mind that VCPU threads can write to the bitmap
>   * concurrently. So, to avoid losing track of dirty pages we keep the
> @@ -1223,6 +1223,7 @@ EXPORT_SYMBOL_GPL(kvm_get_dirty_log_protect);
>   *	and reenable dirty page tracking for the corresponding pages.
>   * @kvm:	pointer to kvm instance
>   * @log:	slot id and address from which to fetch the bitmap of dirty pages
> + * @flush:	if TLB flush is needed by caller
>   */
>  int kvm_clear_dirty_log_protect(struct kvm *kvm,
>  				struct kvm_clear_dirty_log *log, bool *flush)