All of lore.kernel.org
 help / color / mirror / Atom feed
From: "Jonathan Neuschäfer" <j.neuschaefer@gmx.net>
To: Jonathan Corbet <corbet@lwn.net>
Cc: "Jonathan Neuschäfer" <j.neuschaefer@gmx.net>,
	linux-mtd@lists.infradead.org,
	"Richard Weinberger" <richard@nod.at>,
	"Mauro Carvalho Chehab" <mchehab+huawei@kernel.org>,
	"Miklos Szeredi" <mszeredi@redhat.com>,
	"Daniel W. S. Almeida" <dwlsalmeida@gmail.com>,
	"Jaskaran Singh" <jaskaransingh7654321@gmail.com>,
	"Tobin C. Harding" <tobin@kernel.org>,
	"Stefan Hajnoczi" <stefanha@redhat.com>,
	"David S. Miller" <davem@davemloft.net>,
	"Rob Herring" <robh@kernel.org>,
	"Greg Kroah-Hartman" <gregkh@linuxfoundation.org>,
	"Jonathan Cameron" <Jonathan.Cameron@huawei.com>,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH 4/4] docs: ubifs-authentication: fix Sphinx warning
Date: Fri, 21 Feb 2020 16:59:12 +0100	[thread overview]
Message-ID: <20200221155912.GF2031@latitude> (raw)
In-Reply-To: <20200219041758.3b7316b8@lwn.net>

[-- Attachment #1: Type: text/plain, Size: 1206 bytes --]

On Wed, Feb 19, 2020 at 04:17:58AM -0700, Jonathan Corbet wrote:
> On Fri, 14 Feb 2020 18:08:07 +0100
> Jonathan Neuschäfer <j.neuschaefer@gmx.net> wrote:
> 
> > This fixes the following warning:
> > 
> > Documentation/filesystems/ubifs-authentication.rst:98: WARNING:
> >   Inline interpreted text or phrase reference start-string without end-string.
> > 
> > Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
> 
> So this, IMO, should be fixed in patch #2, when you're touching the file
> anyway.  I don't see a lot of value in adding a warning to the docs build
> then immediately removing it.

Good point.

> Also, please send a cover letter with multi-part sets like this so we
> know what the overall objective is.

Ok, I'll remember to do that more.

In this case, I just saw this file and wanted it to work better with
Sphinx.

> Note also that Mauro is also playing with this file (and ubifs.txt, which
> really should be included as well) at the same time.

Hmm. I only saw Mauro's series after sending this one.

I think I'll respin this series after Mauro's is merged, to keep the
potential for merge conflicts low.


Thanks,
Jonathan Neuschäfer

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

WARNING: multiple messages have this Message-ID (diff)
From: "Jonathan Neuschäfer" <j.neuschaefer@gmx.net>
To: Jonathan Corbet <corbet@lwn.net>
Cc: "Miklos Szeredi" <mszeredi@redhat.com>,
	"Rob Herring" <robh@kernel.org>,
	"Mauro Carvalho Chehab" <mchehab+huawei@kernel.org>,
	"Richard Weinberger" <richard@nod.at>,
	"Jonathan Cameron" <Jonathan.Cameron@huawei.com>,
	linux-doc@vger.kernel.org,
	"Jonathan Neuschäfer" <j.neuschaefer@gmx.net>,
	"David S. Miller" <davem@davemloft.net>,
	"Greg Kroah-Hartman" <gregkh@linuxfoundation.org>,
	linux-mtd@lists.infradead.org,
	"Tobin C. Harding" <tobin@kernel.org>,
	"Stefan Hajnoczi" <stefanha@redhat.com>,
	"Jaskaran Singh" <jaskaransingh7654321@gmail.com>,
	"Daniel W. S. Almeida" <dwlsalmeida@gmail.com>,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH 4/4] docs: ubifs-authentication: fix Sphinx warning
Date: Fri, 21 Feb 2020 16:59:12 +0100	[thread overview]
Message-ID: <20200221155912.GF2031@latitude> (raw)
In-Reply-To: <20200219041758.3b7316b8@lwn.net>


[-- Attachment #1.1: Type: text/plain, Size: 1206 bytes --]

On Wed, Feb 19, 2020 at 04:17:58AM -0700, Jonathan Corbet wrote:
> On Fri, 14 Feb 2020 18:08:07 +0100
> Jonathan Neuschäfer <j.neuschaefer@gmx.net> wrote:
> 
> > This fixes the following warning:
> > 
> > Documentation/filesystems/ubifs-authentication.rst:98: WARNING:
> >   Inline interpreted text or phrase reference start-string without end-string.
> > 
> > Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
> 
> So this, IMO, should be fixed in patch #2, when you're touching the file
> anyway.  I don't see a lot of value in adding a warning to the docs build
> then immediately removing it.

Good point.

> Also, please send a cover letter with multi-part sets like this so we
> know what the overall objective is.

Ok, I'll remember to do that more.

In this case, I just saw this file and wanted it to work better with
Sphinx.

> Note also that Mauro is also playing with this file (and ubifs.txt, which
> really should be included as well) at the same time.

Hmm. I only saw Mauro's series after sending this one.

I think I'll respin this series after Mauro's is merged, to keep the
potential for merge conflicts low.


Thanks,
Jonathan Neuschäfer

[-- Attachment #1.2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

[-- Attachment #2: Type: text/plain, Size: 144 bytes --]

______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/

  reply	other threads:[~2020-02-21 15:59 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-02-14 17:08 [PATCH 1/4] MAINTAINERS: Add ubifs-authentication.rst to UBIFS Jonathan Neuschäfer
2020-02-14 17:08 ` Jonathan Neuschäfer
2020-02-14 17:08 ` [PATCH 2/4] docs: ubifs-authentication: Add a top-level heading Jonathan Neuschäfer
2020-02-14 17:08   ` Jonathan Neuschäfer
2020-02-14 17:08 ` [PATCH 3/4] docs: filesystems: link ubifs-authentication.rst Jonathan Neuschäfer
2020-02-14 17:08   ` Jonathan Neuschäfer
2020-02-14 17:08 ` [PATCH 4/4] docs: ubifs-authentication: fix Sphinx warning Jonathan Neuschäfer
2020-02-14 17:08   ` Jonathan Neuschäfer
2020-02-19 11:17   ` Jonathan Corbet
2020-02-19 11:17     ` Jonathan Corbet
2020-02-21 15:59     ` Jonathan Neuschäfer [this message]
2020-02-21 15:59       ` Jonathan Neuschäfer

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=20200221155912.GF2031@latitude \
    --to=j.neuschaefer@gmx.net \
    --cc=Jonathan.Cameron@huawei.com \
    --cc=corbet@lwn.net \
    --cc=davem@davemloft.net \
    --cc=dwlsalmeida@gmail.com \
    --cc=gregkh@linuxfoundation.org \
    --cc=jaskaransingh7654321@gmail.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-mtd@lists.infradead.org \
    --cc=mchehab+huawei@kernel.org \
    --cc=mszeredi@redhat.com \
    --cc=richard@nod.at \
    --cc=robh@kernel.org \
    --cc=stefanha@redhat.com \
    --cc=tobin@kernel.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.