Skip to content

Commit 98f93d9

Browse files
committed
Apply more consistent title case to section titles
1 parent 97ae927 commit 98f93d9

File tree

4 files changed

+34
-34
lines changed

4 files changed

+34
-34
lines changed

riscv-atomic.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ ifeval::["{docname}" == "riscv-atomics"]
44
include::prelude.adoc[]
55
endif::[]
66

7-
== RISC-V atomics mappings
7+
== RISC-V Atomics Mappings
88

99
This specifies mappings of C and {Cpp} atomic operations to RISC-V
1010
machine instructions. Other languages, for example Java, provide similar
@@ -134,7 +134,7 @@ the `lr` and `sc` instructions.
134134
|===
135135

136136
[discrete]
137-
=== Meaning of notes in table
137+
=== Meaning of Notes in Table
138138

139139
1) Depends on a load instruction with an RCsc acquire annotation,
140140
or a store instruction with an RCsc release annotation. These are currently
@@ -154,7 +154,7 @@ ordering are considered to have a note 3 annotation.
154154
To remove the note 3 annotation the amocas operation must be prepended with a
155155
leading fence (`fence rw,rw; amocas.{w\|d}.aqrl`).
156156

157-
== Ztso atomics mappings
157+
== Ztso Atomics Mappings
158158

159159
This specifies additional mappings of C and {Cpp} atomic operations to RISC-V
160160
machine instructions.
@@ -219,7 +219,7 @@ We present the mappings as a table in 3 sections, as above.
219219
|===
220220

221221
[discrete]
222-
=== Meaning of notes in table
222+
=== Meaning of Notes in Table
223223

224224
3) Incompatible with the original "Table A.6" mapping. Do not combine these
225225
mappings with code generated by a compiler using those older mappings.
@@ -234,7 +234,7 @@ leading fence (`fence rw,rw; amocas.{w\|d}`).
234234

235235
6) Requires the Ztso extension.
236236

237-
== Other conventions
237+
== Other Conventions
238238

239239
It is expected that the RVWMO and Ztso AMO Mappings will be used for atomic
240240
read-modify-write operations that are directly supported by corresponding AMO

riscv-cc.adoc

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ convention. A platform may choose:
7474
- to use the frame pointer to address a valid frame record at all times, except
7575
leaf functions, who may elect to forgo creating a frame record.
7676

77-
=== Floating-point Register Convention
77+
=== Floating-Point Register Convention
7878

7979
.Floating-point register convention
8080
[cols="1,1,2,2"]
@@ -99,7 +99,7 @@ duration in accordance with C11 section 7.6 "Floating-point environment
9999

100100
=== Vector Register Convention
101101

102-
==== Standard calling convention
102+
==== Standard Calling Convention
103103
.Standard vector register calling convention
104104
[%autowidth]
105105
|===
@@ -126,7 +126,7 @@ NOTE: Application software should normally not write `vstart` explicitly.
126126
Any procedure that does explicitly write `vstart` to a nonzero value must zero
127127
`vstart` before either returning or calling another procedure.
128128

129-
==== Calling convention variant
129+
==== Calling Convention Variant
130130
.Variant vector register calling convention*
131131
[%autowidth]
132132
|===
@@ -266,7 +266,7 @@ No floating-point registers, if present, are preserved across calls. (This
266266
property changes when the integer calling convention is augmented by the
267267
hardware floating-point calling convention.)
268268

269-
=== Hardware Floating-point Calling Convention
269+
=== Hardware Floating-Point Calling Convention
270270

271271
The hardware floating-point calling convention adds eight floating-point
272272
argument registers, fa0-fa7, the first two of which are also used to return
@@ -556,9 +556,9 @@ document.
556556
Please refer to the documentation of the RISC-V execution environment interface
557557
(e.g OS kernel ABI, SBI).
558558

559-
== C/{Cpp} type details
559+
== C/{Cpp} Type Details
560560

561-
=== C/{Cpp} type sizes and alignments
561+
=== C/{Cpp} Type Sizes and Alignments
562562

563563
There are two conventions for C/{Cpp} type sizes and alignments.
564564

@@ -622,7 +622,7 @@ The alignment of `max_align_t` is 16.
622622
Structs and unions are aligned to the alignment of their most strictly aligned
623623
member. The size of any object is a multiple of its alignment.
624624

625-
=== Fixed-length vector
625+
=== Fixed-Length Vector
626626

