linux-mm.kvack.org archive mirror
 help / color / mirror / Atom feed
From: Michal Hocko <mhocko@kernel.org>
To: Mike Rapoport <rppt@linux.vnet.ibm.com>
Cc: lsf-pc@lists.linux-foundation.org, linux-mm@kvack.org
Subject: Re: [LSF/MM TOPIC] mm documentation
Date: Tue, 30 Jan 2018 12:50:55 +0100	[thread overview]
Message-ID: <20180130115055.GZ21609@dhcp22.suse.cz> (raw)
In-Reply-To: <20180130105450.GC7201@rapoport-lnx>

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: <a href=mailto:"dont@kvack.org"> email@kvack.org </a>

  reply	other threads:[~2018-01-30 11:50 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <20180130105237.GB7201@rapoport-lnx>
2018-01-30 10:54 ` [LSF/MM TOPIC] mm documentation Mike Rapoport
2018-01-30 11:50   ` Michal Hocko [this message]
2018-01-30 12:54     ` Mike Rapoport
2018-01-30 13:41       ` Michal Hocko
2018-01-30 14:28         ` Mike Rapoport
2018-01-30 17:32           ` Randy Dunlap
2018-01-31 10:56             ` Mike Rapoport
2018-01-30 17:35           ` James Bottomley
2018-01-31  2:38           ` Matthew Wilcox
2018-01-31  9:00             ` Michal Hocko
2018-01-31 14:59               ` Mike Rapoport
2019-01-28  7:04 [LSF/MM TOPIC]: " Mike Rapoport
2019-02-22 13:59 ` Jonathan Cameron
  -- strict thread matches above, loose matches on Subject: below --
2021-05-20  8:56 [LSF/MM TOPIC] " Mike Rapoport
2021-05-20 14:19 ` Matthew Wilcox
2021-05-21  8:36   ` Mike Rapoport
2021-05-25  7:04     ` Souptick Joarder

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20180130115055.GZ21609@dhcp22.suse.cz \
    --to=mhocko@kernel.org \
    --cc=linux-mm@kvack.org \
    --cc=lsf-pc@lists.linux-foundation.org \
    --cc=rppt@linux.vnet.ibm.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).