diff mbox series

[1/6] qom: Fix DECLARE_*CHECKER documentation

Message ID 20201003025424.199291-2-ehabkost@redhat.com
State Superseded
Headers show
Series qom documentation fixes | expand

Commit Message

Eduardo Habkost Oct. 3, 2020, 2:54 a.m. UTC
Correct copy/paste mistake in the DECLARE_INSTANCE_CHECKER and
DECLARE_CLASS_CHECKERS documentation.

Signed-off-by: Eduardo Habkost <ehabkost@redhat.com>
---
 include/qom/object.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Philippe Mathieu-Daudé Oct. 3, 2020, 5:56 p.m. UTC | #1
On 10/3/20 4:54 AM, Eduardo Habkost wrote:
> Correct copy/paste mistake in the DECLARE_INSTANCE_CHECKER and

> DECLARE_CLASS_CHECKERS documentation.

> 

> Signed-off-by: Eduardo Habkost <ehabkost@redhat.com>

> ---

>  include/qom/object.h | 4 ++--

>  1 file changed, 2 insertions(+), 2 deletions(-)

> 

> diff --git a/include/qom/object.h b/include/qom/object.h

> index 27aaa67e63f..e738dfc6744 100644

> --- a/include/qom/object.h

> +++ b/include/qom/object.h

> @@ -170,7 +170,7 @@ struct Object

>   * Direct usage of this macro should be avoided, and the complete

>   * OBJECT_DECLARE_TYPE macro is recommended instead.

>   *

> - * This macro will provide the three standard type cast functions for a

> + * This macro will provide the the instance type cast functions for a


Using a single "the":
Reviewed-by: Philippe Mathieu-Daudé <f4bug@amsat.org>


>   * QOM type.

>   */

>  #define DECLARE_INSTANCE_CHECKER(InstanceType, OBJ_NAME, TYPENAME) \

> @@ -187,7 +187,7 @@ struct Object

>   * Direct usage of this macro should be avoided, and the complete

>   * OBJECT_DECLARE_TYPE macro is recommended instead.

>   *

> - * This macro will provide the three standard type cast functions for a

> + * This macro will provide the class type cast functions for a

>   * QOM type.

>   */

>  #define DECLARE_CLASS_CHECKERS(ClassType, OBJ_NAME, TYPENAME) \

>
diff mbox series

Patch

diff --git a/include/qom/object.h b/include/qom/object.h
index 27aaa67e63f..e738dfc6744 100644
--- a/include/qom/object.h
+++ b/include/qom/object.h
@@ -170,7 +170,7 @@  struct Object
  * Direct usage of this macro should be avoided, and the complete
  * OBJECT_DECLARE_TYPE macro is recommended instead.
  *
- * This macro will provide the three standard type cast functions for a
+ * This macro will provide the the instance type cast functions for a
  * QOM type.
  */
 #define DECLARE_INSTANCE_CHECKER(InstanceType, OBJ_NAME, TYPENAME) \
@@ -187,7 +187,7 @@  struct Object
  * Direct usage of this macro should be avoided, and the complete
  * OBJECT_DECLARE_TYPE macro is recommended instead.
  *
- * This macro will provide the three standard type cast functions for a
+ * This macro will provide the class type cast functions for a
  * QOM type.
  */
 #define DECLARE_CLASS_CHECKERS(ClassType, OBJ_NAME, TYPENAME) \