627627
Various compilers have support for fixed-length vector types, for example GCC
628628
and Clang both support declaring a type with `\\__attribute__\((vector_size(N))`,
@@ -634,7 +634,7 @@ alignment requirement of its elemental type.
634634
The size of the fixed length vector is determined by multiplying the size of its
635635
elemental type by the total number of elements within the vector.
636636

637-
=== C/{Cpp} type representations
637+
=== C/{Cpp} Type Representations
638638

639639
`char` is unsigned.
640640

@@ -655,7 +655,7 @@ The type `size_t` is defined as `unsigned int` for RV32 and `unsigned long` for
655655

656656
The type `ptrdiff_t` is defined as `int` for RV32 and `long` for RV64.
657657

658-
=== Bit-fields
658+
=== Bit-Fields
659659

660660
Bit-fields are packed in little-endian fashion. A bit-field that would span the
661661
alignment boundary of its integer type is padded to begin at the next
@@ -716,7 +716,7 @@ alignment used will be those of a pointer, and the fetched pointer will be used
716716
as the address of the actual argument. The `va_copy` macro is a single pointer
717717
copy and the `va_end` macro performs no operation.
718718

719-
=== Vector type sizes and alignments
719+
=== Vector Type Sizes and Alignments
720720

721721
This section defines the sizes and alignments for the vector types defined in
722722
the _RISC-V Vector Extension Intrinsic Document_<<rvv-intrinsic-doc>>.
@@ -749,7 +749,7 @@ content may be undefined, both in the register and in memory.
749749
NOTE: Size must be a positive integer.
750750

751751
[appendix]
752-
== Linux-specific ABI
752+
== Linux-Specific ABI
753753

754754
NOTE: This section of the RISC-V calling convention specification only applies
755755
to Linux-based systems.
@@ -758,7 +758,7 @@ In order to ensure compatibility between different implementations of the C
758758
library for Linux, we provide some extra definitions which only apply on those
759759
systems. These are noted in this section.
760760

761-
=== Linux-specific C type sizes and alignments
761+
=== Linux-Specific C Type Sizes and Alignments
762762

763763
The following definitions apply for all ABIs defined in this document. Here
764764
there is no differentiation between ILP32 and LP64 ABIs.
@@ -773,7 +773,7 @@ there is no differentiation between ILP32 and LP64 ABIs.
773773
| wint_t | 4 | 4
774774
|===
775775

776-
=== Linux-specific C type representations
776+
=== Linux-Specific C Type Representations
777777

778778
The following definitions apply for all ABIs defined in this document. Here
779779
there is no differentiation between ILP32 and LP64 ABIs.

riscv-elf.adoc

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ ifeval::["{docname}" == "riscv-elf"]
44
include::prelude.adoc[]
55
endif::[]
66

7-
== Code models
7+
== Code Models
88

99
The RISC-V architecture constrains the addressing of positions in the
1010
address space. There is no single instruction that can refer to an arbitrary
@@ -18,7 +18,7 @@ However, some code models can't access the whole address space. The linker may
1818
raise an error if it cannot adjust the instructions to access the target address
1919
in the current code model.
2020

21-
=== Medium low code model
21+
=== Medium Low Code Model
2222

2323
The medium low code model, or `medlow`, allows the code to address the whole RV32
2424
address space or the lower 2 GiB and highest 2 GiB of the RV64 address space
@@ -59,7 +59,7 @@ lui a0, 0x80000 # a0 = 0xffffffff80000000
5959
addi a0, a0, -0x800 # a0 = a0 + -2048 = 0xFFFFFFFF7FFFF800
6060
----
6161

62-
=== Medium any code model
62+
=== Medium Any Code Model
6363

6464
The medium any code model, or `medany`, allows the code to address the range
6565
between -2 GiB and +2 GiB from its position. By using `auipc`
@@ -103,7 +103,7 @@ for that, please use the medium position independent code model below.
103103

104104
NOTE: The address space of RV64ILP32* ABIs is not continuous in the middle.
105105

106-
=== Medium position independent code model
106+
=== Medium Position Independent Code Model
107107

108108
This model is similar to the medium any code model, but uses the
109109
<<Global Offset Table,global offset table>> (GOT) for non-local symbol addresses.
@@ -127,7 +127,7 @@ This model is similar to the medium any code model, but uses the
127127
l[w|d] a0, %pcrel_lo(.Ltmp3)(a0)
128128
----
129129

130-
=== Large code model
130+
=== Large Code Model
131131

132132
The `large` code model allows the code to address the whole RV64 address space.
133133
Thus, this model is only available for RV64. By putting object addresses
@@ -207,7 +207,7 @@ same way as `std::bfloat16_t`.
207207
=== Name Mangling for Vector Data Types, Vector Mask Types and Vector Tuple Types.
208208

