From patchwork Sun Apr 1 06:38:58 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Rapoport X-Patchwork-Id: 10319079 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id EB86B60116 for ; Sun, 1 Apr 2018 06:39:18 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id D63FB29119 for ; Sun, 1 Apr 2018 06:39:18 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id C90132918B; Sun, 1 Apr 2018 06:39:18 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-6.9 required=2.0 tests=BAYES_00,RCVD_IN_DNSWL_HI autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id B684D29119 for ; Sun, 1 Apr 2018 06:39:16 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751283AbeDAGjO (ORCPT ); Sun, 1 Apr 2018 02:39:14 -0400 Received: from mx0a-001b2d01.pphosted.com ([148.163.156.1]:40148 "EHLO mx0a-001b2d01.pphosted.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1750841AbeDAGjL (ORCPT ); Sun, 1 Apr 2018 02:39:11 -0400 Received: from pps.filterd (m0098396.ppops.net [127.0.0.1]) by mx0a-001b2d01.pphosted.com (8.16.0.22/8.16.0.22) with SMTP id w316dBxW019279 for ; Sun, 1 Apr 2018 02:39:11 -0400 Received: from e06smtp10.uk.ibm.com (e06smtp10.uk.ibm.com [195.75.94.106]) by mx0a-001b2d01.pphosted.com with ESMTP id 2h2tb180t3-1 (version=TLSv1.2 cipher=AES256-SHA256 bits=256 verify=NOT) for ; Sun, 01 Apr 2018 02:39:11 -0400 Received: from localhost by e06smtp10.uk.ibm.com with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted for from ; Sun, 1 Apr 2018 07:39:08 +0100 Received: from b06cxnps3075.portsmouth.uk.ibm.com (9.149.109.195) by e06smtp10.uk.ibm.com (192.168.101.140) with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted; Sun, 1 Apr 2018 07:39:01 +0100 Received: from d06av21.portsmouth.uk.ibm.com (d06av21.portsmouth.uk.ibm.com [9.149.105.232]) by b06cxnps3075.portsmouth.uk.ibm.com (8.14.9/8.14.9/NCO v10.0) with ESMTP id w316d17n11075948; Sun, 1 Apr 2018 06:39:01 GMT Received: from d06av21.portsmouth.uk.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id 28AEA52041; Sun, 1 Apr 2018 06:30:13 +0100 (BST) Received: from rapoport-lnx (unknown [9.148.8.182]) by d06av21.portsmouth.uk.ibm.com (Postfix) with ESMTPS id AB04E5203F; Sun, 1 Apr 2018 06:30:11 +0100 (BST) Date: Sun, 1 Apr 2018 09:38:58 +0300 From: Mike Rapoport To: Jonathan Corbet , Andrew Morton Cc: Andrey Ryabinin , Richard Henderson , Ivan Kokshaysky , Matt Turner , Tony Luck , Fenghua Yu , Ralf Baechle , James Hogan , Michael Ellerman , Alexander Viro , linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org, kasan-dev@googlegroups.com, linux-alpha@vger.kernel.org, linux-ia64@vger.kernel.org, linux-mips@linux-mips.org, linuxppc-dev@lists.ozlabs.org, linux-fsdevel@vger.kernel.org, linux-mm@kvack.org Subject: Re: [PATCH 00/32] docs/vm: convert to ReST format References: <1521660168-14372-1-git-send-email-rppt@linux.vnet.ibm.com> <20180329154607.3d8bda75@lwn.net> MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: <20180329154607.3d8bda75@lwn.net> User-Agent: Mutt/1.5.24 (2015-08-30) X-TM-AS-GCONF: 00 x-cbid: 18040106-0040-0000-0000-0000042914C9 X-IBM-AV-DETECTION: SAVI=unused REMOTE=unused XFE=unused x-cbparentid: 18040106-0041-0000-0000-0000262C3B5D Message-Id: <20180401063857.GA3357@rapoport-lnx> X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10432:, , definitions=2018-04-01_02:, , signatures=0 X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 priorityscore=1501 malwarescore=0 suspectscore=0 phishscore=0 bulkscore=0 spamscore=0 clxscore=1011 lowpriorityscore=0 impostorscore=0 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1709140000 definitions=main-1804010070 Sender: linux-fsdevel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-fsdevel@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP (added akpm) On Thu, Mar 29, 2018 at 03:46:07PM -0600, Jonathan Corbet wrote: > On Wed, 21 Mar 2018 21:22:16 +0200 > Mike Rapoport wrote: > > > These patches convert files in Documentation/vm to ReST format, add an > > initial index and link it to the top level documentation. > > > > There are no contents changes in the documentation, except few spelling > > fixes. The relatively large diffstat stems from the indentation and > > paragraph wrapping changes. > > > > I've tried to keep the formatting as consistent as possible, but I could > > miss some places that needed markup and add some markup where it was not > > necessary. > > So I've been pondering on these for a bit. It looks like a reasonable and > straightforward RST conversion, no real complaints there. But I do have a > couple of concerns... > > One is that, as we move documentation into RST, I'm really trying to > organize it a bit so that it is better tuned to the various audiences we > have. For example, ksm.txt is going to be of interest to sysadmin types, > who might want to tune it. mmu_notifier.txt is of interest to ... > somebody, but probably nobody who is thinking in user space. And so on. > > So I would really like to see this material split up and put into the > appropriate places in the RST hierarchy - admin-guide for administrative > stuff, core-api for kernel development topics, etc. That, of course, > could be done separately from the RST conversion, but I suspect I know > what will (or will not) happen if we agree to defer that for now :) Well, I was actually planning on doing that ;-) My thinking was to start with mechanical RST conversion and then to start working on the contents and ordering of the documentation. Some of the existing files, e.g. ksm.txt, can be moved as is into the appropriate places, others, like transhuge.txt should be at least split into admin/user and developer guides. Another problem with many of the existing mm docs is that they are rather developer notes and it wouldn't be really straight forward to assign them to a particular topic. I believe that keeping the mm docs together will give better visibility of what (little) mm documentation we have and will make the updates easier. The documents that fit well into a certain topic could be linked there. For instance: ------------------------- ------------------------- > The other is the inevitable merge conflicts that changing that many doc > files will create. Sending the patches through Andrew could minimize > that, I guess, or at least make it his problem. Alternatively, we could > try to do it as an end-of-merge-window sort of thing. I can try to manage > that, but an ack or two from the mm crowd would be nice to have. I can rebase on top of Andrew's tree if that would help to minimize the merge conflicts. > Thanks, > > jon > diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst index 5bb9161..8f6c6e6 100644 --- a/Documentation/admin-guide/index.rst +++ b/Documentation/admin-guide/index.rst @@ -63,6 +63,7 @@ configure specific aspects of kernel behavior to your liking. pm/index thunderbolt LSM/index + vm/index .. only:: subproject and html diff --git a/Documentation/admin-guide/vm/index.rst b/Documentation/admin-guide/vm/index.rst new file mode 100644 index 0000000..d86f1c8 --- /dev/null +++ b/Documentation/admin-guide/vm/index.rst @@ -0,0 +1,5 @@ +============================================== +Knobs and Buttons for Memory Management Tuning +============================================== + +* :ref:`ksm `