readme: fix all broken asciidoctor links.

Add the -v flag to build-doc to help catch them later.
This commit is contained in:
Ciro Santilli
2018-04-07 18:46:26 +01:00
parent 10348beeff
commit cc190fd355
2 changed files with 6 additions and 6 deletions

View File

@@ -23,7 +23,7 @@ cd linux-kernel-module-cheat
./configure && ./build && ./run ./configure && ./build && ./run
.... ....
The first configure will take a while (30 minutes to 2 hours) to clone and build, see <<benchmarking-this-repo>> for more details. The first configure will take a while (30 minutes to 2 hours) to clone and build, see <<benchmark-initial-build>> for more details.
If you don't want to wait, you could also try to compile the examples and run them on your host computer as explained on at <<run-on-host>>, but as explained on that section, that is dangerous, limited, and will likely not work. If you don't want to wait, you could also try to compile the examples and run them on your host computer as explained on at <<run-on-host>>, but as explained on that section, that is dangerous, limited, and will likely not work.
@@ -1204,7 +1204,7 @@ To enable networking by default, use the methods documented at <<automatic-start
== KVM == KVM
You can make QEMU or gem5 <<gem5-vs-qemu-performance,run faster>> by passing enabling KVM with: You can make QEMU or gem5 <<benchmark-linux-kernel-boot,run faster>> by passing enabling KVM with:
.... ....
./run -K ./run -K
@@ -2373,8 +2373,8 @@ It is not of course truly cycle accurate, as that
but the approximation is reasonable. but the approximation is reasonable.
+ +
It is used mostly for microarchitecture research purposes: when you are making a new chip technology, you don't really need to specialize enormously to an existing microarchitecture, but rather develop something that will work with a wide range of future architectures. It is used mostly for microarchitecture research purposes: when you are making a new chip technology, you don't really need to specialize enormously to an existing microarchitecture, but rather develop something that will work with a wide range of future architectures.
** runs are deterministic by default, unlike QEMU which has a special <<record-and-replay>> mode, that requires first playing the content once and then replaying ** runs are deterministic by default, unlike QEMU which has a special <<qemu-record-and-replay>> mode, that requires first playing the content once and then replaying
* disadvantage of gem5: slower than QEMU, see: <<gem5-vs-qemu-performance>> * disadvantage of gem5: slower than QEMU, see: <<benchmark-linux-kernel-boot>>
+ +
This implies that the user base is much smaller, since no Android devs. This implies that the user base is much smaller, since no Android devs.
+ +
@@ -2967,7 +2967,7 @@ We are unable to use `gdbserver` because of networking: <<gem5-host-to-guest-net
The alternative is to do as in <<gdb-step-debug-userland-processes>>. The alternative is to do as in <<gdb-step-debug-userland-processes>>.
First make sure that for your arch the kernel debugging on the given target works for the architecture: <<gem5-gdb>>, on which we rely. When we last tested, this was not the case for aarch64: <<gem5-gdb-step-debugging-aarch64>> First make sure that for your arch the kernel debugging on the given target works for the architecture: <<gem5-gdb>>, on which we rely. When we last tested, this was not the case for aarch64: <<gem5-gdb-step-debug-kernel-aarch64>>
Next, follow the exact same steps explained at <<gdb-step-debug-userland-non-init-without--d>>, but passing `-g` to every command as usual. Next, follow the exact same steps explained at <<gdb-step-debug-userland-non-init-without--d>>, but passing `-g` to every command as usual.

View File

@@ -1,2 +1,2 @@
#!/usr/bin/env bash #!/usr/bin/env bash
asciidoctor -o out/README.html README.adoc asciidoctor -o out/README.html -v README.adoc