John Snow <[email protected]> writes: > This patch converts some slightly-non-trivial intros with more than > one paragraph, but doesn't create any new intro/details splits. > > Review notes: The "See also ..." texts here are prime candidates for > moving into the details section with a ".. seealso::", but like the > last patch, as these are for enums and not candidates as an inline > source, I left them alone for now to keep patch sizes and motion down > until after initial review. > > Signed-off-by: John Snow <[email protected]> > --- > qapi/machine.json | 39 +++++++++++++++++++-------------------- > 1 file changed, 19 insertions(+), 20 deletions(-) > > diff --git a/qapi/machine.json b/qapi/machine.json > index 0516112f8e8..710b638b3bf 100644 > --- a/qapi/machine.json > +++ b/qapi/machine.json > @@ -608,12 +608,12 @@ > > ## > # @HmatLBMemoryHierarchy: > +# The memory hierarchy in the System Locality Latency and > +# Bandwidth Information Structure of HMAT (Heterogeneous Memory > +# Attribute Table) > # > -# The memory hierarchy in the System Locality Latency and Bandwidth > -# Information Structure of HMAT (Heterogeneous Memory Attribute Table) > -# > -# For more information about `HmatLBMemoryHierarchy`, see chapter > -# 5.2.27.4: Table 5-146: Field "Flags" of ACPI 6.3 spec. > +# For more information about `HmatLBMemoryHierarchy`, see chapter > +# 5.2.27.4: Table 5-146: Field "Flags" of ACPI 6.3 spec.
This is one of the "see also" you discussed in the commit message. Such references tend to belong closer to the end, not in the intro. Moving involves a split. More of the same below. Not splitting now keeps the conversion simple, which is a plus. It reindents the entire unsplit intro, and if we do split it later, the part split off gets reindented right back. I'm happy to leave this decision to you. I'm adding to my notes on future work: 8. Move "see also" out of intro > # > # @memory: the structure represents the memory performance > # > @@ -630,12 +630,12 @@ > > ## > # @HmatLBDataType: > +# Data type in the System Locality Latency and Bandwidth > +# Information Structure of HMAT (Heterogeneous Memory Attribute > +# Table) > # > -# Data type in the System Locality Latency and Bandwidth Information > -# Structure of HMAT (Heterogeneous Memory Attribute Table) > -# > -# For more information about `HmatLBDataType`, see chapter 5.2.27.4: > -# Table 5-146: Field "Data Type" of ACPI 6.3 spec. > +# For more information about `HmatLBDataType`, see chapter > +# 5.2.27.4: Table 5-146: Field "Data Type" of ACPI 6.3 spec. > # > # @access-latency: access latency (nanoseconds) > # > @@ -693,12 +693,11 @@ > > ## > # @HmatCacheAssociativity: > +# Cache associativity in the Memory Side Cache Information > +# Structure of HMAT > # > -# Cache associativity in the Memory Side Cache Information Structure > -# of HMAT > -# > -# For more information of `HmatCacheAssociativity`, see chapter > -# 5.2.27.5: Table 5-147 of ACPI 6.3 spec. > +# For more information of `HmatCacheAssociativity`, see chapter > +# 5.2.27.5: Table 5-147 of ACPI 6.3 spec. > # > # @none: None (no memory side cache in this proximity domain, or cache > # associativity unknown) > @@ -714,12 +713,12 @@ > > ## > # @HmatCacheWritePolicy: > +# Cache write policy in the Memory Side Cache Information > +# Structure of HMAT > # > -# Cache write policy in the Memory Side Cache Information Structure of > -# HMAT > -# > -# For more information of `HmatCacheWritePolicy`, see chapter > -# 5.2.27.5: Table 5-147: Field "Cache Attributes" of ACPI 6.3 spec. > +# For more information of `HmatCacheWritePolicy`, see chapter > +# 5.2.27.5: Table 5-147: Field "Cache Attributes" of ACPI 6.3 > +# spec. > # > # @none: None (no memory side cache in this proximity domain, or cache > # write policy unknown)
