Use the full filename (eg, "Mailinglist.md") in markdown links.
Signed-off-by: Kevin O'Connor <ke...@koconnor.net>
---
docs/Build_overview.md | 13 +++++++------
docs/Contributing.md | 4 ++--
docs/Debugging.md | 3 ++-
docs/Developer_Documentation.md | 23 ++++++++++++-----------
docs/Download.md | 2 +-
docs/Execution_and_code_flow.md | 9 +++++----
docs/Linking_overview.md | 16 ++++++++--------
docs/Memory_Model.md | 6 +++---
docs/Releases.md | 2 +-
docs/Runtime_config.md | 4 ++--
docs/SeaBIOS.md | 10 +++++-----
docs/SeaVGABIOS.md | 8 ++++----
12 files changed, 52 insertions(+), 48 deletions(-)
diff --git a/docs/Build_overview.md b/docs/Build_overview.md
index 8c6b2f4..7f37a49 100644
--- a/docs/Build_overview.md
+++ b/docs/Build_overview.md
@@ -5,7 +5,7 @@ compiler tools.
Building SeaBIOS
================
-First, [obtain the code](Download). SeaBIOS can be compiled for
+First, [obtain the code](Download.md). SeaBIOS can be compiled for
several different build targets. It is also possible to configure
additional compile time options - run **make menuconfig** to do this.
@@ -89,7 +89,8 @@ drivers. The **src/fw/** directory contains source code for
platform
firmware initialization. The **src/std/** directory contains header
files describing standard bios, firmware, and hardware interfaces.
-The **vgasrc/** directory contains code for [SeaVGABIOS](SeaVGABIOS).
+The **vgasrc/** directory contains code for
+[SeaVGABIOS](SeaVGABIOS.md).
The **scripts/** directory contains helper utilities for manipulating
and building the final roms.
@@ -98,7 +99,7 @@ The **out/** directory is created by the build process - it
contains
all intermediate and final files.
When reading the C code be aware that code that runs in 16bit mode can
-not arbitrarily access non-stack memory - see [Memory Model](Memory
-Model) for more details. For information on the major C code functions
-and where code execution starts see [Execution and code
-flow](Execution and code flow).
+not arbitrarily access non-stack memory - see [Memory
+Model](Memory_Model.md) for more details. For information on the major
+C code functions and where code execution starts see [Execution and
+code flow](Execution_and_code_flow.md).
diff --git a/docs/Contributing.md b/docs/Contributing.md
index e5d55b9..0cba88f 100644
--- a/docs/Contributing.md
+++ b/docs/Contributing.md
@@ -2,9 +2,9 @@ SeaBIOS welcomes contributions of code (either fixing bugs or
adding
new functionality). At a high level, the process to contribute a
change is:
-1. [Obtain](Download) the current code and documentation
+1. [Obtain](Download.md) the current code and documentation
2. Enhance and test the code locally
-3. Submit changes to the SeaBIOS [mailing list](Mailinglist) as a
+3. Submit changes to the SeaBIOS [mailing list](Mailinglist.md) as a
patch
4. Receive feedback, answer questions, and possibly provide updated
patches
diff --git a/docs/Debugging.md b/docs/Debugging.md
index 13cee4d..f826991 100644
--- a/docs/Debugging.md
+++ b/docs/Debugging.md
@@ -32,7 +32,8 @@ show a lot of diagnostic information without flooding the
serial port
To report an issue, please collect the serial boot log with SeaBIOS
set to a debug level of 8 and forward the full log along with a
-description of the problem to the SeaBIOS [mailing list](Mailinglist).
+description of the problem to the SeaBIOS [mailing
+list](Mailinglist.md).
Timing debug messages
=====================
diff --git a/docs/Developer_Documentation.md b/docs/Developer_Documentation.md
index 24bf48a..7ca75b6 100644
--- a/docs/Developer_Documentation.md
+++ b/docs/Developer_Documentation.md
@@ -1,25 +1,26 @@
This page is intended for developers interested in understanding and
enhancing SeaBIOS. Please also consider joining the [mailing
-list](Mailinglist).
+list](Mailinglist.md).
-The SeaBIOS code can be obtained via the [download](Download)
+The SeaBIOS code can be obtained via the [download](Download.md)
page. For specific information on building SeaBIOS for coreboot,
please see the [coreboot SeaBIOS](http://www.coreboot.org/SeaBIOS)
page.
-See details on [building SeaBIOS](Build overview).
+See details on [building SeaBIOS](Build_overview.md).
-There is also information on the SeaBIOS [Memory Model](Memory Model).
-Along with information on SeaBIOS [Execution and code flow](Execution
-and code flow). A description of the process of linking the final
-SeaBIOS binary is available at [Linking overview](Linking overview).
+There is also information on the SeaBIOS [Memory
+Model](Memory_Model.md). Along with information on SeaBIOS [Execution
+and code flow](Execution_and_code_flow.md). A description of the
+process of linking the final SeaBIOS binary is available at [Linking
+overview](Linking_overview.md).
The list of available runtime configuration items is at
-[runtime config](Runtime_config).
+[runtime config](Runtime_config.md).
To debug SeaBIOS and report problems see SeaBIOS
-[debugging](Debugging). To contribute changes to SeaBIOS see
-[contributing](Contributing).
+[debugging](Debugging.md). To contribute changes to SeaBIOS see
+[contributing](Contributing.md).
Useful links to specifications is available at [Developer
-links](Developer links).
+links](Developer_links.md).
diff --git a/docs/Download.md b/docs/Download.md
index 861e6d5..5cb8562 100644
--- a/docs/Download.md
+++ b/docs/Download.md
@@ -24,4 +24,4 @@ Released versions of the source code are available at:
<https://www.seabios.org/downloads/>
-Please see [releases](Releases) for information on each release.
+Please see [releases](Releases.md) for information on each release.
diff --git a/docs/Execution_and_code_flow.md b/docs/Execution_and_code_flow.md
index 4a7ba8d..39395ec 100644
--- a/docs/Execution_and_code_flow.md
+++ b/docs/Execution_and_code_flow.md
@@ -36,7 +36,8 @@ process.
The POST phase itself has several sub-phases.
-* The "preinit" sub-phase: code run prior to [code relocation](Linking
overview#Code relocation).
+* The "preinit" sub-phase: code run prior to
+ [code relocation](Linking_overview.md#Code relocation).
* The "init" sub-phase: code to initialize internal variables and
interfaces.
* The "setup" sub-phase: code to setup hardware and drivers.
@@ -63,7 +64,7 @@ but it can also be invoked by an operating system or be
invoked
multiple times in an attempt to find a valid boot media. Although the
boot phase C code runs in 32bit mode it does not have write access to
the 0x0f0000-0x100000 memory region and can not call the various
-malloc_X() calls. See [Memory Model](Memory Model) for
+malloc_X() calls. See [Memory Model](Memory_Model.md) for
more information.
Main runtime phase
@@ -167,8 +168,8 @@ very small amounts of stack space (100 bytes or less).
By default, SeaBIOS now switches to its own stack on most 16bit real
mode entry points. This extra stack space is allocated in ["low
-memory"](Memory Model). It ensures SeaBIOS uses a minimal amount of a
-callers stack (typically no more than 16 bytes) for these legacy
+memory"](Memory_Model.md). It ensures SeaBIOS uses a minimal amount of
+a callers stack (typically no more than 16 bytes) for these legacy
calls. (More recently defined BIOS interfaces such as those that
support 16bit protected and 32bit protected mode calls standardize a
minimum stack size with adequate space, and SeaBIOS generally will not
diff --git a/docs/Linking_overview.md b/docs/Linking_overview.md
index bcb8298..36ae8e5 100644
--- a/docs/Linking_overview.md
+++ b/docs/Linking_overview.md
@@ -7,10 +7,10 @@ is due to several unusual requirements:
* Some BIOS entry points must reside at specific hardcoded memory
locations. The build must support positioning code and variables at
specific locations.
-* In order to support multiple [memory models](Memory Model) the same
- C code can be complied in three modes (16bit mode, 32bit segmented
- mode, and 32bit "flat" mode). Binary code from these three modes
- must be able to co-exist and on occasion reference each other.
+* In order to support multiple [memory models](Memory_Model.md) the
+ same C code can be complied in three modes (16bit mode, 32bit
+ segmented mode, and 32bit "flat" mode). Binary code from these three
+ modes must be able to co-exist and on occasion reference each other.
* There is a finite amount of memory available to the BIOS. The build
will attempt to weed out unused code and variables from the final
binary. It also supports self-relocation of one-time initialization
@@ -28,7 +28,7 @@ its own
section.
The C code is compiled three times into three separate objects for
-each of the major supported [memory models](Memory Model):
+each of the major supported [memory models](Memory_Model.md):
**code16.o**, **code32seg.o**, and **code32flat.o**. Information on
the sections and symbols of these three objects are extracted (using
**objdump**) and passed in to the **scripts/layoutrom.py** python
@@ -70,9 +70,9 @@ reduces the overall size of the final binary.
C code in three modes
---------------------
-SeaBIOS must support multiple [memory models](Memory Model). This is
-accomplished by compiling the C code three separate times into three
-separate objects.
+SeaBIOS must support multiple [memory models](Memory_Model.md). This
+is accomplished by compiling the C code three separate times into
+three separate objects.
The C code within a mode must not accidentally call a C function in
another mode, but multiple modes must all access the same single copy
diff --git a/docs/Memory_Model.md b/docs/Memory_Model.md
index 1ebe865..8be3a95 100644
--- a/docs/Memory_Model.md
+++ b/docs/Memory_Model.md
@@ -86,7 +86,7 @@ for 32bit code - modern compilers and modern operating
systems will
generally only support this mode (when running 32bit code).
Ironically, it's the only mode that is not strictly required for a
BIOS to support. SeaBIOS uses this mode internally to support the POST
-and BOOT [phases of execution](Execution and code flow).
+and BOOT [phases of execution](Execution_and_code_flow.md).
code16gcc
=========
@@ -121,7 +121,7 @@ Common memory used at run-time
==============================
There are several memory areas that the SeaBIOS "runtime"
-[phase](Execution and code flow) makes use of:
+[phase](Execution_and_code_flow.md) makes use of:
* 0x000000-0x000400: Interrupt descriptor table (IDT). This area
defines 256 interrupt vectors as defined by the Intel CPU
@@ -218,7 +218,7 @@ macros are also available.
Memory available during initialization
======================================
-During the POST [phase](Execution and code flow) the code
+During the POST [phase](Execution_and_code_flow.md) the code
can fully access the first 4 gigabytes of memory. However, memory
accesses are generally limited to the [common memory used at
run-time](#Common_memory_used_at_run-time) and areas
diff --git a/docs/Releases.md b/docs/Releases.md
index 08851ab..62ce2d5 100644
--- a/docs/Releases.md
+++ b/docs/Releases.md
@@ -1,4 +1,4 @@
-History of SeaBIOS releases. Please see [download](Download) for
+History of SeaBIOS releases. Please see [download](Download.md) for
information on obtaining these releases.
SeaBIOS 1.17.0
diff --git a/docs/Runtime_config.md b/docs/Runtime_config.md
index f5e0cbd..9772678 100644
--- a/docs/Runtime_config.md
+++ b/docs/Runtime_config.md
@@ -96,8 +96,8 @@ parameter](#Other_Configuration_items).
The JPEG viewer in SeaBIOS uses a simplified decoding algorithm. It
supports most common JPEGs, but does not support all possible formats.
-Please see the [trouble reporting section](Debugging) if a valid image
-isn't displayed properly.
+Please see the [trouble reporting section](Debugging.md) if a valid
+image isn't displayed properly.
Payloads
========
diff --git a/docs/SeaBIOS.md b/docs/SeaBIOS.md
index e24913a..f751862 100644
--- a/docs/SeaBIOS.md
+++ b/docs/SeaBIOS.md
@@ -7,11 +7,11 @@ SeaBIOS is the default BIOS for [qemu](http://www.qemu.org/)
and
The [coreboot SeaBIOS](http://www.coreboot.org/SeaBIOS) page has
information on using SeaBIOS in coreboot. Please see the
-[releases](Releases) page for information on recent releases. See the
-[download](Download) page to obtain SeaBIOS.
+[releases](Releases.md) page for information on recent releases. See
+the [download](Download.md) page to obtain SeaBIOS.
-[SeaVGABIOS](SeaVGABIOS) is a sub-project of SeaBIOS.
+[SeaVGABIOS](SeaVGABIOS.md) is a sub-project of SeaBIOS.
-Please join the [mailing list](Mailinglist) to contribute to
+Please join the [mailing list](Mailinglist.md) to contribute to
SeaBIOS. Information on the internals of SeaBIOS is available on the
-[Developer Documentation](Developer Documentation) page.
+[Developer Documentation](Developer_Documentation.md) page.
diff --git a/docs/SeaVGABIOS.md b/docs/SeaVGABIOS.md
index 7ec2780..6f8b273 100644
--- a/docs/SeaVGABIOS.md
+++ b/docs/SeaVGABIOS.md
@@ -8,7 +8,7 @@ run natively on some X86 VGA hardware with
Building SeaVGABIOS
===================
-To build SeaVGABIOS, obtain the [code](Download), run `make
+To build SeaVGABIOS, obtain the [code](Download.md), run `make
menuconfig` and select the type of VGA BIOS to build in the "VGA ROM"
menu. Once selected, run `make` and the final VGA BIOS binary will be
located in "out/vgabios.bin".
@@ -27,13 +27,13 @@ SeaVGABIOS code
===============
The source code for SeaVGABIOS is located in the SeaBIOS
-[git repository](Download). The main VGA BIOS code is located in the
+[git repository](Download.md). The main VGA BIOS code is located in the
"vgasrc/" directory. The VGA BIOS code is always compiled in 16bit
mode.
The SeaVGABIOS builds to a separate binary from the main SeaBIOS
binary, and much of the VGA BIOS code is separate from the main BIOS
code. However, much of the SeaBIOS
-[developer documentation](Developer_Documentation) applies to
+[developer documentation](Developer_Documentation.md) applies to
SeaVGABIOS. To contribute, please join the
-[SeaBIOS mailing list](Mailinglist).
+[SeaBIOS mailing list](Mailinglist.md).
--
2.50.1
_______________________________________________
SeaBIOS mailing list -- seabios@seabios.org
To unsubscribe send an email to seabios-le...@seabios.org
