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.
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.
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
On Mon, Jul 31, 2017 at 02:47:12PM +0200, Daniel Vetter wrote:
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
Applied, thanks.
Thierry
On Mon, 31 Jul 2017, Daniel Vetter daniel@ffwll.ch wrote:
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 ...
Arguably it would be reasonable to quote prefixes even in plain text. For example, reference the "tinydrm_" prefix.
BR, Jani.
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
dri-devel@lists.freedesktop.org
-
Daniel Vetter -
Jani Nikula -
Thierry Reding