From patchwork Tue May 16 10:38:49 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mauro Carvalho Chehab X-Patchwork-Id: 9728829 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id 940E760386 for ; Tue, 16 May 2017 10:39:21 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 844C726530 for ; Tue, 16 May 2017 10:39:21 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 77CB828A15; Tue, 16 May 2017 10:39:21 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-6.9 required=2.0 tests=BAYES_00,RCVD_IN_DNSWL_HI autolearn=unavailable version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id F13F626530 for ; Tue, 16 May 2017 10:39:20 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752796AbdEPKjF (ORCPT ); Tue, 16 May 2017 06:39:05 -0400 Received: from ec2-52-27-115-49.us-west-2.compute.amazonaws.com ([52.27.115.49]:59010 "EHLO osg.samsung.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1752543AbdEPKjB (ORCPT ); Tue, 16 May 2017 06:39:01 -0400 Received: from localhost (localhost [127.0.0.1]) by osg.samsung.com (Postfix) with ESMTP id A3FA5A05F1; Tue, 16 May 2017 10:39:27 +0000 (UTC) X-Virus-Scanned: amavisd-new at osg.samsung.com Received: from osg.samsung.com ([127.0.0.1]) by localhost (s-opensource.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id tl2_1I8tfpsc; Tue, 16 May 2017 10:39:25 +0000 (UTC) Received: from vento.lan (unknown [189.61.98.202]) by osg.samsung.com (Postfix) with ESMTPSA id 71EB3A05EE; Tue, 16 May 2017 10:39:20 +0000 (UTC) Date: Tue, 16 May 2017 07:38:49 -0300 From: Mauro Carvalho Chehab To: Boris Brezillon Cc: Linux Doc Mailing List , Rich Felker , linux-sh@vger.kernel.org, Takashi Iwai , Sebastian Andrzej Siewior , "Herton R. Krzesinski" , linux-mtd@lists.infradead.org, Cyrille Pitchen , Markus Heiser , Yoshinori Sato , Jonathan Corbet , Richard Weinberger , Marek Vasut , sayli karnik , Jani Nikula , Mauro Carvalho Chehab , Greg Kroah-Hartman , linux-kernel@vger.kernel.org, linux-security-module@vger.kernel.org, Silvio Fricke , Brian Norris , David Woodhouse Subject: Re: [PATCH 0/5] Convert more books to ReST Message-ID: <20170516073849.787750d4@vento.lan> In-Reply-To: <20170515140912.100c9cac@bbrezillon> References: <20170515140912.100c9cac@bbrezillon> Organization: Samsung X-Mailer: Claws Mail 3.14.1 (GTK+ 2.24.31; x86_64-redhat-linux-gnu) MIME-Version: 1.0 Sender: linux-sh-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-sh@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP Em Mon, 15 May 2017 14:09:12 +0200 Boris Brezillon escreveu: > On Sat, 13 May 2017 08:10:53 -0300 > Mauro Carvalho Chehab wrote: > > > This patch series convert the following books to ReST: > > - librs > > - mtdnand > > - sh > > > > And it is based on my previous series of conversion patches. > > > > After this series, there will be just one DocBook pending conversion: > > - lsm (Linux Security Modules) > > > > This book is very outdated: no changes since the Kernel moved > > to git, in 2005 (except for a minor editorial fix in 2008). > > > > I took a look on the described API: it doesn't seem to be describing > > the current security implementation. > > > > The best here is if someone that works with LSM to convert it to > > ReST with: > > $ Documentation/sphinx/tmplcvt Documentation/DocBook/lsm.tmpl lsm.rst > > > > And fix the document to produce something that reflects the current > > implementation. If nobody is interested, then maybe we could just > > drop it. > > > > - > > > > This patch series is based on my past 00/36 patch series, applied on > > the top of docs tree (next branch). > > > > The full patch series is on this tree is at: > > > > https://git.linuxtv.org//mchehab/experimental.git/log/?h=docbook > > > > And the HTML output at: > > > > http://www.infradead.org/~mchehab/kernel_docs/ > > https://mchehab.fedorapeople.org/kernel_docs/ > > > > Mauro Carvalho Chehab (5): > > docs-rst: convert librs book to ReST > > docs-rst: convert mtdnand book to ReST > > mtdnand.rst: Fix some typos and group the "::" with previous line > > MTD maintainers did not receive the above patch. Can you Cc us the > whole series next time. Sorry. I'll add you on the whole series. It will be a big one, though, as it will contain the other docbook conversions on it (~50+ patches). > BTW, I had a look at your branch and it seems the typo you're fixing is > actually not a type. Flags are *OR-ed* (with the | operator) to form a > valid combination of flags. Ah! Ok, I updated the patch (see enclosed). Would that be OK for you? > > mtd: adjust kernel-docs to avoid Sphinx/kerneldoc warnings > > Not sure how you plan to merge these changes, but if it goes through > a single tree I'll probably need an immutable topic branch, because I > plan to change a few things in nand_base.c nand.h for the next release. At least the patches that touch at Documentation/* should go, IMHO, via a single tree: git://git.lwn.net/linux.git docs-next As Jon mentioned, he doesn't rebase it, so you should be able to get an immutable branch from it. Thanks, Mauro --- [PATCH] mtdnand.rst: group the "::" with previous line Group the :: with the previous paragraph, in order to make it visually better when reading as a text file. While here, replace: ored (with means "Covered or adorned with ore or metal") by: OR-ed To reflect its true meaning. Signed-off-by: Mauro Carvalho Chehab -- To unsubscribe from this list: send the line "unsubscribe linux-sh" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html diff --git a/Documentation/driver-api/mtdnand.rst b/Documentation/driver-api/mtdnand.rst index 8723175f955e..7c19795ebb4a 100644 --- a/Documentation/driver-api/mtdnand.rst +++ b/Documentation/driver-api/mtdnand.rst @@ -843,10 +843,8 @@ Chip option constants Constants for chip id table ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -These constants are defined in nand.h. They are ored together to -describe the chip functionality. - -:: +These constants are defined in nand.h. They are OR-ed together to +describe the chip functionality:: /* Buswitdh is 16 bit */ #define NAND_BUSWIDTH_16 0x00000002 @@ -867,10 +865,8 @@ describe the chip functionality. Constants for runtime options ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -These constants are defined in nand.h. They are ored together to -describe the functionality. - -:: +These constants are defined in nand.h. They are OR-ed together to +describe the functionality:: /* The hw ecc generator provides a syndrome instead a ecc value on read * This can only work if we have the ecc bytes directly behind the @@ -881,9 +877,7 @@ describe the functionality. ECC selection constants ----------------------- -Use these constants to select the ECC algorithm. - -:: +Use these constants to select the ECC algorithm:: /* No ECC. Usage is not recommended ! */ #define NAND_ECC_NONE 0 @@ -903,9 +897,7 @@ Hardware control related constants ---------------------------------- These constants describe the requested hardware access function when the -boardspecific hardware control function is called - -:: +boardspecific hardware control function is called:: /* Select the chip by setting nCE to low */ #define NAND_CTL_SETNCE 1 @@ -929,9 +921,7 @@ Bad block table related constants --------------------------------- These constants describe the options used for bad block table -descriptors. - -:: +descriptors:: /* Options for the bad block table descriptors */