Skip to content

Commit 564735f

Browse files
committed
readme: add captions to all tables and images
1 parent f470d47 commit 564735f

File tree

1 file changed

+25
-9
lines changed

1 file changed

+25
-9
lines changed

README.adoc

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4513,8 +4513,10 @@ xcalc
45134513
xeyes
45144514
....
45154515

4516-
Outcome:
4516+
Outcome: <<image-x11>>
45174517

4518+
[[image-x11]]
4519+
.X11 Buildroot graphical user interface screenshot
45184520
image:x11.png[image]
45194521

45204522
We don't build X11 by default because it takes a considerable amount of time (about 20%), and is not expected to be used by most users: you need to pass the `-x` flag to enable it.
@@ -7725,8 +7727,10 @@ TODO: didn't port during refactor after 3b0a343647bed577586989fb702b760bd280844a
77257727
* `qemu/docs/tracing.txt` and `qemu/docs/replay.txt`
77267728
* https://stackoverflow.com/questions/39149446/how-to-use-qemus-simple-trace-backend/46497873#46497873
77277729

7728-
Results (boot not excluded):
7730+
Results (boot not excluded): <<table-boot-instruction-counts>>
77297731

7732+
[[table-boot-instruction-counts]]
7733+
.Boot instruction counts for various setups
77307734
[options="header"]
77317735
|===
77327736
|Commit |Arch |Simulator |Instruction count
@@ -10026,8 +10030,10 @@ A quick `+./run --emulator gem5 -- -h+` leads us to the options:
1002610030
--l3_size=1024
1002710031
....
1002810032

10029-
But keep in mind that it only affects benchmark performance of the most detailed CPU types:
10033+
But keep in mind that it only affects benchmark performance of the most detailed CPU types: <<table-gem5-cache-cpu-type>>
1003010034

10035+
[[table-gem5-cache-cpu-type]]
10036+
.gem5 cache support in function of CPU type
1003110037
[options="header"]
1003210038
|===
1003310039
|arch |CPU type |caches used
@@ -12139,8 +12145,10 @@ Questions about the C inline assembly examples:
1213912145

1214012146
=== Linux calling conventions
1214112147

12142-
Summary:
12148+
Summary: <<table-linux-calling-conventions>>
1214312149

12150+
[[table-linux-calling-conventions]]
12151+
.Summary of Linux calling conventions for several architectures
1214412152
[options="header"]
1214512153
|===
1214612154
|arch |arguments |return value |callee saved registers
@@ -12240,8 +12248,10 @@ Let's see how many bytes go into each data type:
1224012248
* link:userland/arch/arm/gas_data_sizes.S[]
1224112249
* link:userland/arch/aarch64/gas_data_sizes.S[]
1224212250

12243-
Conclusion:
12251+
Conclusion: <<table-gas-data-sizes>>
1224412252

12253+
[[table-gas-data-sizes]]
12254+
.Summary of GNU GAS assembler data sizes
1224512255
[options="header"]
1224612256
|===
1224712257
|.byte |.word |.long |.quad |.octa
@@ -12388,9 +12398,11 @@ Has some Intel vs AT&T name overload hell:
1238812398
* https://stackoverflow.com/questions/17170388/trying-to-understand-the-assembly-instruction-cltd-on-x86/50315201#50315201
1238912399
* https://sourceware.org/binutils/docs/as/i386_002dMnemonics.html
1239012400

12391-
GNU GAS accepts both syntaxes:
12401+
GNU GAS accepts both syntaxes: <<table-cqto-cltq>>
1239212402

12393-
[options="header"]
12403+
[[table-cqto-cltq]]
12404+
.CQTO and CLTQ family Intel vs AT&T
12405+
[options="header", cols="3*<"]
1239412406
|===
1239512407
|Intel |AT&T |From |To
1239612408

@@ -14271,8 +14283,10 @@ The vector table format is described on <<armarm8>> Table D1-7 "Vector offsets f
1427114283

1427214284
A good representation of the format of the vector table can also be found at <<armv8-programmers-guide>> Table 10-2 "Vector table offsets from vector table base address".
1427314285

14274-
The first part of the table contains:
14286+
The first part of the table contains: <<table-armv8-vector-handlers>>
1427514287

14288+
[[table-armv8-vector-handlers]]
14289+
.Summary of ARMv8 vector handlers
1427614290
[options="header"]
1427714291
|===
1427814292
|Address |Exception type |Description
@@ -16480,8 +16494,10 @@ In order to learn how to measure some of those aspects, see: <<benchmark-this-re
1648016494

1648116495
==== Linux distro choice
1648216496

16483-
We haven't found the ultimate distro yet, here is a summary table of trade-offs that we care about:
16497+
We haven't found the ultimate distro yet, here is a summary table of trade-offs that we care about: <<table-lkmc-linux-distro-comparison>>
1648416498

16499+
[[table-lkmc-linux-distro-comparison]]
16500+
.Comparison of Linux distros for usage in this repository
1648516501
[options="header"]
1648616502
|===
1648716503
|Distro |Packages in single Git tree |Git tracked docs |Cross build without QEMU |Prebuilt downloads |Number of packages

0 commit comments

Comments
 (0)