From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-wm0-f69.google.com (mail-wm0-f69.google.com [74.125.82.69]) by kanga.kvack.org (Postfix) with ESMTP id 3DF226B0005 for ; Tue, 30 Jan 2018 06:50:58 -0500 (EST) Received: by mail-wm0-f69.google.com with SMTP id e195so80182wmd.9 for ; Tue, 30 Jan 2018 03:50:58 -0800 (PST) Received: from mx2.suse.de (mx2.suse.de. [195.135.220.15]) by mx.google.com with ESMTPS id r60si5343166wrb.135.2018.01.30.03.50.56 for (version=TLS1 cipher=AES128-SHA bits=128/128); Tue, 30 Jan 2018 03:50:57 -0800 (PST) Date: Tue, 30 Jan 2018 12:50:55 +0100 From: Michal Hocko Subject: Re: [LSF/MM TOPIC] mm documentation Message-ID: <20180130115055.GZ21609@dhcp22.suse.cz> References: <20180130105237.GB7201@rapoport-lnx> <20180130105450.GC7201@rapoport-lnx> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20180130105450.GC7201@rapoport-lnx> Sender: owner-linux-mm@kvack.org List-ID: To: Mike Rapoport Cc: lsf-pc@lists.linux-foundation.org, linux-mm@kvack.org 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? -- Michal Hocko SUSE Labs -- 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