Skip to content

Commit

Permalink
doc: add status report for mfsBSD building integration
Browse files Browse the repository at this point in the history
doc: fix typos ('Sponsored : ' -> 'Sponsor: ')
doc: add explanation on mfsBSD and the location of the project repository
doc: split into 3 sentences for better flow
doc: add a missing set of brackets "[]" to a link
doc: add emails of mentors and change the first person (I) to the third person
doc: addresse feedback from @lsalvadore on #192

Sponsored by: Google, Inc. (GSoC 2023)
Co-authored-by: Pau Amma <[email protected]>
Signed-off-by: Soobin Rho <[email protected]>
  • Loading branch information
soobinrho and pauamma committed Jun 28, 2023
1 parent 8b91841 commit 7922cd2
Showing 1 changed file with 28 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
=== Integrate mfsBSD into the release building tools

Links: +
link:https://wiki.freebsd.org/SummerOfCode2023Projects/IntegrateMfsBSDIntoTheReleaseBuildingTools[Wiki Article] URL: link:https://wiki.freebsd.org/SummerOfCode2023Projects/IntegrateMfsBSDIntoTheReleaseBuildingTools[]

Contact: Soobin Rho <soobinrho@FreeBSD.org>

==== What is mfsBSD?

"link:https://people.freebsd.org/~mm/mfsbsd/mfsbsd.pdf[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."

mailto:[email protected][Martin Matuska] is both the author of the white paper above and the maintainer of the link:https://github.com/mmatuska/mfsbsd[mfsBSD repository].

==== 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.
Currently, only the release versions of mfsBSD images are produced, which means they tend to get out of sync with the tools in base.
This project aims to address that problem.

==== Location of this project

This project is a GSoC 2023 (Google Summer of Code) project, under mentorship from mailto:[email protected][Juraj Lutter] and mailto:[email protected][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, the author of this project welcomes all comments / suggestions / PR's to the link:https://github.com/soobinrho/freebsd-src/tree/integrate-mfsBSD-building[project repository], which is where all the code for this project will be located for the duration of the official GSoC coding period.

Sponsor: Google, Inc. (GSoC 2023)

0 comments on commit 7922cd2

Please sign in to comment.