Skip to content

Commit

Permalink
doc: add explanation on mfsBSD and the location of the project reposi…
Browse files Browse the repository at this point in the history
…tory

Addresses feedback from @lsalvadore on freebsd#192.

Signed-off-by: Soobin Rho <[email protected]>
  • Loading branch information
soobinrho committed Jun 28, 2023
1 parent 803d455 commit 0395d86
Showing 1 changed file with 15 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,24 @@ link:https://wiki.freebsd.org/SummerOfCode2023Projects/IntegrateMfsBSDIntoTheRel

Contact: Soobin Rho <soobinrho@FreeBSD.org>

==== Purpose of this project

This project creates an additional target of the weekly snapshots of -current and -stable versions of mfsBSD images in the src/release makefile.
The problem this project aims to address is that, since only the release versions of mfsBSD images are produced currently, they tend to get out of sync with the tools in base.

==== What is mfsBSD?

"mfsBSD is a toolset to create small-sized but full-featured mfsroot based distributions of FreeBSD that store all files in memory (MFS) [Memory File System] and load from hard drive, usb storage device or optical media.
It can be used for a variety of purposes, including diskless systems, recovery partitions and remotely overwriting other operating systems."
(link:https://people.freebsd.org/~mm/mfsbsd/mfsbsd.pdf[])
Martin Matuska <[email protected]> is both the author of the white paper above and the maintainer of the mfsBSD repository.
(link:https://github.com/mmatuska/mfsbsd[])

==== Location of this project

This project is a GSoC 2023 (Google Summer of Code) project, under mentorship from Juraj Lutter and Joseph Mingrone.
As a GSoC project, the official coding period is between May 29, 2023 and August 28, 2023.
As a humble beginner in the open-source community, I welcome all comments / suggestions / PR's to my fork, which is where all the code for this project will be located for the duration of the official GSoC coding period.
(link:https://github.com/soobinrho/freebsd-src/tree/integrate-mfsBSD-building)

Sponsor: Google, Inc. (GSoC 2023)

0 comments on commit 0395d86

Please sign in to comment.