All of lore.kernel.org
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: "Héctor Orón Martínez" <hector.oron@gmail.com>
Cc: linux-doc@vger.kernel.org
Subject: Re: [PATCH] doc: fix warnings for unused files in toctree
Date: Tue, 29 Oct 2019 03:21:30 -0600	[thread overview]
Message-ID: <20191029032130.444c6fce@lwn.net> (raw)
In-Reply-To: <CAODfWeH67_ZfO7yrrQ+EcFgXd8stA23y6hUtimhzEbXvWmjhbw@mail.gmail.com>

On Mon, 28 Oct 2019 18:26:09 +0100
Héctor Orón Martínez <hector.oron@gmail.com> wrote:

>   I was planning to add more fixes in separated commit, but while
> working on it, apparently it could be part of the previous commit.
>   Apologies, find updated patch.

Thanks for working to improve the documentation!  I do have a couple of
requests, though...

 - Please send patches inline, rather than as attachments; that makes
   them much easier to review.

 - Please work against docs-next and look at the history of what you are
   working on. For example:

> diff --git a/Documentation/driver-api/dma-buf.rst b/Documentation/driver-api/dma-buf.rst
> index b541e97c7ab1..d2f3c95ea9ed 100644
> --- a/Documentation/driver-api/dma-buf.rst
> +++ b/Documentation/driver-api/dma-buf.rst
> @@ -115,18 +115,6 @@ Kernel Functions and Structures Reference
>  .. kernel-doc:: include/linux/dma-buf.h
>     :internal:
>  
> -Reservation Objects
> --------------------
> -
> -.. kernel-doc:: drivers/dma-buf/reservation.c
> -   :doc: Reservation Object Overview
> -
> -.. kernel-doc:: drivers/dma-buf/reservation.c
> -   :export:
> -
> -.. kernel-doc:: include/linux/reservation.h
> -   :internal:

This is not a correct fix; those files have been renamed, not removed.
There is a (correct) fix in docs-next, and has been for some weeks now.

If you could please review the rest of your patch and resubmit against
docs-next, I would appreciate it.

Many thanks,

jon

  reply	other threads:[~2019-10-29  9:21 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-10-28 17:12 [PATCH] doc: fix warnings for unused files in toctree Héctor Orón Martínez
2019-10-28 17:26 ` Héctor Orón Martínez
2019-10-29  9:21   ` Jonathan Corbet [this message]
2019-10-29 10:58     ` Héctor Orón Martínez
2019-10-29 11:01       ` Jonathan Corbet
  -- strict thread matches above, loose matches on Subject: below --
2019-10-29 13:44 hector.oron
2019-10-29 14:43 ` Jonathan Corbet

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=20191029032130.444c6fce@lwn.net \
    --to=corbet@lwn.net \
    --cc=hector.oron@gmail.com \
    --cc=linux-doc@vger.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.