From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-0.8 required=3.0 tests=HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS autolearn=no autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 3B0BDC433E0 for ; Thu, 21 May 2020 04:53:06 +0000 (UTC) Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by mail.kernel.org (Postfix) with ESMTP id AE6EF2070A for ; Thu, 21 May 2020 04:53:05 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org AE6EF2070A Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=intel.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=owner-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix) id 5D1EF80017; Thu, 21 May 2020 00:53:05 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 5821A80007; Thu, 21 May 2020 00:53:05 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 495F180017; Thu, 21 May 2020 00:53:05 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from forelay.hostedemail.com (smtprelay0167.hostedemail.com [216.40.44.167]) by kanga.kvack.org (Postfix) with ESMTP id 33BFC80007 for ; Thu, 21 May 2020 00:53:05 -0400 (EDT) Received: from smtpin16.hostedemail.com (10.5.19.251.rfc1918.com [10.5.19.251]) by forelay01.hostedemail.com (Postfix) with ESMTP id E0B13180AD820 for ; Thu, 21 May 2020 04:53:04 +0000 (UTC) X-FDA: 76839506688.16.rail70_721a576558156 X-HE-Tag: rail70_721a576558156 X-Filterd-Recvd-Size: 2591 Received: from mga07.intel.com (mga07.intel.com [134.134.136.100]) by imf07.hostedemail.com (Postfix) with ESMTP for ; Thu, 21 May 2020 04:53:03 +0000 (UTC) IronPort-SDR: Gcbo9WX0lhUoPiQEEAJeLCUbaZ/RL3nu6nZcnVV1aH8auvu/P5sumrfmYHQz0aJdk3EcvnPlE7 hm9KhaoKYUXA== X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga005.fm.intel.com ([10.253.24.32]) by orsmga105.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 20 May 2020 21:53:02 -0700 IronPort-SDR: njRag4Y/4wKQPuUcFUWV+iSrXgU2WfhAWZArhMajIaiYbJG7dUbE9lNDKxOFc3caJqjD3N6W4l 6HiDdLdimJaA== X-IronPort-AV: E=Sophos;i="5.73,416,1583222400"; d="scan'208";a="466640231" Received: from vverma-mobl1.amr.corp.intel.com (HELO intel.com) ([10.252.135.131]) by fmsmga005-auth.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 20 May 2020 21:53:02 -0700 Date: Wed, 20 May 2020 21:53:00 -0700 From: Ben Widawsky To: Matthew Wilcox Cc: linux-mm@kvack.org, Dave Hansen , Andrew Morton Subject: Re: [PATCH] mm: add comments on pglist_data zones Message-ID: <20200521045300.vh2ukn63rr423q4n@intel.com> Mail-Followup-To: Matthew Wilcox , linux-mm@kvack.org, Dave Hansen , Andrew Morton References: <20200520205443.2757414-1-ben.widawsky@intel.com> <20200520232235.GD16070@bombadil.infradead.org> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20200520232235.GD16070@bombadil.infradead.org> X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: On 20-05-20 16:22:35, Matthew Wilcox wrote: > On Wed, May 20, 2020 at 01:54:43PM -0700, Ben Widawsky wrote: > > While making other modifications it was easy to confuse the two struct > > members node_zones and node_zonelists. For those already familiar with > > the code, this might seem to be a silly patch, but it's quite helpful to > > disambiguate the similar-sounding fields > > > > While here, add a small comment on why nr_zones isn't simply MAX_NR_ZONES > > It seems like a real shame to write all this excellent documentation > and not format it as kernel-doc. I admit, I didn't look at all the kernel-doc files. Is there precedent there for documenting struct members like this? I'd be more than happy to try to document everything I've dug up in coming up to speed here. I've used the docs from Mel quite a bit and would very much like to pay it forward, as it were.