diff options
| author | Sascha Hauer <s.hauer@pengutronix.de> | 2014-06-17 10:37:25 +0200 |
|---|---|---|
| committer | Sascha Hauer <s.hauer@pengutronix.de> | 2014-06-26 11:07:10 +0200 |
| commit | 3fef396bb42efc0bb12b0a8caf0d076ab1c4d879 (patch) | |
| tree | 91625b2407ed25dffd093b19159135481eb80f84 /Documentation/filesystems | |
| parent | 7e65163b9165bccca780da91fad247c0e4ac7f9f (diff) | |
| download | barebox-3fef396bb42efc0bb12b0a8caf0d076ab1c4d879.tar.gz barebox-3fef396bb42efc0bb12b0a8caf0d076ab1c4d879.tar.xz | |
Documentation: Add new sphinxs docs
This is a rewrite of the Documentation in reStructuredText format using
Sphinx as build system, see http://sphinx-doc.org/.
The documentation is built into static html pages with 'make docs'.
The pages can be found under Documentation/html after building.
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
Diffstat (limited to 'Documentation/filesystems')
| -rw-r--r-- | Documentation/filesystems/fat.rst | 15 | ||||
| -rw-r--r-- | Documentation/filesystems/nfs.rst | 12 | ||||
| -rw-r--r-- | Documentation/filesystems/ramfs.rst | 10 | ||||
| -rw-r--r-- | Documentation/filesystems/tftp.rst | 16 |
4 files changed, 53 insertions, 0 deletions
diff --git a/Documentation/filesystems/fat.rst b/Documentation/filesystems/fat.rst new file mode 100644 index 0000000000..2138328d18 --- /dev/null +++ b/Documentation/filesystems/fat.rst @@ -0,0 +1,15 @@ +.. index:: fat (filesystem) + +FAT filesystem +============== + +barebox supports FAT filesystems in both read and write modes with optional +support for long filenames. A FAT filesystem can be mounted using the +:ref:`command_mount` command:: + + mkdir /mnt + mount /dev/disk0.0 fat /mnt + ls /mnt + zImage barebox.bin + umount /mnt + diff --git a/Documentation/filesystems/nfs.rst b/Documentation/filesystems/nfs.rst new file mode 100644 index 0000000000..b8ad4f3fe3 --- /dev/null +++ b/Documentation/filesystems/nfs.rst @@ -0,0 +1,12 @@ +.. index:: nfs (filesystem) + +.. _filesystems_nfs: + +NFS Support +=========== + +barebox has readonly support for NFSv3 un UDP mode. + +Example:: + + mount -t nfs 192.168.23.4:/home/user/nfsroot /mnt/nfs diff --git a/Documentation/filesystems/ramfs.rst b/Documentation/filesystems/ramfs.rst new file mode 100644 index 0000000000..37d6ffc8c7 --- /dev/null +++ b/Documentation/filesystems/ramfs.rst @@ -0,0 +1,10 @@ +.. index:: ramfs (filesystem) + +ram filesystem +============== + +ramfs is a simple malloc based filesystem. An instance of ramfs is mounted during startup on /. The filesystemtype passed to mount is 'ramfs' + +example:: + + mount none ramfs /somedir diff --git a/Documentation/filesystems/tftp.rst b/Documentation/filesystems/tftp.rst new file mode 100644 index 0000000000..273be5ee2a --- /dev/null +++ b/Documentation/filesystems/tftp.rst @@ -0,0 +1,16 @@ +.. index:: tftp (filesystem) + +.. _filesystems_tftp: + +TFTP support +============ + +barebox has read/write support for the Trivial File Transfer Protocol. + +TFTP is not designed as a filesystem. It does not have support for listing +directories. This means a :ref:`command_ls` to a TFTP mounted path will show an empty +directory. Nevertheless the files are there. + +Example:: + + mount -t tftp 192.168.23.4 /mnt/tftp |