From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-10.1 required=3.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY, SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 70CF7C81C41 for ; Mon, 27 Apr 2020 21:18:29 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 51E0E2075E for ; Mon, 27 Apr 2020 21:18:29 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1588022309; bh=xxrO2m1szhSXLhg7ZVFFMsns3ZK7iqjIdInVfLVLim0=; h=From:To:Cc:Subject:Date:In-Reply-To:References:List-ID:From; b=zIigdwKiq9rrRlh7n3H9w/laYsdM3DRKFduAkQvdd8mAjpFc5DX/E0iE3cwDL9qG3 M7we4vz2wuBCKbd+S6UzRlnGcqrTn/CB6IDoWiI5YJSKbOm80RNIQ2fkHN0yp1FWON 1ANMfoGa6dwZ4qAKIm29cRGP7wvR902ztmtSrIbM= Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726666AbgD0VSZ (ORCPT ); Mon, 27 Apr 2020 17:18:25 -0400 Received: from mail.kernel.org ([198.145.29.99]:34198 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726397AbgD0VR1 (ORCPT ); Mon, 27 Apr 2020 17:17:27 -0400 Received: from mail.kernel.org (ip5f5ad5c5.dynamic.kabel-deutschland.de [95.90.213.197]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id E70B122202; Mon, 27 Apr 2020 21:17:24 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1588022245; bh=xxrO2m1szhSXLhg7ZVFFMsns3ZK7iqjIdInVfLVLim0=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=Cg+Z31Hv2sZFBnbmCAipvwuQf400TSxzkowv7GUFAsJigZpWYjF7NrBOsGMvsm+Lz nKZ1sJiRJHtgk3VbXVK5rhC+zsG54ZLiC2WG9SFgEZ2LGiXdJ4thgPzuY8gwwp1NWa dBDNT44YjNi8tV5qZeqhuJVIma1Q5X5VHZSW2bm0= Received: from mchehab by mail.kernel.org with local (Exim 4.92.3) (envelope-from ) id 1jTB7z-000HlM-6R; Mon, 27 Apr 2020 23:17:23 +0200 From: Mauro Carvalho Chehab To: Linux Doc Mailing List Cc: Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, Jonathan Corbet Subject: [PATCH v3 22/29] docs: filesystems: convert spufs/spu_create.txt to ReST Date: Mon, 27 Apr 2020 23:17:14 +0200 Message-Id: <4d42e97d5560a79bd5dd443c592be04f9ae9a757.1588021877.git.mchehab+huawei@kernel.org> X-Mailer: git-send-email 2.25.4 In-Reply-To: References: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org 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 --- Documentation/filesystems/index.rst | 1 + Documentation/filesystems/spufs/index.rst | 11 ++++ .../spufs/{spu_create.txt => spu_create.rst} | 52 ++++++++++++------- 3 files changed, 44 insertions(+), 20 deletions(-) create mode 100644 Documentation/filesystems/spufs/index.rst rename Documentation/filesystems/spufs/{spu_create.txt => spu_create.rst} (90%) diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst index 30f1583015bd..36462b0a7836 100644 --- a/Documentation/filesystems/index.rst +++ b/Documentation/filesystems/index.rst @@ -106,6 +106,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 similarity index 90% rename from Documentation/filesystems/spufs/spu_create.txt rename to 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 - #include +Synopsis +======== - int spu_create(const char *pathname, int flags, mode_t mode); + :: -DESCRIPTION + #include + #include + + int spu_create(const char *pathname, int flags, mode_t mode); + +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 -SEE ALSO +See Also +======== capabilities(7), close(2), spu_run(2), spufs(7) - - - -Linux 2005-09-28 SPU_CREATE(2) -- 2.25.4