linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: NeilBrown <neilb@suse.com>
Cc: linux-doc@vger.kernel.org, LKML <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH 1/2] Documentation: convert path-lookup from markdown to resturctured text
Date: Wed, 5 Dec 2018 12:46:44 -0700	[thread overview]
Message-ID: <20181205124644.3f8a452a@lwn.net> (raw)
In-Reply-To: <87sgzc7v50.fsf@notabene.neil.brown.name>

On Wed, 05 Dec 2018 10:02:51 +1100
NeilBrown <neilb@suse.com> wrote:

> This allows the document to be integrated with the main documentation
> tree.
> Changes include:
> - rename from .md to .rst
> - use `` for code, not single `
> - use correct sub-section marking
> - fix indented blocks, both code and non-code
> - fix external-link markup
> 
> Signed-off-by: NeilBrown <neilb@suse.com>

Looks good at a first glance, but I have one question...

>  Documentation/filesystems/index.rst                |   2 +
>  .../{path-lookup.md => path-lookup.rst}            | 875 +++++++++++----------
>  2 files changed, 448 insertions(+), 429 deletions(-)
>  rename Documentation/filesystems/{path-lookup.md => path-lookup.rst} (59%)
> 
> diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst
> index 46d1b1be3a51..3c0f441a9536 100644
> --- a/Documentation/filesystems/index.rst
> +++ b/Documentation/filesystems/index.rst
> @@ -359,3 +359,5 @@ encryption of files and directories.
>      :maxdepth: 2
>  
>      fscrypt
> +
> +.. include::  path-lookup.rst

Is there a reason you used "include" rather than just adding it to the
TOC tree with the rest?

Thanks,

jon

  parent reply	other threads:[~2018-12-05 19:46 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-11-19  0:55 [PATCH] Documentation: update path-lookup.md for parallel lookups NeilBrown
2018-11-20 16:38 ` Jonathan Corbet
2018-12-04 23:02 ` [PATCH 1/2] Documentation: convert path-lookup from markdown to resturctured text NeilBrown
2018-12-04 23:04   ` [PATCH 2/2] Documentation: path-lookup - update externel refs NeilBrown
2018-12-05 19:46   ` Jonathan Corbet [this message]
2018-12-05 21:00     ` [PATCH 1/2] Documentation: convert path-lookup from markdown to resturctured text NeilBrown
2018-12-06 17:09       ` Jonathan Corbet
2018-12-09 22:58         ` NeilBrown
2018-12-20 15:54           ` Jonathan Corbet
2018-12-21  0:33             ` 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=20181205124644.3f8a452a@lwn.net \
    --to=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=neilb@suse.com \
    /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).