Commit c54ad9a4 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Jonathan Corbet

docs: filesystems: convert befs.txt to ReST

- Add a SPDX header;
- Adjust document and section titles;
- Some whitespace fixes and new line breaks;
- Mark literal blocks as such;
- Add table markups;
- Add it to filesystems/index.rst.
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/3e29ea6df6cd569021cfa953ccb8ed7dfc146f3d.1581955849.git.mchehab+huawei@kernel.orgSigned-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent c64d3dc6
.. SPDX-License-Identifier: GPL-2.0
=========================
BeOS filesystem for Linux BeOS filesystem for Linux
=========================
Document last updated: Dec 6, 2001 Document last updated: Dec 6, 2001
WARNING Warning
======= =======
Make sure you understand that this is alpha software. This means that the Make sure you understand that this is alpha software. This means that the
implementation is neither complete nor well-tested. implementation is neither complete nor well-tested.
I DISCLAIM ALL RESPONSIBILITY FOR ANY POSSIBLE BAD EFFECTS OF THIS CODE! I DISCLAIM ALL RESPONSIBILITY FOR ANY POSSIBLE BAD EFFECTS OF THIS CODE!
LICENSE License
===== =======
This software is covered by the GNU General Public License. This software is covered by the GNU General Public License.
See the file COPYING for the complete text of the license. See the file COPYING for the complete text of the license.
Or the GNU website: <http://www.gnu.org/licenses/licenses.html> Or the GNU website: <http://www.gnu.org/licenses/licenses.html>
AUTHOR Author
===== ======
The largest part of the code written by Will Dyson <will_dyson@pobox.com> The largest part of the code written by Will Dyson <will_dyson@pobox.com>
He has been working on the code since Aug 13, 2001. See the changelog for He has been working on the code since Aug 13, 2001. See the changelog for
details. details.
Original Author: Makoto Kato <m_kato@ga2.so-net.ne.jp> Original Author: Makoto Kato <m_kato@ga2.so-net.ne.jp>
His original code can still be found at: His original code can still be found at:
<http://hp.vector.co.jp/authors/VA008030/bfs/> <http://hp.vector.co.jp/authors/VA008030/bfs/>
Does anyone know of a more current email address for Makoto? He doesn't Does anyone know of a more current email address for Makoto? He doesn't
respond to the address given above... respond to the address given above...
This filesystem doesn't have a maintainer. This filesystem doesn't have a maintainer.
WHAT IS THIS DRIVER? What is this Driver?
================== ====================
This module implements the native filesystem of BeOS http://www.beincorporated.com/ This module implements the native filesystem of BeOS http://www.beincorporated.com/
for the linux 2.4.1 and later kernels. Currently it is a read-only for the linux 2.4.1 and later kernels. Currently it is a read-only
implementation. implementation.
Which is it, BFS or BEFS? Which is it, BFS or BEFS?
================ =========================
Be, Inc said, "BeOS Filesystem is officially called BFS, not BeFS". Be, Inc said, "BeOS Filesystem is officially called BFS, not BeFS".
But Unixware Boot Filesystem is called bfs, too. And they are already in But Unixware Boot Filesystem is called bfs, too. And they are already in
the kernel. Because of this naming conflict, on Linux the BeOS the kernel. Because of this naming conflict, on Linux the BeOS
filesystem is called befs. filesystem is called befs.
HOW TO INSTALL How to Install
============== ==============
step 1. Install the BeFS patch into the source code tree of linux. step 1. Install the BeFS patch into the source code tree of linux.
...@@ -54,16 +60,16 @@ is called patch-befs-xxx, you would do the following: ...@@ -54,16 +60,16 @@ is called patch-befs-xxx, you would do the following:
patch -p1 < /path/to/patch-befs-xxx patch -p1 < /path/to/patch-befs-xxx
if the patching step fails (i.e. there are rejected hunks), you can try to if the patching step fails (i.e. there are rejected hunks), you can try to
figure it out yourself (it shouldn't be hard), or mail the maintainer figure it out yourself (it shouldn't be hard), or mail the maintainer
(Will Dyson <will_dyson@pobox.com>) for help. (Will Dyson <will_dyson@pobox.com>) for help.
step 2. Configuration & make kernel step 2. Configuration & make kernel
The linux kernel has many compile-time options. Most of them are beyond the The linux kernel has many compile-time options. Most of them are beyond the
scope of this document. I suggest the Kernel-HOWTO document as a good general scope of this document. I suggest the Kernel-HOWTO document as a good general
reference on this topic. http://www.linuxdocs.org/HOWTOs/Kernel-HOWTO-4.html reference on this topic. http://www.linuxdocs.org/HOWTOs/Kernel-HOWTO-4.html
However, to use the BeFS module, you must enable it at configure time. However, to use the BeFS module, you must enable it at configure time::
cd /foo/bar/linux cd /foo/bar/linux
make menuconfig (or xconfig) make menuconfig (or xconfig)
...@@ -82,35 +88,40 @@ step 3. Install ...@@ -82,35 +88,40 @@ step 3. Install
See the kernel howto <http://www.linux.com/howto/Kernel-HOWTO.html> for See the kernel howto <http://www.linux.com/howto/Kernel-HOWTO.html> for
instructions on this critical step. instructions on this critical step.
USING BFS Using BFS
========= =========
To use the BeOS filesystem, use filesystem type 'befs'. To use the BeOS filesystem, use filesystem type 'befs'.
ex) ex::
mount -t befs /dev/fd0 /beos mount -t befs /dev/fd0 /beos
MOUNT OPTIONS Mount Options
============= =============
============= ===========================================================
uid=nnn All files in the partition will be owned by user id nnn. uid=nnn All files in the partition will be owned by user id nnn.
gid=nnn All files in the partition will be in group nnn. gid=nnn All files in the partition will be in group nnn.
iocharset=xxx Use xxx as the name of the NLS translation table. iocharset=xxx Use xxx as the name of the NLS translation table.
debug The driver will output debugging information to the syslog. debug The driver will output debugging information to the syslog.
============= ===========================================================
HOW TO GET LASTEST VERSION How to Get Lastest Version
========================== ==========================
The latest version is currently available at: The latest version is currently available at:
<http://befs-driver.sourceforge.net/> <http://befs-driver.sourceforge.net/>
ANY KNOWN BUGS? Any Known Bugs?
=========== ===============
As of Jan 20, 2002: As of Jan 20, 2002:
None None
SPECIAL THANKS Special Thanks
============== ==============
Dominic Giampalo ... Writing "Practical file system design with Be filesystem" Dominic Giampalo ... Writing "Practical file system design with Be filesystem"
Hiroyuki Yamada ... Testing LinuxPPC. Hiroyuki Yamada ... Testing LinuxPPC.
......
...@@ -52,6 +52,7 @@ Documentation for filesystem implementations. ...@@ -52,6 +52,7 @@ Documentation for filesystem implementations.
afs afs
autofs autofs
autofs-mount-control autofs-mount-control
befs
fuse fuse
overlayfs overlayfs
virtiofs virtiofs
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment