diff options
| author | Mauro Carvalho Chehab | 2020-04-27 23:17:14 +0200 |
|---|---|---|
| committer | Jonathan Corbet | 2020-05-05 09:22:23 -0600 |
| commit | dc3f043ff0e44862a237d87f37ca04694d884049 (patch) | |
| tree | 6514e8f4b516b5b26c46c2325ad57d613d213c60 /Documentation/filesystems | |
| parent | a5a1c349ac48252e871abaecabc158f761e0aa92 (diff) | |
docs: filesystems: convert spufs/spu_create.txt to ReST
This file is at groff output format. Manually convert it to
ReST format, trying to preserve a similar output after parsed.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/4d42e97d5560a79bd5dd443c592be04f9ae9a757.1588021877.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/filesystems')
| -rw-r--r-- | Documentation/filesystems/index.rst | 1 | ||||
| -rw-r--r-- | Documentation/filesystems/spufs/index.rst | 11 | ||||
| -rw-r--r-- | Documentation/filesystems/spufs/spu_create.rst (renamed from Documentation/filesystems/spufs/spu_create.txt) | 52 |
3 files changed, 44 insertions, 20 deletions
diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst index c658ddee40fa..5fb2b2166204 100644 --- a/Documentation/filesystems/index.rst +++ b/Documentation/filesystems/index.rst @@ -105,6 +105,7 @@ Documentation for filesystem implementations. ramfs-rootfs-initramfs relay romfs + spufs/index squashfs sysfs sysv-fs diff --git a/Documentation/filesystems/spufs/index.rst b/Documentation/filesystems/spufs/index.rst new file mode 100644 index 000000000000..39553c6ebefd --- /dev/null +++ b/Documentation/filesystems/spufs/index.rst @@ -0,0 +1,11 @@ +.. SPDX-License-Identifier: GPL-2.0 + +============== +SPU Filesystem +============== + + +.. toctree:: + :maxdepth: 1 + + spu_create diff --git a/Documentation/filesystems/spufs/spu_create.txt b/Documentation/filesystems/spufs/spu_create.rst index 8ede5a35340f..83108c099696 100644 --- a/Documentation/filesystems/spufs/spu_create.txt +++ b/Documentation/filesystems/spufs/spu_create.rst @@ -1,18 +1,26 @@ -SPU_CREATE(2) Linux Programmer's Manual SPU_CREATE(2) +.. SPDX-License-Identifier: GPL-2.0 +========== +spu_create +========== - -NAME +Name +==== spu_create - create a new spu context -SYNOPSIS - #include <sys/types.h> - #include <sys/spu.h> +Synopsis +======== + + :: + + #include <sys/types.h> + #include <sys/spu.h> - int spu_create(const char *pathname, int flags, mode_t mode); + int spu_create(const char *pathname, int flags, mode_t mode); -DESCRIPTION +Description +=========== The spu_create system call is used on PowerPC machines that implement the Cell Broadband Engine Architecture in order to access Synergistic Processor Units (SPUs). It creates a new logical context for an SPU in @@ -43,13 +51,15 @@ DESCRIPTION possible mode values. -RETURN VALUE +Return Value +============ spu_create returns a new file descriptor. It may return -1 to indicate an error condition and set errno to one of the error codes listed below. -ERRORS +Errors +====== EACCES The current user does not have write access on the spufs mount point. @@ -87,33 +97,35 @@ ERRORS -NOTES +Notes +===== spu_create is meant to be used from libraries that implement a more abstract interface to SPUs, not to be used from regular applications. See http://www.bsc.es/projects/deepcomputing/linuxoncell/ for the rec- ommended libraries. -FILES +Files +===== pathname must point to a location beneath the mount point of spufs. By convention, it gets mounted in /spu. -CONFORMING TO +Conforming to +============= This call is Linux specific and only implemented by the ppc64 architec- ture. Programs using this system call are not portable. -BUGS +Bugs +==== The code does not yet fully implement all features lined out here. -AUTHOR +Author +====== Arnd Bergmann <arndb@de.ibm.com> -SEE ALSO +See Also +======== capabilities(7), close(2), spu_run(2), spufs(7) - - - -Linux 2005-09-28 SPU_CREATE(2) |