Fix example header links that were left empty

2019-07-19 00:00:00 +00:00
parent 6dc9a73830
commit e352087645
19 changed files with 29 additions and 18 deletions
--- a/README.adoc
+++ b/README.adoc
@@ -210,6 +210,16 @@ Source: link:min.S[]

 Outcome: QEMU window opens up, prints a few firmware messages, and hangs.

+Here is an equivalent example using our mini-library:
+
+....
+./run template
+....
+
+Source: link:template.S[]
+
+You can use that file as a quick template to start new tests.
+
 ==== Infinite loop

 Go into an infinite loop instead of using `hlt`:
@@ -1489,6 +1499,7 @@ TODO: are there performance considerations when designing CPUs?

 Bibliography: http://superuser.com/questions/703695/difference-between-port-mapped-and-memory-mapped-access

+[[ps2-keyboard]]
 === PS/2 keyboard

 Whenever you press a key down or up, the keyboard hex scancode is printed to the screen:
--- a/paging.S
+++ b/paging.S
@@ -1,4 +1,4 @@
-/* https://github.com/cirosantilli/x86-bare-metal-examples# */
+/* https://github.com/cirosantilli/x86-bare-metal-examples#paging.S */

 #include "common.h"

--- a/pc_speaker.S
+++ b/pc_speaker.S
@@ -1,4 +1,4 @@
-/* https://github.com/cirosantilli/x86-bare-metal-examples# */
+/* https://github.com/cirosantilli/x86-bare-metal-examples#pc-speaker */

 #include "common.h"

--- a/pit.S
+++ b/pit.S
@@ -1,4 +1,4 @@
-/* https://github.com/cirosantilli/x86-bare-metal-examples# */
+/* https://github.com/cirosantilli/x86-bare-metal-examples#pit */

 #include "common.h"

--- a/pit_once.S
+++ b/pit_once.S
@@ -1,4 +1,4 @@
-/* https://github.com/cirosantilli/x86-bare-metal-examples# */
+/* https://github.com/cirosantilli/x86-bare-metal-examples#pit */

 #include "common.h"
 BEGIN
--- a/pit_protected.S
+++ b/pit_protected.S
@@ -1,4 +1,4 @@
-/* https://github.com/cirosantilli/x86-bare-metal-examples# */
+/* https://github.com/cirosantilli/x86-bare-metal-examples#idt */

 #include "common.h"
 BEGIN
--- a/protected_mode.S
+++ b/protected_mode.S
@@ -1,4 +1,4 @@
-/* https://github.com/cirosantilli/x86-bare-metal-examples# */
+/* https://github.com/cirosantilli/x86-bare-metal-examples#protected-mode */

 #include "common.h"
 BEGIN
--- a/ps2_keyboard.S
+++ b/ps2_keyboard.S
@@ -1,4 +1,4 @@
-/* https://github.com/cirosantilli/x86-bare-metal-examples# */
+/* https://github.com/cirosantilli/x86-bare-metal-examples#ps2-keyboard */

 #include "common.h"
 BEGIN
--- a/real_segmentation.S
+++ b/real_segmentation.S
@@ -1,4 +1,4 @@
-/* https://github.com/cirosantilli/x86-bare-metal-examples# */
+/* https://github.com/cirosantilli/x86-bare-metal-examples#real-mode-segmentation */

 #include "common.h"
 BEGIN
--- a/reboot.S
+++ b/reboot.S
@@ -1,4 +1,4 @@
-/* https://github.com/cirosantilli/x86-bare-metal-examples# */
+/* https://github.com/cirosantilli/x86-bare-metal-examples#reboot */

 #include "common.h"
 BEGIN
--- a/rtc.S
+++ b/rtc.S
@@ -1,4 +1,4 @@
-/* https://github.com/cirosantilli/x86-bare-metal-examples# */
+/* https://github.com/cirosantilli/x86-bare-metal-examples#rct */

 /* TODO what do those numbers mean? Where is this all documented? */
 .equ RTCaddress, 0x70
--- a/segmentation.S
+++ b/segmentation.S
@@ -1,4 +1,4 @@
-/* https://github.com/cirosantilli/x86-bare-metal-examples# */
+/* https://github.com/cirosantilli/x86-bare-metal-examples#protected-mode-segmentation */

 #include "common.h"

--- a/smp.S
+++ b/smp.S
@@ -1,4 +1,4 @@
-/* https://github.com/cirosantilli/x86-bare-metal-examples# */
+/* https://github.com/cirosantilli/x86-bare-metal-examples#smp */

 /* Must be a multiple of 0x1000. */
 .equ STARTUP_CODE_ADDRESS, 0x1000
--- a/ss.S
+++ b/ss.S
@@ -1,4 +1,4 @@
-/* https://github.com/cirosantilli/x86-bare-metal-examples# */
+/* https://github.com/cirosantilli/x86-bare-metal-examples#ss */

 #include "common.h"
 BEGIN
--- a/template.S
+++ b/template.S
@@ -1,4 +1,4 @@
-/* https://github.com/cirosantilli/x86-bare-metal-examples# */
+/* https://github.com/cirosantilli/x86-bare-metal-examples#minimal-gas-example */

 #include "common.h"
 BEGIN
--- a/test_pit_sleep_protected.S
+++ b/test_pit_sleep_protected.S
@@ -1,4 +1,4 @@
-/* https://github.com/cirosantilli/x86-bare-metal-examples# */
+/* https://github.com/cirosantilli/x86-bare-metal-examples#pit_sleep_ticks */

 #include "common.h"
 BEGIN
--- a/test_pit_sleep_ticks.S
+++ b/test_pit_sleep_ticks.S
@@ -1,4 +1,4 @@
-/* https://github.com/cirosantilli/x86-bare-metal-examples# */
+/* https://github.com/cirosantilli/x86-bare-metal-examples#pit_sleep_ticks */

 #include "common.h"
 BEGIN
--- a/test_print_bytes.S
+++ b/test_print_bytes.S
@@ -1,4 +1,4 @@
-/* https://github.com/cirosantilli/x86-bare-metal-examples# */
+/* https://github.com/cirosantilli/x86-bare-metal-examples#print_bytes */

 #include "common.h"
 BEGIN
--- a/test_vga_print_bytes.S
+++ b/test_vga_print_bytes.S
@@ -1,4 +1,4 @@
-/* https://github.com/cirosantilli/x86-bare-metal-examples# */
+/* https://github.com/cirosantilli/x86-bare-metal-examples#unit-tests */

 #include "common.h"
 BEGIN