From: Fox Chen <foxhlchen@gmail.com>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Matthew Wilcox <willy@infradead.org>, Neil Brown <neilb@suse.de>,
vegard.nossum@oracle.com, Al Viro <viro@zeniv.linux.org.uk>,
rdunlap@infradead.org, grandmaster@al2klimov.de,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
Greg KH <gregkh@linuxfoundation.org>
Subject: Re: [PATCH v2 01/12] docs: path-lookup: update follow_managed() part
Date: Tue, 20 Apr 2021 09:12:23 +0800 [thread overview]
Message-ID: <CAC2o3DLfzg=KeFJupLMHhyNbd0ww3hMvsmYeK87EVZPp=oUm+w@mail.gmail.com> (raw)
In-Reply-To: <87fszmaxl4.fsf@meer.lwn.net>
On Tue, Apr 20, 2021 at 3:22 AM Jonathan Corbet <corbet@lwn.net> wrote:
>
> Fox Chen <foxhlchen@gmail.com> writes:
>
> > On Mon, Apr 19, 2021 at 11:25 AM Matthew Wilcox <willy@infradead.org> wrote:
> >>
> >> On Mon, Apr 19, 2021 at 10:33:00AM +0800, Fox Chen wrote:
> >> > On Mon, Apr 19, 2021 at 10:17 AM Matthew Wilcox <willy@infradead.org> wrote:
> >> > > You can drop ``..`` from around function named which are followed with
> >> > > (). d74b0d31ddde ("Docs: An initial automarkup extension for sphinx")
> >> > > marks them up automatically.
> >> > >
> >> >
> >> > Got it, thanks for letting me know. But I will still use them in this
> >> > patch series to keep consistency with the remaining parts of the
> >> > document.
> >>
> >> Well, you weren't. For example:
> >>
> >> +As the last step of ``walk_component()``, ``step_into()`` will be called either
> >> +directly from walk_component() or from handle_dots(). It calls
> >> +``handle_mount()``, to check and handle mount points, in which a new
> >>
> >> Neither of the functions on the second line were using ``.
> >
> > Oh, That was a mistake, They should've been wrapped with ``.
> > Thanks for pointing it out. I will go through the whole patch set and
> > fix this type of inconsistency in V3.
>
> Please, if possible, go toward the bare function() form rather than
> using literals...it's easier to read and the docs system will
> automatically create cross references for you.
>
> Thanks,
>
> jon
Ok, If you have no problem with that inconsistency, I will go with the
bare one in v3.
thanks,
fox
next prev parent reply other threads:[~2021-04-20 1:12 UTC|newest]
Thread overview: 34+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-03-16 5:47 [PATCH v2 00/12] docs: path-lookup: Update pathlookup docs Fox Chen
2021-03-16 5:47 ` [PATCH v2 01/12] docs: path-lookup: update follow_managed() part Fox Chen
2021-04-19 0:52 ` NeilBrown
2021-04-19 2:17 ` Matthew Wilcox
2021-04-19 2:33 ` Fox Chen
2021-04-19 3:25 ` Matthew Wilcox
2021-04-19 3:33 ` Fox Chen
2021-04-19 19:22 ` Jonathan Corbet
2021-04-20 1:12 ` Fox Chen [this message]
2021-03-16 5:47 ` [PATCH v2 02/12] docs: path-lookup: update path_to_nameidata() part Fox Chen
2021-04-19 1:00 ` NeilBrown
2021-03-16 5:47 ` [PATCH v2 03/12] docs: path-lookup: update path_mountpoint() part Fox Chen
2021-04-19 1:03 ` NeilBrown
2021-03-16 5:47 ` [PATCH v2 04/12] docs: path-lookup: update do_last() part Fox Chen
2021-04-19 1:17 ` NeilBrown
2021-03-16 5:47 ` [PATCH v2 05/12] docs: path-lookup: remove filename_mountpoint Fox Chen
2021-04-19 1:20 ` NeilBrown
2021-03-16 5:47 ` [PATCH v2 06/12] docs: path-lookup: Add macro name to symlink limit description Fox Chen
2021-04-19 1:22 ` NeilBrown
2021-03-16 5:47 ` [PATCH v2 07/12] docs: path-lookup: i_op->follow_link replaced with i_op->get_link Fox Chen
2021-04-19 1:28 ` NeilBrown
2021-03-16 5:47 ` [PATCH v2 08/12] docs: path-lookup: update i_op->put_link and cookie description Fox Chen
2021-04-19 1:37 ` NeilBrown
2021-03-16 5:47 ` [PATCH v2 09/12] docs: path-lookup: no get_link() Fox Chen
2021-04-19 1:41 ` NeilBrown
2021-03-16 5:47 ` [PATCH v2 10/12] docs: path-lookup: update WALK_GET, WALK_PUT desc Fox Chen
2021-04-19 1:47 ` NeilBrown
2021-03-16 5:47 ` [PATCH v2 11/12] docs: path-lookup: update get_link() ->follow_link description Fox Chen
2021-04-19 1:54 ` NeilBrown
2021-03-16 5:47 ` [PATCH v2 12/12] docs: path-lookup: update symlink description Fox Chen
2021-04-19 1:59 ` NeilBrown
2021-04-19 2:34 ` Fox Chen
2021-04-13 21:18 ` [PATCH v2 00/12] docs: path-lookup: Update pathlookup docs Jonathan Corbet
2021-04-13 22:26 ` 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='CAC2o3DLfzg=KeFJupLMHhyNbd0ww3hMvsmYeK87EVZPp=oUm+w@mail.gmail.com' \
--to=foxhlchen@gmail.com \
--cc=corbet@lwn.net \
--cc=grandmaster@al2klimov.de \
--cc=gregkh@linuxfoundation.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=neilb@suse.de \
--cc=rdunlap@infradead.org \
--cc=vegard.nossum@oracle.com \
--cc=viro@zeniv.linux.org.uk \
--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).