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=-2.3 required=3.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS, USER_AGENT_SANE_1 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 AD1E2ECE59D for ; Wed, 16 Oct 2019 00:10:41 +0000 (UTC) Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by mail.kernel.org (Postfix) with ESMTP id 5F7A62084B for ; Wed, 16 Oct 2019 00:10:41 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="bgHjvrc0" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 5F7A62084B Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=gmail.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=owner-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix) id E52078E0005; Tue, 15 Oct 2019 20:10:40 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id DDCD48E0001; Tue, 15 Oct 2019 20:10:40 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id CA3F68E0005; Tue, 15 Oct 2019 20:10:40 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from forelay.hostedemail.com (smtprelay0214.hostedemail.com [216.40.44.214]) by kanga.kvack.org (Postfix) with ESMTP id A16D68E0001 for ; Tue, 15 Oct 2019 20:10:40 -0400 (EDT) Received: from smtpin22.hostedemail.com (10.5.19.251.rfc1918.com [10.5.19.251]) by forelay03.hostedemail.com (Postfix) with SMTP id 4839A81A91E2 for ; Wed, 16 Oct 2019 00:10:40 +0000 (UTC) X-FDA: 76047716640.22.bait61_5d18576a86530 X-HE-Tag: bait61_5d18576a86530 X-Filterd-Recvd-Size: 4467 Received: from mail-wr1-f67.google.com (mail-wr1-f67.google.com [209.85.221.67]) by imf24.hostedemail.com (Postfix) with ESMTP for ; Wed, 16 Oct 2019 00:10:39 +0000 (UTC) Received: by mail-wr1-f67.google.com with SMTP id y18so16390303wrn.5 for ; Tue, 15 Oct 2019 17:10:39 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=date:from:to:cc:subject:message-id:references:mime-version :content-disposition:in-reply-to:user-agent; bh=j69av0w9tOIcJjV3c32pq0GcgeoBfayplij6V6SpYU0=; b=bgHjvrc0BYjeuZcUXC0kki5/TiWu4OdYD3WS+IpNJ+KYIbdDqej8OzgPunn6eiq91H OVKWlynTXlxTOt1VCwiXBh1APyD/FWjLDlcYaGgSusW42XL2IXuu2oZG7QuhsPUOmW0O 95lVXtXQ1Jslh1IHfl8pkUkCaYNDRlRsb2Fi3r2KaCwsl87MeICsp4TtZZqNEGq7zZln FJJ5kJoWgm0EvynFElArkJp66uIptrD/WBESQdxVJCI2TMg1diIHTlWE9T4X/+7V6GMp Ibss60H57X7xrP+slUD20AfBhGc05pxATFFFpiR8kSbgiQKPhQgiHBNBGW4gx0B0n47S gBBw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:in-reply-to:user-agent; bh=j69av0w9tOIcJjV3c32pq0GcgeoBfayplij6V6SpYU0=; b=NwfYgd4vl1lizCUimfKOalp6/+xUKsoZM+lOXCyNGpz/Zl4FkhFTsPsRu2xjtBbSC5 NFaMA5/SC6BTKq1b48AKxdLp4YLPQerQUL8H/tSXjYKXOj51+jr3NqFEEphDOXhyR6lk 61HIYMIKH7N7PyIso/xrFKGXMuM1LHOW9siTXbgURqgxUwlQJSgbY6Dr5weVvCts0SUm hQKAGDIrIdoBL+KC1xW/De60tMaCY4kyxiqhpFx9Q0t6xnwDhJzv0fyuIPmtorNNpvV7 YhG0o9ySikeabpfI5NewbDRurJnj6CxM3T4JGC1MRekryRUQt9KvV/7ae5mvWBtLmjj3 qw+g== X-Gm-Message-State: APjAAAWnCTikYFymLxVr3MOXG+9kAytsKdx99F+lu3H28FZJAdCHRpJ7 1ANhuslvzLJSYoYPqHjAcgQ= X-Google-Smtp-Source: APXvYqx9didLD4puGKS0MiDLXNZLOo8iIpQ3jo9nSKlc8SDSZHdSY8l1HBE2hD8vMB9qGmzlwoOa+A== X-Received: by 2002:a5d:660f:: with SMTP id n15mr44289wru.179.1571184638558; Tue, 15 Oct 2019 17:10:38 -0700 (PDT) Received: from mail.google.com ([104.238.174.53]) by smtp.gmail.com with ESMTPSA id y5sm779614wma.14.2019.10.15.17.10.31 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 15 Oct 2019 17:10:37 -0700 (PDT) Date: Wed, 16 Oct 2019 08:10:28 +0800 From: Changbin Du To: Jonathan Corbet Cc: Changbin Du , linux-pci@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, linux-mm@kvack.org, linux-crypto@vger.kernel.org, linux-kselftest@vger.kernel.org, linux-wireless@vger.kernel.org, linux-fpga@vger.kernel.org, linux-usb@vger.kernel.org, dri-devel@lists.freedesktop.org, intel-gfx@lists.freedesktop.org Subject: Re: [PATCH] kernel-doc: rename the kernel-doc directive 'functions' to 'specific' Message-ID: <20191016001026.wa4hvc2pgyij2b4c@mail.google.com> References: <20191013055359.23312-1-changbin.du@gmail.com> <20191015122726.7e12f551@lwn.net> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20191015122726.7e12f551@lwn.net> User-Agent: NeoMutt/20180716 X-Bogosity: Ham, tests=bogofilter, spamicity=0.000001, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: On Tue, Oct 15, 2019 at 12:27:26PM -0600, Jonathan Corbet wrote: > On Sun, 13 Oct 2019 13:53:59 +0800 > Changbin Du wrote: > > > The 'functions' directive is not only for functions, but also works for > > structs/unions. So the name is misleading. This patch renames it to > > 'specific', so now we have export/internal/specific directives to limit > > the functions/types to be included in documentation. Meanwhile we improved > > the warning message. > > I agree with the others that "specific" doesn't really make things > better. "Interfaces" maybe; otherwise we could go for something like > "filter" or "select". > Jonathan, How about 'identifier' suggested by Matthew as it is mentioned in Then C spec? > Paint mine green :) > > Whatever we end up with, I think it should be added as a synonym for > "functions". Then the various selectors that are actually pulling out > docs for functions could be changed at leisure - or not at all. I'd > rather not see a big patch changing everything at once. > Sure, I'll make 'functions' deprecated and as an alias to our new directive name. > Thanks, > > jon -- Cheers, Changbin Du