From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1755237AbcHYUJf (ORCPT ); Thu, 25 Aug 2016 16:09:35 -0400 Received: from tex.lwn.net ([70.33.254.29]:36348 "EHLO vena.lwn.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1754406AbcHYUJd (ORCPT ); Thu, 25 Aug 2016 16:09:33 -0400 Date: Thu, 25 Aug 2016 14:09:30 -0600 From: Jonathan Corbet To: Mauro Carvalho Chehab Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, Jani Nikula Subject: Re: [PATCH 2/3] docs: split up the driver book Message-ID: <20160825140930.342e6453@lwn.net> In-Reply-To: <20160823113016.2d131a02@vento.lan> References: <1471899463-5774-1-git-send-email-corbet@lwn.net> <1471899463-5774-3-git-send-email-corbet@lwn.net> <20160823113016.2d131a02@vento.lan> Organization: LWN.net X-Mailer: Claws Mail 3.13.2 (GTK+ 2.24.30; x86_64-redhat-linux-gnu) MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 8bit Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Tue, 23 Aug 2016 11:30:16 -0300 Mauro Carvalho Chehab wrote: > I noticed several issues on the converted document. Just commenting > a few of them, as they all follow a pattern: kernel-doc markups > needs review during the conversion to RST, because, unfortunately, > the conversion is not transparent, as we would want to. So getting to a couple of others here... > Also, you should notice that it added several references to > kthread_create(), with is actually a define: > > include/linux/kthread.h:#define kthread_create(threadfn, data, namefmt, arg...) \ > > It probably makes sense to add some markup for kernel-doc to parse it. I have a patch for that now, will send it shortly. > The description for: > > int KickStart(MPT_ADAPTER * ioc, int force, int sleepFlag) > > Looked weird on my eyes. The original kernel-nano tag is: I thought about fixing these up, but, in the end, the bulk of the funky stuff from the fusion driver is pulled in with :internal:. That, I think, makes little sense for a "driver API" book. So I'm really inclined to just remove those includes altogether; they can be added in the future if somebody puts together an internals book for that driver. Thanks, jon