All of lore.kernel.org
 help / color / mirror / Atom feed
From: Matthew Wilcox <willy@infradead.org>
To: Thomas Zimmermann <tzimmermann@suse.de>
Cc: Tim.Bird@sony.com, jani.nikula@linux.intel.com,
	changbin.du@gmail.com, corbet@lwn.net, linux-doc@vger.kernel.org,
	linux-pci@vger.kernel.org, linux-fpga@vger.kernel.org,
	linux-usb@vger.kernel.org, linux-wireless@vger.kernel.org,
	linux-kernel@vger.kernel.org, dri-devel@lists.freedesktop.org,
	linux-mm@kvack.org, linux-crypto@vger.kernel.org,
	linux-kselftest@vger.kernel.org, intel-gfx@lists.freedesktop.org
Subject: Re: [PATCH] kernel-doc: rename the kernel-doc directive 'functions' to 'specific'
Date: Tue, 15 Oct 2019 04:54:39 -0700	[thread overview]
Message-ID: <20191015115439.GE32665@bombadil.infradead.org> (raw)
In-Reply-To: <7e7557b5-469f-3e63-6254-53dab2d7234a@suse.de>

On Tue, Oct 15, 2019 at 11:25:53AM +0200, Thomas Zimmermann wrote:
> > My preference would be to use 'symbols'.  I tried to come up with something
> > but 'symbols' is better than anything I came up with.
> 
> Maybe 'interfaces' or 'artifacts'. The term 'symbols' is just as
> imprecise as 'functions'.

I suggested 'identifier' because that's the term used in the C spec (6.2.1):

: An identifier can denote an object; a function; a tag or a member
: of a structure, union, or enumeration; a typedef name; a label name;
: a macro name; or a macro parameter.

We don't allow documenting all those things separately, but it does cover
all the things we do allow to be individually documented.

  reply	other threads:[~2019-10-15 11:54 UTC|newest]

Thread overview: 27+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-10-13  5:53 [PATCH] kernel-doc: rename the kernel-doc directive 'functions' to 'specific' Changbin Du
2019-10-13 19:29 ` kbuild test robot
2019-10-13 19:29   ` kbuild test robot
2019-10-13 19:29   ` kbuild test robot
2019-10-13 19:29   ` kbuild test robot
2019-10-14  8:59 ` Jani Nikula
2019-10-14  8:59   ` Jani Nikula
2019-10-14  8:59   ` Jani Nikula
2019-10-14 20:48   ` Tim.Bird
2019-10-14 20:48     ` Tim.Bird-7U/KSKJipcs
2019-10-14 20:48     ` Tim.Bird
2019-10-15  3:15     ` Matthew Wilcox
2019-10-15  9:25     ` Thomas Zimmermann
2019-10-15  9:25       ` Thomas Zimmermann
2019-10-15 11:54       ` Matthew Wilcox [this message]
2019-10-15 12:08         ` Thomas Zimmermann
2019-10-15 12:08           ` Thomas Zimmermann
2019-10-15 13:19         ` Jani Nikula
2019-10-15 13:19           ` Jani Nikula
2019-10-16  0:03         ` Changbin Du
2019-10-16  0:48           ` Matthew Wilcox
2019-10-16  0:48             ` Matthew Wilcox
2019-10-14 20:26 ` ✗ Fi.CI.CHECKPATCH: warning for " Patchwork
2019-10-14 20:46 ` ✓ Fi.CI.BAT: success " Patchwork
2019-10-15  8:40 ` ✓ Fi.CI.IGT: " Patchwork
2019-10-15 18:27 ` [PATCH] " Jonathan Corbet
2019-10-16  0:10   ` Changbin Du

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=20191015115439.GE32665@bombadil.infradead.org \
    --to=willy@infradead.org \
    --cc=Tim.Bird@sony.com \
    --cc=changbin.du@gmail.com \
    --cc=corbet@lwn.net \
    --cc=dri-devel@lists.freedesktop.org \
    --cc=intel-gfx@lists.freedesktop.org \
    --cc=jani.nikula@linux.intel.com \
    --cc=linux-crypto@vger.kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-fpga@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-kselftest@vger.kernel.org \
    --cc=linux-mm@kvack.org \
    --cc=linux-pci@vger.kernel.org \
    --cc=linux-usb@vger.kernel.org \
    --cc=linux-wireless@vger.kernel.org \
    --cc=tzimmermann@suse.de \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.