linux-kernel - Re: [PATCH 1/2] Documentation: convert path-lookup from markdown to resturctured text

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20181205124644.3f8a452a@lwn.net>
Date:   Wed, 5 Dec 2018 12:46:44 -0700
From:   Jonathan Corbet <corbet@....net>
To:     NeilBrown <neilb@...e.com>
Cc:     linux-doc@...r.kernel.org, LKML <linux-kernel@...r.kernel.org>
Subject: Re: [PATCH 1/2] Documentation: convert path-lookup from markdown to
 resturctured text

On Wed, 05 Dec 2018 10:02:51 +1100
NeilBrown <neilb@...e.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@...e.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