Skip to content

Commit dc3f043

Browse files
mchehabJonathan Corbet
authored andcommitted
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>
1 parent a5a1c34 commit dc3f043

3 files changed

Lines changed: 44 additions & 20 deletions

File tree

Documentation/filesystems/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,7 @@ Documentation for filesystem implementations.
105105
ramfs-rootfs-initramfs
106106
relay
107107
romfs
108+
spufs/index
108109
squashfs
109110
sysfs
110111
sysv-fs
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.. SPDX-License-Identifier: GPL-2.0
2+
3+
==============
4+
SPU Filesystem
5+
==============
6+
7+
8+
.. toctree::
9+
:maxdepth: 1
10+
11+
spu_create

Documentation/filesystems/spufs/spu_create.txt renamed to Documentation/filesystems/spufs/spu_create.rst

Lines changed: 32 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,26 @@
1-
SPU_CREATE(2) Linux Programmer's Manual SPU_CREATE(2)
1+
.. SPDX-License-Identifier: GPL-2.0
22
3+
==========
4+
spu_create
5+
==========
36

4-
5-
NAME
7+
Name
8+
====
69
spu_create - create a new spu context
710

811

9-
SYNOPSIS
10-
#include <sys/types.h>
11-
#include <sys/spu.h>
12+
Synopsis
13+
========
14+
15+
::
16+
17+
#include <sys/types.h>
18+
#include <sys/spu.h>
1219

13-
int spu_create(const char *pathname, int flags, mode_t mode);
20+
int spu_create(const char *pathname, int flags, mode_t mode);
1421

15-
DESCRIPTION
22+
Description
23+
===========
1624
The spu_create system call is used on PowerPC machines that implement
1725
the Cell Broadband Engine Architecture in order to access Synergistic
1826
Processor Units (SPUs). It creates a new logical context for an SPU in
@@ -43,13 +51,15 @@ DESCRIPTION
4351
possible mode values.
4452

4553

46-
RETURN VALUE
54+
Return Value
55+
============
4756
spu_create returns a new file descriptor. It may return -1 to indicate
4857
an error condition and set errno to one of the error codes listed
4958
below.
5059

5160

52-
ERRORS
61+
Errors
62+
======
5363
EACCES
5464
The current user does not have write access on the spufs mount
5565
point.
@@ -87,33 +97,35 @@ ERRORS
8797

8898

8999

90-
NOTES
100+
Notes
101+
=====
91102
spu_create is meant to be used from libraries that implement a more
92103
abstract interface to SPUs, not to be used from regular applications.
93104
See http://www.bsc.es/projects/deepcomputing/linuxoncell/ for the rec-
94105
ommended libraries.
95106

96107

97-
FILES
108+
Files
109+
=====
98110
pathname must point to a location beneath the mount point of spufs. By
99111
convention, it gets mounted in /spu.
100112

101113

102-
CONFORMING TO
114+
Conforming to
115+
=============
103116
This call is Linux specific and only implemented by the ppc64 architec-
104117
ture. Programs using this system call are not portable.
105118

106119

107-
BUGS
120+
Bugs
121+
====
108122
The code does not yet fully implement all features lined out here.
109123

110124

111-
AUTHOR
125+
Author
126+
======
112127
Arnd Bergmann <arndb@de.ibm.com>
113128

114-
SEE ALSO
129+
See Also
130+
========
115131
capabilities(7), close(2), spu_run(2), spufs(7)
116-
117-
118-
119-
Linux 2005-09-28 SPU_CREATE(2)

0 commit comments

Comments
 (0)