209209
The vector data types and vector mask types, as defined in the section
210-
<<Vector type sizes and alignments>>, are treated as vendor-extended types in
210+
<<Vector Type Sizes and Alignments>>, are treated as vendor-extended types in
211211
the _Itanium {Cpp} ABI_ <<itanium-cxx-abi>>. These mangled name for
212212
these types is `"u"<len>"__rvv_"<type-name>`. Specifically,
213213
prefixing the type name with `__rvv_`, which is prefixed by
@@ -339,7 +339,7 @@ and the operating system, and the ABI differences are so significant they
339339
cannot be done with a .RISCV.attributes tag nor an ELF note, such as using a
340340
different syscall ABI.
341341

342-
==== Policy for Merge Objects With Different File Headers
342+
==== Policy for Merge Objects with Different File Headers
343343

344344
This section describe the behavior when the inputs files come with different
345345
file headers.
@@ -1241,7 +1241,7 @@ In order to improve the compatibility of the tool, the attribute follows below r
12411241
- The tag is optional; If the tool does not recognize this attribute and the tag number
12421242
modulo 128 is greater than or equal to 64 (`(N % 128) >= 64`), the tag can be ignored.
12431243

1244-
==== Layout of .riscv.attributes section
1244+
==== Layout of .riscv.attributes Section
12451245

12461246
The attributes section start with a format-version (uint8 = 'A') followed by
12471247
vendor specific sub-section(s). A sub-section starts with sub-section length
@@ -1256,7 +1256,7 @@ A sub-section with name "riscv\0" is mandatory. Vendor specific sub-sections
12561256
are allowed in future. Vendor names starting with "[Aa]non" are reserved for
12571257
non-standard ABI extensions.
12581258

1259-
==== List of attributes
1259+
==== List of Attributes
12601260

12611261
.RISC-V attributes
12621262
[cols="4,>2,2,5"]
@@ -1275,7 +1275,7 @@ non-standard ABI extensions.
12751275
| Reserved for non-standard attribute | >= 32768 | - | -
12761276
|===
12771277

1278-
==== Detailed attribute description
1278+
==== Detailed Attribute Description
12791279

12801280
===== How does this specification describe public attributes?
12811281

@@ -1647,7 +1647,7 @@ Relaxation result:
16471647
--
16481648

16491649
[[gp-relax]]
1650-
==== Global-pointer Relaxation
1650+
==== Global-Pointer Relaxation
16511651

16521652
Target Relocation:: R_RISCV_HI20, R_RISCV_LO12_I, R_RISCV_LO12_S,
16531653
R_RISCV_PCREL_HI20, R_RISCV_PCREL_LO12_I, R_RISCV_PCREL_LO12_S
@@ -1737,7 +1737,7 @@ optimize code size and performance of the symbol accessing.
17371737

17381738
NOTE: Tag_RISCV_x3_reg_usage is treated as 0 if it is not present.
17391739

1740-
==== GOT load relaxation
1740+
==== GOT Load Relaxation
17411741

17421742
Target Relocation:: R_RISCV_GOT_HI20, R_RISCV_PCREL_LO12_I
17431743

@@ -1811,7 +1811,7 @@ Relaxation result (relative symbol):
18111811
----
18121812
--
18131813

1814-
==== Zero-page Relaxation
1814+
==== Zero-Page Relaxation
18151815

18161816
Target Relocation:: R_RISCV_HI20, R_RISCV_LO12_I, R_RISCV_LO12_S
18171817

@@ -1880,7 +1880,7 @@ Relaxation result:
18801880
----
18811881
--
18821882

1883-
==== Thread-pointer Relaxation
1883+
==== Thread-Pointer Relaxation
18841884

18851885
Target Relocation:: R_RISCV_TPREL_HI20, R_RISCV_TPREL_ADD,
18861886
R_RISCV_TPREL_LO12_I, R_RISCV_TPREL_LO12_S.

riscv-rtabi.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
[[riscv-rtabi]]
2-
= RISC-V Run-time ABI Specification
2+
= RISC-V Run-Time ABI Specification
33
ifeval::["{docname}" == "riscv-rtabi"]
44
include::prelude.adoc[]
55
endif::[]
66

7-
== Run-time ABI
7+
== Run-Time ABI
88

99
This document defines the run-time helper function ABI for RISC-V, which
1010
includes compiler helper functions, but does not cover the language standard

0 commit comments

Comments
 (0)