From patchwork Sun Apr 2 21:24:06 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jonathan Corbet X-Patchwork-Id: 96587 Delivered-To: patch@linaro.org Received: by 10.140.89.233 with SMTP id v96csp1622020qgd; Sun, 2 Apr 2017 14:24:43 -0700 (PDT) X-Received: by 10.98.196.12 with SMTP id y12mr13571851pff.49.1491168283547; Sun, 02 Apr 2017 14:24:43 -0700 (PDT) Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id a5si11997576pgi.277.2017.04.02.14.24.43; Sun, 02 Apr 2017 14:24:43 -0700 (PDT) Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67; Authentication-Results: mx.google.com; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751468AbdDBVYg (ORCPT + 25 others); Sun, 2 Apr 2017 17:24:36 -0400 Received: from ms.lwn.net ([45.79.88.28]:50208 "EHLO ms.lwn.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751225AbdDBVYc (ORCPT ); Sun, 2 Apr 2017 17:24:32 -0400 Received: from tpad.lwn.net (localhost [127.0.0.1]) by ms.lwn.net (Postfix) with ESMTPA id 3ECE02E2; Sun, 2 Apr 2017 21:24:31 +0000 (UTC) From: Jonathan Corbet To: linux-doc@vger.kernel.org Cc: linux-kernel@vger.kernel.org, Jonathan Corbet Subject: [PATCH 1/2] docs: Create a user-space API guide Date: Sun, 2 Apr 2017 15:24:06 -0600 Message-Id: <20170402212407.12021-2-corbet@lwn.net> X-Mailer: git-send-email 2.9.3 In-Reply-To: <20170402212407.12021-1-corbet@lwn.net> References: <20170402212407.12021-1-corbet@lwn.net> Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org This is meant to be the place for documentation relevant to application developers. It's empty for the moment, but at least we have a place now! Signed-off-by: Jonathan Corbet --- Documentation/index.rst | 12 ++++++++++++ Documentation/userspace-api/conf.py | 10 ++++++++++ Documentation/userspace-api/index.rst | 24 ++++++++++++++++++++++++ 3 files changed, 46 insertions(+) create mode 100644 Documentation/userspace-api/conf.py create mode 100644 Documentation/userspace-api/index.rst -- 2.9.3 diff --git a/Documentation/index.rst b/Documentation/index.rst index f6e641a54bbc..12550cc1e2a3 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -24,6 +24,18 @@ trying to get it to work optimally on a given system. admin-guide/index +Application-developer documentation +----------------------------------- + +The user-space API manual gathers together documents describing aspects of +the kernel interface as seen by application developers. + +.. toctree:: + :maxdepth: 2 + + userspace-api/index + + Introduction to kernel development ---------------------------------- diff --git a/Documentation/userspace-api/conf.py b/Documentation/userspace-api/conf.py new file mode 100644 index 000000000000..2eaf59f844e5 --- /dev/null +++ b/Documentation/userspace-api/conf.py @@ -0,0 +1,10 @@ +# -*- coding: utf-8; mode: python -*- + +project = "The Linux kernel user-space API guide" + +tags.add("subproject") + +latex_documents = [ + ('index', 'userspace-api.tex', project, + 'The kernel development community', 'manual'), +] diff --git a/Documentation/userspace-api/index.rst b/Documentation/userspace-api/index.rst new file mode 100644 index 000000000000..6d98ea6c0d2d --- /dev/null +++ b/Documentation/userspace-api/index.rst @@ -0,0 +1,24 @@ +===================================== +The Linux kernel user-space API guide +===================================== + +.. _man-pages: https://www.kernel.org/doc/man-pages/ + +While much of the kernel's user-space API is documented elsewhere +(particularly in the man-pages_ project), some user-space information can +also be found in the kernel tree itself. This manual is intended to be the +place where this information is gathered. + +.. class:: toc-title + + Table of contents + +.. toctree:: + :maxdepth: 2 + +.. only:: subproject and html + + Indices + ======= + + * :ref:`genindex`