From: David Sterba <dsterba@suse.cz>
To: Matthew Wilcox <willy@infradead.org>
Cc: Steven Rostedt <rostedt@goodmis.org>,
Jonathan Corbet <corbet@lwn.net>,
Peter Zijlstra <peterz@infradead.org>,
linux-doc@vger.kernel.org, LKML <linux-kernel@vger.kernel.org>
Subject: Re: Minor RST rant
Date: Fri, 24 Jul 2020 20:14:53 +0200 [thread overview]
Message-ID: <20200724181453.GH3703@twin.jikos.cz> (raw)
In-Reply-To: <20200724174130.GC23808@casper.infradead.org>
On Fri, Jul 24, 2020 at 06:41:30PM +0100, Matthew Wilcox wrote:
> I think we're all pretty comfortable seeing function names adorned with
> a closing pair of parens. The ``...`` to adorn constants feels OK to me,
> but maybe not to you? If that feels excessive, can you suggest something
> that would distinguish between POSIX and AT_EMPTY_PATH?
>
> [1] Too far being a subjective measure, of course. My preferences
> are on display in core-api/xarray.rst
I like that minimalistic style and I'd suggest to use the quotes only
for the document-specific definitions, eg. the XA_ macros, and drop
quotes around NULL or other standard macros like LONG_MAX. The quotes
are hilighted in vim and seeing NULL is actually distracting.
Functions get automatically converted to html links so this does not
need to be explicitly quoted, but similar to wikipedia style, the first
mention could be quoted to provide a visual anchor.
next prev parent reply other threads:[~2020-07-24 18:15 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-07-24 17:22 Minor RST rant Steven Rostedt
2020-07-24 17:33 ` Jonathan Corbet
2020-07-24 18:42 ` Steven Rostedt
2020-07-24 23:46 ` NeilBrown
2020-07-29 12:44 ` peterz
2020-08-05 14:49 ` Vegard Nossum
2020-08-05 15:12 ` peterz
2020-08-06 6:48 ` Christoph Hellwig
2020-08-06 8:36 ` Vegard Nossum
2020-07-28 12:52 ` peterz
2020-07-28 15:28 ` Steven Rostedt
2020-07-29 9:36 ` peterz
2020-07-24 17:41 ` Matthew Wilcox
2020-07-24 18:14 ` David Sterba [this message]
2020-07-24 18:51 ` Steven Rostedt
2020-07-24 23:58 ` NeilBrown
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=20200724181453.GH3703@twin.jikos.cz \
--to=dsterba@suse.cz \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=peterz@infradead.org \
--cc=rostedt@goodmis.org \
--cc=willy@infradead.org \
/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