dri-devel Archive on lore.kernel.org
 help / color / mirror / Atom feed
From: Daniel Vetter <daniel@ffwll.ch>
To: Thierry Reding <thierry.reding@gmail.com>
Cc: Daniel Vetter <daniel.vetter@intel.com>, dri-devel@lists.freedesktop.org
Subject: Re: [PATCH] drm: todo: Avoid accidental crossreferences
Date: Mon, 31 Jul 2017 14:47:12 +0200	[thread overview]
Message-ID: <20170731124712.GB6345@dvetter-linux.ger.corp.intel.com> (raw)
In-Reply-To: <20170731124259.7495-1-thierry.reding@gmail.com>

On Mon, Jul 31, 2017 at 02:42:59PM +0200, Thierry Reding wrote:
> From: Thierry Reding <treding@nvidia.com>
> 
> RST uses underscores at the end of words to create crossreferences and
> it will accidentally try to link to tinydrm_ and drm_fb_ targets from
> the TODO, which is clearly not the intention in this context.
> 
> Use backslashes to escape the special meaning of the underscore.

Yeah that's one of the things where rst gets a bit in the way of just
plain text. Another one is * at the end ...

Reviewed-by: Daniel Vetter <daniel.vetter@ffwll.ch>

> 
> Signed-off-by: Thierry Reding <treding@nvidia.com>
> ---
>  Documentation/gpu/todo.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/gpu/todo.rst b/Documentation/gpu/todo.rst
> index 1ae42006deea..22af55d06ab8 100644
> --- a/Documentation/gpu/todo.rst
> +++ b/Documentation/gpu/todo.rst
> @@ -108,8 +108,8 @@ This would be especially useful for tinydrm:
>    crtc state, clear that to the max values, x/y = 0 and w/h = MAX_INT, in
>    __drm_atomic_helper_crtc_duplicate_state().
>  
> -- Move tinydrm_merge_clips into drm_framebuffer.c, dropping the tinydrm_
> -  prefix ofc and using drm_fb_. drm_framebuffer.c makes sense since this
> +- Move tinydrm_merge_clips into drm_framebuffer.c, dropping the tinydrm\_
> +  prefix ofc and using drm_fb\_. drm_framebuffer.c makes sense since this
>    is a function useful to implement the fb->dirty function.
>  
>  - Create a new drm_fb_dirty function which does essentially what e.g.
> -- 
> 2.13.3
> 
> _______________________________________________
> dri-devel mailing list
> dri-devel@lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/dri-devel

-- 
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel

  reply	other threads:[~2017-07-31 12:47 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-07-31 12:42 [PATCH] drm: todo: Avoid accidental crossreferences Thierry Reding
2017-07-31 12:47 ` Daniel Vetter [this message]
2017-07-31 14:19   ` Thierry Reding
2017-08-03 10:43   ` Jani Nikula

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=20170731124712.GB6345@dvetter-linux.ger.corp.intel.com \
    --to=daniel@ffwll.ch \
    --cc=daniel.vetter@intel.com \
    --cc=dri-devel@lists.freedesktop.org \
    --cc=thierry.reding@gmail.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