From nobody Sun Sep 21 21:44:29 2025 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of seabios.org designates 78.46.105.101 as permitted sender) client-ip=78.46.105.101; envelope-from=seabios-bounces@seabios.org; helo=coreboot.org; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of seabios.org designates 78.46.105.101 as permitted sender) smtp.mailfrom=seabios-bounces@seabios.org; dmarc=pass(p=reject dis=none) header.from=seabios.org ARC-Seal: i=1; a=rsa-sha256; t=1754523396; cv=none; d=zohomail.com; s=zohoarc; b=RqkB7zyH2+ueswcHlfxG535o5EZN8fZahrS6v95s9Ex6ngFqgpkhVS9y0n5ml7a4B3txpO7r/L/HxaqsDaHQqfwTXxw8f+uoYtArucHcY/7ifgKkdRCcIXytFs0bIumWjYPJD3blEy6C5TCPf8IdgIHR1VdX0qCuq7p8Bl4uAYw= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1754523396; h=Content-Type:Content-Transfer-Encoding:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Owner:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Reply-To:Reply-To:References:Subject:Subject:To:To:Message-Id:Cc; bh=8V6aXgNU3/enc6devRStJDO3Sk5ny0HC8ddW8vd4rWM=; b=Rk3Dm31XA6zktkfKuh2spSEPwCL3yuBAOrtQjfDUkM7RkoSLb22nRwOTWzSktrQw2MLuf5VbcCinfJ0QmH9t7uyTTwf+rXGNwHxlY5BZ6tcYWc5uj+KUrbgqBVBWBopp145l3FAFQy7lQ0kcEp7TAQyP2iKAePasa3TgGUGpx3U= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of seabios.org designates 78.46.105.101 as permitted sender) smtp.mailfrom=seabios-bounces@seabios.org; dmarc=pass header.from= (p=reject dis=none) Return-Path: Received: from coreboot.org (mail.coreboot.org [78.46.105.101]) by mx.zohomail.com with SMTPS id 1754523396874548.9089938746672; Wed, 6 Aug 2025 16:36:36 -0700 (PDT) Received: from authenticated-user (PRIMARY_HOSTNAME [PUBLIC_IP]) by coreboot.org (Postfix) with ESMTPA id 4096640335; Wed, 6 Aug 2025 23:36:34 +0000 (UTC) Received: from authenticated-user (PRIMARY_HOSTNAME [PUBLIC_IP]) [109.224.244.20]) by coreboot.org (Postfix) with ESMTP id 1690740278 for ; Wed, 6 Aug 2025 23:33:29 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=seabios.org; s=dkim; t=1754523394; h=from:from:sender:reply-to:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-owner: list-unsubscribe:list-subscribe:list-post; bh=8V6aXgNU3/enc6devRStJDO3Sk5ny0HC8ddW8vd4rWM=; b=jZCZvtcKkrlL8roOvaSLgY2ryPjOXqGVUqG0VVAql4RlZ5iiFCeTcRREmmZpN5JH44ngac hOvnaVQYS2ePsJ8BaY7KTQwHkqUnbwHGiGgAc08QxKlzjIq+CutqP06S7sHSjmJQYpNVY6 K2eVbfS0Q4UiYdBDzCTPw27GlDkXV0c= DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=koconnor.net; s=protonmail2; t=1754523207; x=1754782407; bh=prZvtXHvTYC24n3SoKfqISlaKK8lIZTyr0x4+qa15Gc=; h=Date:To:From:Subject:Message-ID:In-Reply-To:References: Feedback-ID:From:To:Cc:Date:Subject:Reply-To:Feedback-ID: Message-ID:BIMI-Selector; b=H8i0gIDkM//RH9jAo7zTlJoC5h2hZgrbryfGhTCvAFVl6sFErWO7M6pXZI9NmjD0t 8Y2gn3x6/ITSCWfRY74FDeYNhkOUlCZgoV7ATZ+yvEulFQlB6/QLZ3K2u1k46bcJV+ 1BTVWqPILST4mw7tyWG+N4E8RxwF+8mcFkWW6Do5dcJ+j9twoFQKlu0Asssh09ByOn AY5bTN9UxopKkf/HWSnJwUHe8bjYLmw0Y8nm8tzUCRv3e+m5UPvcCpXaQY+nTnyTxV jkn1QloP0caZ1rbGL8Y6wvz2UYJN2Fk5qXkJ2Sv1NPVXRFyAo6XL/BsF3Qxuqp97TN nbJ7dzqzqTLTQ== Date: Wed, 06 Aug 2025 23:33:23 +0000 To: seabios@seabios.org Message-ID: <20250806233312.868478-2-kevin@koconnor.net> In-Reply-To: <20250806233312.868478-1-kevin@koconnor.net> References: <20250806233312.868478-1-kevin@koconnor.net> Feedback-ID: 132158305:user:proton X-Pm-Message-ID: 40a8df199da4f0877877ee8f024025704bd93221 MIME-Version: 1.0 Message-ID-Hash: F5PCCQZ4IBE56T7JHBI2PRCFL4BGBTEV X-Message-ID-Hash: F5PCCQZ4IBE56T7JHBI2PRCFL4BGBTEV X-MailFrom: kevin@koconnor.net X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; loop; banned-address; header-match-seabios.seabios.org-0; header-match-seabios.seabios.org-1; emergency; member-moderation; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header X-Mailman-Version: 3.3.11b1 Precedence: list Subject: [SeaBIOS] [PATCH 1/3] docs: Fix document links List-Id: SeaBIOS mailing list Archived-At: List-Archive: List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: From: Kevin O'Connor via SeaBIOS Reply-To: Kevin O'Connor Content-Transfer-Encoding: quoted-printable Authentication-Results: coreboot.org; auth=pass smtp.auth=mailman@coreboot.org smtp.mailfrom=seabios-bounces@seabios.org X-Spamd-Bar: ---- X-ZohoMail-DKIM: pass (identity @seabios.org) X-ZM-MESSAGEID: 1754523398013116600 Content-Type: text/plain; charset="utf-8" Use the full filename (eg, "Mailinglist.md") in markdown links. Signed-off-by: Kevin O'Connor --- 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 =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 -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. =20 @@ -89,7 +89,8 @@ drivers. The **src/fw/** directory contains source code f= or platform firmware initialization. The **src/std/** directory contains header files describing standard bios, firmware, and hardware interfaces. =20 -The **vgasrc/** directory contains code for [SeaVGABIOS](SeaVGABIOS). +The **vgasrc/** directory contains code for +[SeaVGABIOS](SeaVGABIOS.md). =20 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. =20 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: =20 -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 =20 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). =20 Timing debug messages =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D 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). =20 -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. =20 -See details on [building SeaBIOS](Build overview). +See details on [building SeaBIOS](Build_overview.md). =20 -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). =20 The list of available runtime configuration items is at -[runtime config](Runtime_config). +[runtime config](Runtime_config.md). =20 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). =20 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: =20 =20 -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. =20 The POST phase itself has several sub-phases. =20 -* The "preinit" sub-phase: code run prior to [code relocation](Linking ove= rview#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 i= nvoked 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. =20 Main runtime phase @@ -167,8 +168,8 @@ very small amounts of stack space (100 bytes or less). =20 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. =20 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 --------------------- =20 -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. =20 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 sy= stems 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). =20 code16gcc =3D=3D=3D=3D=3D=3D=3D=3D=3D @@ -121,7 +121,7 @@ Common memory used at run-time =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D =20 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: =20 * 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 =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 -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. =20 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). =20 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. =20 Payloads =3D=3D=3D=3D=3D=3D=3D=3D 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.or= g/) and =20 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. =20 -[SeaVGABIOS](SeaVGABIOS) is a sub-project of SeaBIOS. +[SeaVGABIOS](SeaVGABIOS.md) is a sub-project of SeaBIOS. =20 -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 =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 -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 =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 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. =20 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). --=20 2.50.1 _______________________________________________ SeaBIOS mailing list -- seabios@seabios.org To unsubscribe send an email to seabios-leave@seabios.org From nobody Sun Sep 21 21:44:29 2025 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of seabios.org designates 78.46.105.101 as permitted sender) client-ip=78.46.105.101; envelope-from=seabios-bounces@seabios.org; helo=coreboot.org; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of seabios.org designates 78.46.105.101 as permitted sender) smtp.mailfrom=seabios-bounces@seabios.org; dmarc=pass(p=reject dis=none) header.from=seabios.org ARC-Seal: i=1; a=rsa-sha256; t=1754523555; cv=none; d=zohomail.com; s=zohoarc; b=YcTPsnzC5Mx2NJwiZrqFpeLihtM5ENLpjPNSrNHVRmgg9mDCBV6QUmfVDo/3DN/SJk4Ab+Hf5pwfqpiEsw52IiQxADUVLt68UCIvQKsyvHGJ7vxEdGGNcE0Jxxu+ZSjg8LmzEtO49AIslhwz9IvQnuelCNT78/YFU5Xjpr64vOk= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1754523555; h=Content-Type:Content-Transfer-Encoding:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Owner:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Reply-To:Reply-To:References:Subject:Subject:To:To:Message-Id:Cc; bh=ZeIR6ymbd/vURWAz+eGHIENW4qjuv4Xv5GljpLwtyOA=; b=Il0NMwGRA0o5gH6FLFaku4ny8txYbbLMYEOnw/UOAQnkRrFmN2VhPuPL9hhzmQvVcb54hslyV1DKTazecE2gs/X2U7r7r7Sh4f11WRcsGvuFARVlZ9fv4TfXYPMEsWUK5VzcUVVEQB6ikLm+lXeSq2OYRh27Cez/8EBuvhz1BLk= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of seabios.org designates 78.46.105.101 as permitted sender) smtp.mailfrom=seabios-bounces@seabios.org; dmarc=pass header.from= (p=reject dis=none) Return-Path: Received: from coreboot.org (mail.coreboot.org [78.46.105.101]) by mx.zohomail.com with SMTPS id 1754523555010993.4524024922403; Wed, 6 Aug 2025 16:39:15 -0700 (PDT) Received: from authenticated-user (PRIMARY_HOSTNAME [PUBLIC_IP]) by coreboot.org (Postfix) with ESMTPA id E3A5440329; Wed, 6 Aug 2025 23:39:07 +0000 (UTC) Received: from authenticated-user (PRIMARY_HOSTNAME [PUBLIC_IP]) [109.224.244.21]) by coreboot.org (Postfix) with ESMTP id 9F44D40278 for ; Wed, 6 Aug 2025 23:33:34 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=seabios.org; s=dkim; t=1754523548; h=from:from:sender:reply-to:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-owner: list-unsubscribe:list-subscribe:list-post; bh=ZeIR6ymbd/vURWAz+eGHIENW4qjuv4Xv5GljpLwtyOA=; b=oeoUh6OiyYu/M0PkWGE4IeEk+UEZolcE1j8U1q8frz4cYA0gEAT3IpfjytiQBv9b0Pi+yo HYK7P9mOeGn/D1QICfzEYaMJwn+vhl6WLOIRpNOeHUEcuLrZoJtFzRpnj9L7WDvc8FElcb vJKXU8NpzMqCFgNLNsRf1MmB2uCzF9I= DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=koconnor.net; s=protonmail2; t=1754523213; x=1754782413; bh=6W8ckmYPW+MTnQx3QuQ6ltNjFtEouN0lEfjTxgoF09c=; h=Date:To:From:Subject:Message-ID:In-Reply-To:References: Feedback-ID:From:To:Cc:Date:Subject:Reply-To:Feedback-ID: Message-ID:BIMI-Selector; b=aO9aZopxqbGAT4Y4RTWl0wMq+FQ+UIzYcPnrPQKeXxgg6P+hILtUFHGoOYwjVRFNm XUkCNFxs6afQRSdJy8zoabOEpKDbNs+B/+wigNumL+QWXWLqcVGrzrMPyFef26FSlM knKqV3XZg4QmJC8uECialsLrkKS4sk3a4qCQrkV60mkj7Ip18tnZ58RbTculaZe6XU ERajMkEwjooOBRlQNmIa+BWmyxj230OnKEpOeF0lnbS4asSyBIGRC8koBQcWzqsdRg Prp9C3nnhFB4/ClhWXzapcvv/Mj0O5yTZxfDmVqvO8OiX/DIhFMI3i68dZs1m7yDYF JhdQFK+tfkHhQ== Date: Wed, 06 Aug 2025 23:33:29 +0000 To: seabios@seabios.org Message-ID: <20250806233312.868478-3-kevin@koconnor.net> In-Reply-To: <20250806233312.868478-1-kevin@koconnor.net> References: <20250806233312.868478-1-kevin@koconnor.net> Feedback-ID: 132158305:user:proton X-Pm-Message-ID: b01a3c2a3c1887565218029cd1b7ce148e0e6d3f MIME-Version: 1.0 Message-ID-Hash: LBRND4OD5SZNXQ4JT2NXU7G43GLR3ZGJ X-Message-ID-Hash: LBRND4OD5SZNXQ4JT2NXU7G43GLR3ZGJ X-MailFrom: kevin@koconnor.net X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; loop; banned-address; header-match-seabios.seabios.org-0; header-match-seabios.seabios.org-1; emergency; member-moderation; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header X-Mailman-Version: 3.3.11b1 Precedence: list Subject: [SeaBIOS] [PATCH 2/3] docs: Rename docs/SeaBIOS.md to docs/index.md List-Id: SeaBIOS mailing list Archived-At: List-Archive: List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: From: Kevin O'Connor via SeaBIOS Reply-To: Kevin O'Connor Content-Transfer-Encoding: quoted-printable Authentication-Results: coreboot.org; auth=pass smtp.auth=mailman@coreboot.org smtp.mailfrom=seabios-bounces@seabios.org X-Spamd-Bar: ---- X-ZohoMail-DKIM: pass (identity @seabios.org) X-ZM-MESSAGEID: 1754523557244124100 Content-Type: text/plain; charset="utf-8" Signed-off-by: Kevin O'Connor --- docs/{SeaBIOS.md =3D> index.md} | 2 ++ 1 file changed, 2 insertions(+) rename docs/{SeaBIOS.md =3D> index.md} (98%) diff --git a/docs/SeaBIOS.md b/docs/index.md similarity index 98% rename from docs/SeaBIOS.md rename to docs/index.md index f751862..946d52b 100644 --- a/docs/SeaBIOS.md +++ b/docs/index.md @@ -1,3 +1,5 @@ +# SeaBIOS + SeaBIOS is an open source implementation of a 16bit X86 BIOS. SeaBIOS can run in an emulator or it can run natively on X86 hardware with the use of [coreboot](http://www.coreboot.org/). --=20 2.50.1 _______________________________________________ SeaBIOS mailing list -- seabios@seabios.org To unsubscribe send an email to seabios-leave@seabios.org From nobody Sun Sep 21 21:44:29 2025 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of seabios.org designates 78.46.105.101 as permitted sender) client-ip=78.46.105.101; envelope-from=seabios-bounces@seabios.org; helo=coreboot.org; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of seabios.org designates 78.46.105.101 as permitted sender) smtp.mailfrom=seabios-bounces@seabios.org; dmarc=pass(p=reject dis=none) header.from=seabios.org ARC-Seal: i=1; a=rsa-sha256; t=1754523583; cv=none; d=zohomail.com; s=zohoarc; b=epTy9f4K6QZgDeaivy4fQWctY5zOVW9khh5E4+EZG+6ftK7oovL2PjixtWwFtw3jIF+e8AoqZ0vnJSi2geuL/tu3wD4m2OCgKRnn5fCTghEtw7oNuCYDB6A4nZJgquLfKwDnyO0IZp61fgwL3V2LLIoorxjD7dcQIYRP1o/kveo= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1754523583; h=Content-Type:Content-Transfer-Encoding:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Owner:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Reply-To:Reply-To:References:Subject:Subject:To:To:Message-Id:Cc; bh=+SY/D6TTVbfzhmFqHsfmCEPQfLA1X/gTPIKH6EKsls4=; b=mUkjvSUf1YhglnqCblp5BafUpBnUmtYKZYObav4GLZFrS6rUXmXhErCKMxLKyvi4wD3KYR4ssVHtu5vnKnzq5wap7jTkMsLafFOD0gREyuKwRYkTPxBDtENLD6dMHq14JsfTMTtZJ5rZ7FeALMSuZXcqmEVX24x03wiO8twJMos= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of seabios.org designates 78.46.105.101 as permitted sender) smtp.mailfrom=seabios-bounces@seabios.org; dmarc=pass header.from= (p=reject dis=none) Return-Path: Received: from coreboot.org (mail.coreboot.org [78.46.105.101]) by mx.zohomail.com with SMTPS id 1754523583672997.9158452940366; Wed, 6 Aug 2025 16:39:43 -0700 (PDT) Received: from authenticated-user (PRIMARY_HOSTNAME [PUBLIC_IP]) by coreboot.org (Postfix) with ESMTPA id 83CD740376; Wed, 6 Aug 2025 23:39:41 +0000 (UTC) Received: from authenticated-user (PRIMARY_HOSTNAME [PUBLIC_IP]) [185.70.43.17]) by coreboot.org (Postfix) with ESMTP id D6BB2402D2 for ; Wed, 6 Aug 2025 23:33:42 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=seabios.org; s=dkim; t=1754523581; h=from:from:sender:reply-to:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-owner: list-unsubscribe:list-subscribe:list-post; bh=+SY/D6TTVbfzhmFqHsfmCEPQfLA1X/gTPIKH6EKsls4=; b=IMadpDcCcYt/pU+kzCt4R1xayiR1WRloGS9/GokMVzcZsDWQNHEZHeWW462QDrTS9wHsGb +iS9CRizgSPkaSEZcT1ePq7XVUDfV+l5GR/xXKBALzM01ZzcSCSqhNafPzi0AnxZTasKHR 2VmDGHfWDkp6qsg8HieNPQQ9OtmoOs4= DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=koconnor.net; s=protonmail2; t=1754523220; x=1754782420; bh=bG2TjS3E6syYanCfX1sl787P4ZhP6pLNVvV9VcxGBGQ=; h=Date:To:From:Subject:Message-ID:In-Reply-To:References: Feedback-ID:From:To:Cc:Date:Subject:Reply-To:Feedback-ID: Message-ID:BIMI-Selector; b=a2WKrEYjwurl5Wxh+Lo0rXo3Zs+Mbktsw5+BqJcuvxtw9O1mTxOcecN2eNISu8SaA xY009Xk/pQzW946snKA2tyvLjJ51NO60PHct2CQafxR4mvtRFTn7XadFSG/K/VUFp3 hNWGm7dcCaOpFpjobWGT4VUr16rjrKVcg222uw/jPWdDlW3sjLs8c/LEktuoL6YKKM RzJ9V4jKqs2NNK69kXTZfbfulfVknUhvnDtFgOL/7uN395dFC8XrjtUN2yVZkfFi+v WNtk6VC+oY0Ol1MqCKV3EteUlTMGLSeEkw/IhgUKZXFWkOtduoGsN5IFQxcbo3fQC5 7z/aEaJJ2+/7Q== Date: Wed, 06 Aug 2025 23:33:35 +0000 To: seabios@seabios.org Message-ID: <20250806233312.868478-4-kevin@koconnor.net> In-Reply-To: <20250806233312.868478-1-kevin@koconnor.net> References: <20250806233312.868478-1-kevin@koconnor.net> Feedback-ID: 132158305:user:proton X-Pm-Message-ID: 836ea020ef87d73763aa9ed790a7657f0a66a359 MIME-Version: 1.0 Message-ID-Hash: OG7QL6U4Y5VEFMKXBI2IWZEWUFXFXQIJ X-Message-ID-Hash: OG7QL6U4Y5VEFMKXBI2IWZEWUFXFXQIJ X-MailFrom: kevin@koconnor.net X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; loop; banned-address; header-match-seabios.seabios.org-0; header-match-seabios.seabios.org-1; emergency; member-moderation; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header X-Mailman-Version: 3.3.11b1 Precedence: list Subject: [SeaBIOS] [PATCH 3/3] docs: Add mkdocs build tools for building the seabios.org website List-Id: SeaBIOS mailing list Archived-At: List-Archive: List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: From: Kevin O'Connor via SeaBIOS Reply-To: Kevin O'Connor Content-Transfer-Encoding: quoted-printable Authentication-Results: coreboot.org; auth=pass smtp.auth=mailman@coreboot.org smtp.mailfrom=seabios-bounces@seabios.org X-Spamd-Bar: --- X-ZohoMail-DKIM: pass (identity @seabios.org) X-ZM-MESSAGEID: 1754523585584124100 Content-Type: text/plain; charset="utf-8" Support converting the existing SeaBIOS documentation into a website using the mkdocs tool. Signed-off-by: Kevin O'Connor --- docs/_website/README | 12 ++++++ docs/_website/mkdocs-requirements.txt | 10 +++++ docs/_website/mkdocs.yml | 62 +++++++++++++++++++++++++++ 3 files changed, 84 insertions(+) create mode 100644 docs/_website/README create mode 100644 docs/_website/mkdocs-requirements.txt create mode 100644 docs/_website/mkdocs.yml diff --git a/docs/_website/README b/docs/_website/README new file mode 100644 index 0000000..59c7c70 --- /dev/null +++ b/docs/_website/README @@ -0,0 +1,12 @@ +This directory defines the https://www.seabios.org/ website. + +To test deploy the main site locally one can use commands similar to +the following: + +virtualenv ~/mkdocs-env && ~/mkdocs-env/bin/pip install -r ~/seabios/docs/= _website/mkdocs-requirements.txt +cd ~/seabios && ~/mkdocs-env/bin/mkdocs serve --config-file ~/seabios/docs= /_website/mkdocs.yml -a 0.0.0.0:8000 + +To build the main html run something similar to: + +virtualenv ~/mkdocs-env && ~/mkdocs-env/bin/pip install -r ~/seabios/docs/= _website/mkdocs-requirements.txt +~/mkdocs-env/bin/mkdocs build -f ~/seabios/docs/_website/mkdocs.yml -d ~/s= eabios-site/ diff --git a/docs/_website/mkdocs-requirements.txt b/docs/_website/mkdocs-r= equirements.txt new file mode 100644 index 0000000..08410b1 --- /dev/null +++ b/docs/_website/mkdocs-requirements.txt @@ -0,0 +1,10 @@ +# Python virtualenv module requirements for mkdocs +jinja2=3D=3D3.1.6 +mkdocs=3D=3D1.2.4 +mkdocs-material=3D=3D8.1.3 +mkdocs-simple-hooks=3D=3D0.1.3 +mkdocs-exclude=3D=3D1.0.2 +mdx-truly-sane-lists=3D=3D1.3 +mdx-breakless-lists=3D=3D1.0.1 +py-gfm=3D=3D2.0.0 +markdown=3D=3D3.7 diff --git a/docs/_website/mkdocs.yml b/docs/_website/mkdocs.yml new file mode 100644 index 0000000..d12806b --- /dev/null +++ b/docs/_website/mkdocs.yml @@ -0,0 +1,62 @@ +# Main configuration file for mkdocs generation of www.seabios.org website + +# Site and directory configuration +site_name: SeaBIOS documentation +repo_url: https://git.seabios.org/ +use_directory_urls: False +docs_dir: '../' + +# Custom markdown dialect settings +markdown_extensions: + - toc: + permalink: True + toc_depth: 6 + - attr_list + - mdx_partial_gfm + - mdx_truly_sane_lists + - mdx_breakless_lists +plugins: + search: + lang: en + +# Website layout configuration (using mkdocs-material theme) +theme: + name: material + palette: + - media: "(prefers-color-scheme: light)" + scheme: default + primary: white + accent: blue + toggle: + icon: material/lightbulb + name: Switch to dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + primary: grey + accent: light blue + toggle: + icon: material/lightbulb-outline + name: Switch to light mode + features: + - navigation.top + - search.suggest + - search.highlight + - search.share + language: en + +# Navigation hierarchy +nav: + - Download.md + - Releases.md + - Mailinglist.md + - Developer Documentation: + - Developer_Documentation.md + - Build_overview.md + - Memory_Model.md + - Execution_and_code_flow.md + - Linking_overview.md + - Runtime_config.md + - Debugging.md + - Contributing.md + - Developer_links.md + - SeaVGABIOS.md --=20 2.50.1 _______________________________________________ SeaBIOS mailing list -- seabios@seabios.org To unsubscribe send an email to seabios-leave@seabios.org