From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S934123AbcBQP50 (ORCPT ); Wed, 17 Feb 2016 10:57:26 -0500 Received: from mail-yk0-f172.google.com ([209.85.160.172]:36023 "EHLO mail-yk0-f172.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S933327AbcBQP5Y (ORCPT ); Wed, 17 Feb 2016 10:57:24 -0500 Date: Wed, 17 Feb 2016 10:57:21 -0500 From: Tejun Heo To: Mark Brown Cc: Paolo Valente , Jens Axboe , Fabio Checconi , Arianna Avanzini , linux-block@vger.kernel.org, linux-kernel@vger.kernel.org, ulf.hansson@linaro.org, linus.walleij@linaro.org Subject: Re: [PATCH RFC 09/22] block, cfq: replace CFQ with the BFQ-v0 I/O scheduler Message-ID: <20160217155721.GT3741@mtj.duckdns.org> References: <1454364778-25179-1-git-send-email-paolo.valente@linaro.org> <1454364778-25179-10-git-send-email-paolo.valente@linaro.org> <20160211222210.GC3741@mtj.duckdns.org> <20160212003502.GD1953@sirena.org.uk> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20160212003502.GD1953@sirena.org.uk> User-Agent: Mutt/1.5.24 (2015-08-30) Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Hello, Mark. On Fri, Feb 12, 2016 at 12:35:02AM +0000, Mark Brown wrote: > On Thu, Feb 11, 2016 at 05:22:10PM -0500, Tejun Heo wrote: > > > > +/** > > > + * struct bfq_data - per device data structure. > > > + * @queue: request queue for the managed device. > > > + * @sched_data: root @bfq_sched_data for the device. > > > + * @busy_queues: number of bfq_queues containing requests (including the > > > + * queue in service, even if it is idling). > > ... > > > I'm personally not a big fan of documenting struct fields this way. > > It's too easy to get them out of sync. > > If it's something that gets included in a generated document then people > will tell you pretty quickly if it gets out of sync these days, 0day > notices and there's people sending fixes quite frequently. Haven't generated docs turned out to be mostly pointless? I think it makes a lot more sense to write comments so that they're more accessible in-line. Thanks. -- tejun