From: NeilBrown <neilb@suse.de>
To: Steven Rostedt <rostedt@goodmis.org>,
Matthew Wilcox <willy@infradead.org>
Cc: 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: Sat, 25 Jul 2020 09:58:35 +1000 [thread overview]
Message-ID: <871rl0v51w.fsf@notabene.neil.brown.name> (raw)
In-Reply-To: <20200724145148.58836d66@oasis.local.home>
[-- Attachment #1: Type: text/plain, Size: 3128 bytes --]
On Fri, Jul 24 2020, Steven Rostedt wrote:
> On Fri, 24 Jul 2020 18:41:30 +0100
> Matthew Wilcox <willy@infradead.org> wrote:
>
>> Great example. Some people definitely go too far with rst markup, and
>> we generally try to discourage it. And I'm pretty sure we take patches
>
> I'd send patches but I suck at markup ;-) [1]
Do you read Jane Austen at all?
"I certainly have not the talent which some people possess," said
Darcy, "of conversing easily with those I have never seen before.
I cannot catch their tone of conversation, or appear interested
in their concerns, as I often see done."
"My fingers," said Elizabeth, "do not move over this instrument
in the masterly manner which I see so many women's do. They
have not the same force or rapidity, and do not produce the
same expression. But then I have always supposed it to be my
own fault--because I will not take the trouble of practising."
:-)
NeilBrown
>
>> to remove excessive markup where it's gone too far [1].
>>
>> You can see how this renders in html at
>> https://www.kernel.org/doc/html/latest/filesystems/path-lookup.html or
>> run 'make htmldocs' to build it locally. Personally, I don't think
>> the markup style it uses works very well in the html either.
>>
>> I'd like to see this paragraph written as:
>>
>> > It is tempting to describe the second kind as starting with a
>> > component, but that isn't always accurate: a pathname can lack both
>> > slashes and components, it can be empty, in other words. This is
>> > generally forbidden in POSIX, but some of the "*at()" system calls
>> > in Linux permit it when the ``AT_EMPTY_PATH`` flag is given. For
>> > example, if you have an open file descriptor on an executable file you
>> > can execute it by calling execveat() passing the file descriptor, an
>> > empty path, and the ``AT_EMPTY_PATH`` flag.
>>
>> 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?
>
> Honestly, it's the context that distinguishes the two for me. I don't
> need any markup. But yeah, the double backtick still seems awkward.
> Funny thing is, markup like this:
>
> <b>AT_EMPTY_PATH</b>
>
> doesn't bother me as much. Not sure why though :-/
>
> My frustration with this stood out quite a bit because I went from one
> file (with the same name) in .txt format, and went through that fast and
> quickly where everything made a lot of sense, and then jumping to this
> file, and feeling like I came to a stand-still in my understanding of
> the material.
>
>>
>> [1] Too far being a subjective measure, of course. My preferences
>> are on display in core-api/xarray.rst
>
> [1] I maintain trace/ftrace.rst, but the markup in that was written by
> others, and I gave a lot of pushback when I found that the markup made
> it hard to read with "less".
>
> -- Steve
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 832 bytes --]
prev parent reply other threads:[~2020-07-24 23:58 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
2020-07-24 18:51 ` Steven Rostedt
2020-07-24 23:58 ` NeilBrown [this message]
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=871rl0v51w.fsf@notabene.neil.brown.name \
--to=neilb@suse.de \
--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;
as well as URLs for NNTP newsgroup(s).