Skip to contentSkip to conversation

hw: Fix format for comments

PATCH Superseded Shaoqin Huang 2 participants 2 messages May 15, 2023 – Jun 6, 2023

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 hw: Fix format for comments

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.

---
 include/hw/boards.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
include/hw/boards.h +2 -2
index f4117fdb9a..cefa3d5897 100644
@@ -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;
Signature · 1 line
2.39.1
Reviewed-by on v1 1/1
#1 lore raw
Quoted 4 lines · On Mon, 15 May 2023 03:25:25 -0400 Shaoqin Huang <[email protected]> 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 ...

Quoted 4 lines

of parameters which defined in the CPUArchId.

with commit message fixed up

Quoted 21 lines
---
 include/hw/boards.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
include/hw/boards.h +2 -2
index f4117fdb9a..cefa3d5897 100644
@@ -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;