[v1] hw: Fix format for comments

[PATCH] hw: Fix format for comments

Shaoqin Huang posted 1 patch 12 months ago

Diff against v1 v2
Download mbox

Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/qemu tags/patchew/20230515072525.886221-1-shahuang@redhat.com

Maintainers: Eduardo Habkost <eduardo@habkost.net>, Marcel Apfelbaum <marcel.apfelbaum@gmail.com>, "Philippe Mathieu-Daudé" <philmd@linaro.org>, Yanan Wang <wangyanan55@huawei.com>

There is a newer version of this series

include/hw/boards.h | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

Expand all Fold all

[PATCH] hw: Fix format for comments

Posted by Shaoqin Huang 12 months ago

Simply fix the #vcpus_count to @vcpus_count in CPUArchId comments. Since
we are at here, resort the parameters in comments to match the sequence
of parameters which defined in the CPUArchId.

CC: Igor Mammedov <imammedo@redhat.com>
Signed-off-by: Shaoqin Huang <shahuang@redhat.com>
---
 include/hw/boards.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/include/hw/boards.h b/include/hw/boards.h
index f4117fdb9a..cefa3d5897 100644
--- a/include/hw/boards.h
+++ b/include/hw/boards.h
@@ -101,10 +101,10 @@ MemoryRegion *machine_consume_memdev(MachineState *machine,
 /**
  * CPUArchId:
  * @arch_id - architecture-dependent CPU ID of present or possible CPU
+ * @vcpus_count - number of threads provided by @cpu object
+ * @props - CPU object properties, initialized by board
  * @cpu - pointer to corresponding CPU object if it's present on NULL otherwise
  * @type - QOM class name of possible @cpu object
- * @props - CPU object properties, initialized by board
- * #vcpus_count - number of threads provided by @cpu object
  */
 typedef struct CPUArchId {
     uint64_t arch_id;
-- 
2.39.1

Re: [PATCH] hw: Fix format for comments

Posted by Igor Mammedov 11 months, 1 week ago

On Mon, 15 May 2023 03:25:25 -0400
Shaoqin Huang <shahuang@redhat.com> wrote:

> Simply fix the #vcpus_count to @vcpus_count in CPUArchId comments.

> Since
> we are at here, resort the parameters in comments to match the sequence
While at it, reorder ...
                   
> of parameters which defined in the CPUArchId.
> 
> CC: Igor Mammedov <imammedo@redhat.com>
> Signed-off-by: Shaoqin Huang <shahuang@redhat.com>

with commit message fixed up
Reviewed-by: Igor Mammedov <imammedo@redhat.com>

> ---
>  include/hw/boards.h | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/include/hw/boards.h b/include/hw/boards.h
> index f4117fdb9a..cefa3d5897 100644
> --- a/include/hw/boards.h
> +++ b/include/hw/boards.h
> @@ -101,10 +101,10 @@ MemoryRegion *machine_consume_memdev(MachineState *machine,
>  /**
>   * CPUArchId:
>   * @arch_id - architecture-dependent CPU ID of present or possible CPU
> + * @vcpus_count - number of threads provided by @cpu object
> + * @props - CPU object properties, initialized by board
>   * @cpu - pointer to corresponding CPU object if it's present on NULL otherwise
>   * @type - QOM class name of possible @cpu object
> - * @props - CPU object properties, initialized by board
> - * #vcpus_count - number of threads provided by @cpu object
>   */
>  typedef struct CPUArchId {
>      uint64_t arch_id;