Received: by 2002:ac0:a5b6:0:0:0:0:0 with SMTP id m51-v6csp1482853imm; Sun, 27 May 2018 08:02:59 -0700 (PDT) X-Google-Smtp-Source: AB8JxZqGwLEZdjUuNcGk5SS3kHeywLli6PYVRh9wcSKPoiJ6WV8A/rjmGo2QJadb23HkdpnUSrYt X-Received: by 2002:a65:5105:: with SMTP id f5-v6mr7933887pgq.232.1527433379232; Sun, 27 May 2018 08:02:59 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1527433379; cv=none; d=google.com; s=arc-20160816; b=exz+78kziJ7EFSYCKmSoHZt8+KrES66x0fhWtyWBeL35FIWDaC4SrHQciKzJfmHh3o /RStf5YKHWzgJomGdEintoEmE9VyAWOG+zQkrdT/NjiU0CNJ5d2UMZQpn/zxIqO/aaqZ 9vB6W1jEmHuDoZuwePDk34lDEX5tbooXztpNzwHUQDd1iDolcgXNMvnrQ6Nqd/zeJFjS xXmz1l6EZN3jgVARaRYC11Loa7hJ7hxfxH430TOhMVa7tcUhe2jJgts7phzUUVidKqBn JgHeck7eZCGkLd9cBN3otRbzKtRirJK+f2NUHYU/sEXQbqG4WGq9GQJXw3vmmSr207ts Sz3A== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:references:in-reply-to:message-id:date :subject:cc:to:from:dkim-signature:arc-authentication-results; bh=khvYd4Lig3LmTuzdIJClNeX6Yai1chI32XmesAil5ZY=; b=TZiR0EUhJNr9wxjy9oDXHGPwJpceFffuGggIiwx3FTxg/Ft8dh+fgDvcyJyQP/4Dr1 It1kYuGoGQS3AqiOn2LBhmUcKjvnbltqHu59HdnrdZMiaYExloh5lOxgLxQ39G3MnDR7 h54N5HKivJama1rV086Bdw51kXmWOHd5BHk6cbXxF0YfpZH6wSUT5dkz4etKNmuBfnJi WwZXnl4n2LeGC/a2UnfMUW013nciYHY4erqZ03dNpWiQFKmZWhc0VdF2kZpcxfjFQs+S Cfa4p6c74UAdxv1r3Pp8M1RbxK+/9zivkckQkoRBEeLGOmRExzlVsXw3/348YhzwMrP8 Fi7w== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@kolabnow.com header.s=dkim20160331 header.b=vws2IF0R; 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 Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id a3-v6si21765923pgq.652.2018.05.27.08.02.34; Sun, 27 May 2018 08:02:59 -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; dkim=pass header.i=@kolabnow.com header.s=dkim20160331 header.b=vws2IF0R; 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 S968540AbeE0PCS (ORCPT + 99 others); Sun, 27 May 2018 11:02:18 -0400 Received: from mx.kolabnow.com ([95.128.36.41]:44864 "EHLO mx.kolabnow.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S966919AbeE0PCN (ORCPT ); Sun, 27 May 2018 11:02:13 -0400 Received: from localhost (unknown [127.0.0.1]) by ext-mx-out002.mykolab.com (Postfix) with ESMTP id 428E0460; Sun, 27 May 2018 16:56:49 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=kolabnow.com; h= references:in-reply-to:message-id:date:date:subject:subject:from :from:received:received:received; s=dkim20160331; t=1527433008; x=1529247409; bh=khvYd4Lig3LmTuzdIJClNeX6Yai1chI32XmesAil5ZY=; b= vws2IF0RdfcZPTpgWOhXRlRvnyLqC55GGmezo4g90/1C0RxzAHc7ktAWgj34ZUv/ 2n/Q2JQm3f8FA601ZBX5+2DqrwV52aVH/h2XkZA3tKCqeeq/R0pF5LnPj/S9Ou0M b2i56L7snW3fC0YNAEePT/rgR0doTQw1ap1YzxvvPLJzyGYX8ydUkYV1pt79NUVu pJ7X/zAQ7FIFvMqyiA1xTYq0haPtWezE+UfYirF/t12ielvS+sDUi8khLQh8Z9yM tiTMdcFoBZVtJVQnPGeCdmPUjmhnZt9fKmE4Al2ZaKfwt4nWDeRdCrkuXtRlXftk ENvEGYbIWNItCDkXlpRU/S7BoQR6vqccg2IiAp6yftZB4JPK9JJSddgOXtrQk2YJ H2RHtATPmrZrcg5/NIoe9GINcZWIasRHp5gZm3Mf49cyR8DUPU77WJMlEVVs1zaQ bpiTXI0dGJaVc+UYB3lbZz4qrPF8gjOy2KrJL9CiZAJvqf2pZdfEF9PGIjIfTauh 7CNa4MCsVh1Sud072ApMfaWferjsgbdIUtneI5E8ydtMKvPJiIzipTl4DSDUXCWc ylQfx46LP8fX0Z0cqyHZuRNvylgojJr6i/rAqCDdsvIio+sO7ubpdGap7bWCMrZq 0WgllnItXC5268DBW6lcx0dHEAqKUSAV7RkXcKwOjYg= X-Virus-Scanned: amavisd-new at mykolab.com X-Spam-Flag: NO X-Spam-Score: -1 X-Spam-Level: X-Spam-Status: No, score=-1 tagged_above=-10 required=4.5 tests=[ALL_TRUSTED=-1] autolearn=disabled Received: from mx.kolabnow.com ([127.0.0.1]) by localhost (ext-mx-out002.mykolab.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id dMslPNTE3JbQ; Sun, 27 May 2018 16:56:48 +0200 (CEST) Received: from int-mx002.mykolab.com (unknown [10.9.13.2]) by ext-mx-out002.mykolab.com (Postfix) with ESMTPS id 1DC3F3BD; Sun, 27 May 2018 16:56:48 +0200 (CEST) Received: from ext-subm001.mykolab.com (unknown [10.9.6.1]) by int-mx002.mykolab.com (Postfix) with ESMTPS id C784925CA; Sun, 27 May 2018 16:56:47 +0200 (CEST) From: Federico Vaga To: Jonathan Corbet Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, Alessia Mantegazza , Federico Vaga Subject: [PATCH 1/5] doc: typos and minor fixes Date: Sun, 27 May 2018 16:55:56 +0200 Message-Id: <20180527145559.16411-2-federico.vaga@vaga.pv.it> In-Reply-To: <20180527145559.16411-1-federico.vaga@vaga.pv.it> References: <20180527145559.16411-1-federico.vaga@vaga.pv.it> Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Signed-off-by: Federico Vaga --- Documentation/doc-guide/kernel-doc.rst | 2 +- Documentation/doc-guide/parse-headers.rst | 4 ++-- Documentation/doc-guide/sphinx.rst | 4 ++-- Documentation/index.rst | 2 +- Documentation/sphinx/parse-headers.pl | 2 +- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/Documentation/doc-guide/kernel-doc.rst b/Documentation/doc-guide/kernel-doc.rst index 0268335414ce..d322367f70d7 100644 --- a/Documentation/doc-guide/kernel-doc.rst +++ b/Documentation/doc-guide/kernel-doc.rst @@ -262,7 +262,7 @@ comment block. The kernel-doc data structure comments describe each member of the structure, in order, with the ``@member:`` descriptions. The ``@member:`` descriptions must -begin on the very next line following the opening brief function description +begin on the very next line following the opening brief structure description line, with no intervening blank comment lines. The ``@member:`` descriptions may span multiple lines. The continuation lines may contain indentation. diff --git a/Documentation/doc-guide/parse-headers.rst b/Documentation/doc-guide/parse-headers.rst index 96a0423d5dba..cbfbd1748f8f 100644 --- a/Documentation/doc-guide/parse-headers.rst +++ b/Documentation/doc-guide/parse-headers.rst @@ -32,7 +32,7 @@ SYNOPSIS \ **parse_headers.pl**\ [] [] -Where can be: --debug, --help or --man. +Where can be: --debug, --usage or --help. OPTIONS @@ -133,7 +133,7 @@ For both statements, \ **type**\ can be either one of the following: \ **symbol**\ - The ignore or replace statement will apply to the name of enum statements + The ignore or replace statement will apply to the name of enum values at C_FILE. For replace statements, \ **new_value**\ will automatically use :c:type: diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/sphinx.rst index a2417633fdd8..8d789a117a4f 100644 --- a/Documentation/doc-guide/sphinx.rst +++ b/Documentation/doc-guide/sphinx.rst @@ -28,7 +28,7 @@ The ReST markups currently used by the Documentation/ files are meant to be built with ``Sphinx`` version 1.3 or upper. If you're desiring to build PDF outputs, it is recommended to use version 1.4.6 or upper. -There's a script that checks for the Spinx requirements. Please see +There's a script that checks for the Sphinx requirements. Please see :ref:`sphinx-pre-install` for further details. Most distributions are shipped with Sphinx, but its toolchain is fragile, @@ -266,7 +266,7 @@ some additional features: * row-span: with the role ``rspan`` a cell can be extended through additional rows -* auto span rightmost cell of a table row over the missing cells on the right +* auto-span: rightmost cell of a table row over the missing cells on the right side of that table-row. With Option ``:fill-cells:`` this behavior can changed from *auto span* to *auto fill*, which automatically inserts (empty) cells instead of spanning the last cell. diff --git a/Documentation/index.rst b/Documentation/index.rst index cb7f1ba5b3b1..331da87c82c8 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -33,7 +33,7 @@ the kernel interface as seen by application developers. .. toctree:: :maxdepth: 2 - userspace-api/index + userspace-api/index Introduction to kernel development diff --git a/Documentation/sphinx/parse-headers.pl b/Documentation/sphinx/parse-headers.pl index a958d8b5e99d..27117194d41f 100755 --- a/Documentation/sphinx/parse-headers.pl +++ b/Documentation/sphinx/parse-headers.pl @@ -344,7 +344,7 @@ enums and defines and create cross-references to a Sphinx book. B [] [] -Where can be: --debug, --help or --man. +Where can be: --debug, --help or --usage. =head1 OPTIONS -- 2.14.3