From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-qt0-f197.google.com (mail-qt0-f197.google.com [209.85.216.197]) by kanga.kvack.org (Postfix) with ESMTP id D13706B0009 for ; Wed, 31 Jan 2018 05:56:17 -0500 (EST) Received: by mail-qt0-f197.google.com with SMTP id c12so13798448qtj.3 for ; Wed, 31 Jan 2018 02:56:17 -0800 (PST) Received: from mx0a-001b2d01.pphosted.com (mx0a-001b2d01.pphosted.com. [148.163.156.1]) by mx.google.com with ESMTPS id 1si4188606qkk.220.2018.01.31.02.56.16 for (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 31 Jan 2018 02:56:17 -0800 (PST) Received: from pps.filterd (m0098393.ppops.net [127.0.0.1]) by mx0a-001b2d01.pphosted.com (8.16.0.22/8.16.0.22) with SMTP id w0VAsO3r107559 for ; Wed, 31 Jan 2018 05:56:16 -0500 Received: from e06smtp12.uk.ibm.com (e06smtp12.uk.ibm.com [195.75.94.108]) by mx0a-001b2d01.pphosted.com with ESMTP id 2fuccm085n-1 (version=TLSv1.2 cipher=AES256-SHA bits=256 verify=NOT) for ; Wed, 31 Jan 2018 05:56:12 -0500 Received: from localhost by e06smtp12.uk.ibm.com with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted for from ; Wed, 31 Jan 2018 10:56:09 -0000 Date: Wed, 31 Jan 2018 12:56:04 +0200 From: Mike Rapoport Subject: Re: [LSF/MM TOPIC] mm documentation References: <20180130105237.GB7201@rapoport-lnx> <20180130105450.GC7201@rapoport-lnx> <20180130115055.GZ21609@dhcp22.suse.cz> <20180130125443.GA21333@rapoport-lnx> <20180130134141.GD21609@dhcp22.suse.cz> <20180130142849.GD21333@rapoport-lnx> <8e8353c2-f985-2da0-d880-25992097cbf6@infradead.org> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <8e8353c2-f985-2da0-d880-25992097cbf6@infradead.org> Message-Id: <20180131105604.GA20535@rapoport-lnx> Sender: owner-linux-mm@kvack.org List-ID: To: Randy Dunlap Cc: Michal Hocko , lsf-pc@lists.linux-foundation.org, linux-mm@kvack.org On Tue, Jan 30, 2018 at 09:32:04AM -0800, Randy Dunlap wrote: > On 01/30/2018 06:28 AM, Mike Rapoport wrote: > > On Tue, Jan 30, 2018 at 02:41:41PM +0100, Michal Hocko wrote: > >> On Tue 30-01-18 14:54:44, Mike Rapoport wrote: > >>> On Tue, Jan 30, 2018 at 12:50:55PM +0100, Michal Hocko wrote: > >>>> On Tue 30-01-18 12:54:50, Mike Rapoport wrote: > >>>>> (forgot to CC linux-mm) > >>>>> > >>>>> On Tue, Jan 30, 2018 at 12:52:37PM +0200, Mike Rapoport wrote: > >>>>>> Hello, > >>>>>> > >>>>>> The mm kernel-doc documentation is not in a great shape. > >>>>>> > >>>>>> Some of the existing kernel-doc annotations were not reformatted during > >>>>>> transition from dockbook to sphix. Sometimes the parameter descriptions > >>>>>> do not match actual code. But aside these rather mechanical issues there > >>>>>> are several points it'd like to discuss: > >>>>>> > >>>>>> * Currently, only 14 files are linked to kernel-api.rst under "Memory > >>>>>> Management in Linux" section. We have more than hundred files only in mm. > >>>>>> Even the existing documentation is not generated when running "make > >>>>>> htmldocs" > >>>> > >>>> Is this documentation anywhere close to be actually useful? > >>> > >>> Some parts are documented better, some worse. For instance, bootmem and > >>> z3fold are covered not bad at all, but, say, huge_memory has no structured > >>> comments at all. Roughly half of the files in mm/ have some documentation, > >>> but I didn't yet read that all to say how much of it is actually useful. > >> > >> It is good to hear that at least something has a documentation coverage. > >> I was asking mostly because I _think_ that the API documentation is far > >> from the top priority. > > > > API documentations is important for kernel developers who are not deeply > > involved with mm. When one develops a device driver, knowing how to > > allocate and free memory is essential. And, while *malloc are included in > > kernel-api.rst, CMA and HMM documentation is not visible. > > > >> We are seriously lacking any highlevel one which describes the design and > >> subsytems interaction. > > > > I should have describe it better, but by "creating a new structure for mm > > documentation" I've also meant adding high level description. > > > >> Well, we have missed that train years ago. It will be really hard to catch up. > > > > At least we can try. > > Hi, > I would move it all to a new mm.rst file. That would be easier to maintain > and also allow parallel building. Agree. Could also be Documentation/vm/index.rst. > -- > ~Randy > -- Sincerely yours, Mike. -- To unsubscribe, send a message with 'unsubscribe linux-mm' in the body to majordomo@kvack.org. For more info on Linux MM, see: http://www.linux-mm.org/ . Don't email: email@kvack.org