From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1753469AbbHNXlX (ORCPT ); Fri, 14 Aug 2015 19:41:23 -0400 Received: from casper.infradead.org ([85.118.1.10]:40544 "EHLO casper.infradead.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751915AbbHNXlV (ORCPT ); Fri, 14 Aug 2015 19:41:21 -0400 Subject: Re: [PATCH] doc: Add more workqueue functions to the documentation To: Tim Bird , Jonathan Corbet References: <1439244976-1406-1-git-send-email-tim.bird@sonymobile.com> <20150813174559.3c2e4c0f@xps.lwn.net> <55CE6FDC.3010700@sonymobile.com> Cc: "linux-doc@vger.kernel.org" , "linux-kernel@vger.kernel.org" , "tbird20d@gmail.com" From: Randy Dunlap Message-ID: <55CE7C9B.5060405@infradead.org> Date: Fri, 14 Aug 2015 16:41:15 -0700 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:38.0) Gecko/20100101 Thunderbird/38.1.0 MIME-Version: 1.0 In-Reply-To: <55CE6FDC.3010700@sonymobile.com> Content-Type: text/plain; charset=windows-1252 Content-Transfer-Encoding: 7bit Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On 08/14/15 15:46, Tim Bird wrote: > > > On 08/13/2015 04:45 PM, Jonathan Corbet wrote: >> On Mon, 10 Aug 2015 15:16:16 -0700 >> Tim Bird wrote: >> >>> There are some workqueue functions declared in workqueue.h, so include >>> that in the workqueue section of the DocBook docs. >> >> Applied to the docs tree, thanks. >> >> It sure would be nice if changes like this were accompanied by a patch >> fixing the additional warnings it drags in ... :) In this case I've put >> something together for workqueue.h and will send it off shortly. > > My apologies. > > When I do 'make mandocs', the only messages from workqueue.h that I noticed > were like the following: > > Warn: meta author : no refentry/info/author queue_delayed_work > Note: meta author : see http://docbook.sf.net/el/author queue_delayed_work > Warn: meta author : no author data, so inserted a fixme queue_delayed_work > Note: Writing queue_delayed_work.9 > > But there are over 4000 of these messages when I make mandocs, so I assumed > ignoring them was OK. > > Are these what you saw or was it something else? These are the new warnings that I saw: Warning(..//include/linux/workqueue.h:271): No description found for parameter 'w' Warning(..//include/linux/workqueue.h:271): Excess function parameter 'work' description in 'delayed_work_pending' Warning(..//include/linux/workqueue.h:390): Excess function parameter 'args' description in 'alloc_workqueue' Warning(..//include/linux/workqueue.h:411): Excess function parameter 'args' description in 'alloc_ordered_workqueue' and Jon has already posted a patch for these. > Do you know how to get rid of these messages? > > It's a bit of a pain rebuilding. When I make a change, it rebuilds everything. > My build of mandocs takes 27 minutes and generates over 9000 messages. > Somewhere in the middle of that must have been some other messages related to > workqueue.h that I missed. > > However, I'll try to fix build errors in the future. -- ~Randy