[Mesa-dev] [PATCH] docs: Update todo regarding StencilOp and StencilOpSeparate.

[Timothy Arceri]

On Sat, 2015-08-15 at 14:54 +1000, Rhys Kidd wrote:
> On 8 August 2015 at 15:09, Rhys Kidd <rhyskidd at gmail.com> wrote:
> > OpenGL 2.0 function StencilOp() is in part internally implemented via
> > StencilOpSeparate(). This change happened some time ago, however the
> > accompanying doxygen todo comment was not accordingly updated.
> > 
> > Replace the outdated portion of this doxygen todo comment, leaving the 
> > remainder
> > unchanged.
> > 
> > Also better respect the 80 character suggested line length in this file.
> > 
> > Signed-off-by: Rhys Kidd <rhyskidd at gmail.com>
> > ---
> >  src/mesa/main/stencil.c | 17 ++++++++---------
> >  1 file changed, 8 insertions(+), 9 deletions(-)
> > 
> > diff --git a/src/mesa/main/stencil.c b/src/mesa/main/stencil.c
> > index 2a19a17..385a6d0 100644
> > --- a/src/mesa/main/stencil.c
> > +++ b/src/mesa/main/stencil.c
> > @@ -124,8 +124,8 @@ _mesa_ClearStencil( GLint s )
> >   * \sa glStencilFunc().
> >   *
> >   * Verifies the parameters and updates the respective values in
> > - * __struct gl_contextRec::Stencil. On change flushes the vertices and 
> > notifies the
> > - * driver via the dd_function_table::StencilFunc callback.
> > + * __struct gl_contextRec::Stencil. On change flushes the vertices and 
> > notifies
> > + * the driver via the dd_function_table::StencilFunc callback.
> >   */
> >  void GLAPIENTRY
> >  _mesa_StencilFuncSeparateATI( GLenum frontfunc, GLenum backfunc, GLint 
> > ref, GLuint mask )
> > @@ -178,8 +178,8 @@ _mesa_StencilFuncSeparateATI( GLenum frontfunc, GLenum 
> > backfunc, GLint ref, GLui
> >   * \sa glStencilFunc().
> >   *
> >   * Verifies the parameters and updates the respective values in
> > - * __struct gl_contextRec::Stencil. On change flushes the vertices and 
> > notifies the
> > - * driver via the dd_function_table::StencilFunc callback.
> > + * __struct gl_contextRec::Stencil. On change flushes the vertices and 
> > notifies
> > + * the driver via the dd_function_table::StencilFunc callback.
> >   */
> >  void GLAPIENTRY
> >  _mesa_StencilFunc( GLenum func, GLint ref, GLuint mask )
> > @@ -298,8 +298,8 @@ _mesa_StencilMask( GLuint mask )
> >   * \sa glStencilOp().
> >   *
> >   * Verifies the parameters and updates the respective fields in
> > - * __struct gl_contextRec::Stencil. On change flushes the vertices and 
> > notifies the
> > - * driver via the dd_function_table::StencilOp callback.
> > + * __struct gl_contextRec::Stencil. On change flushes the vertices and 
> > notifies
> > + * the driver via the dd_function_table::StencilOp callback.
> >   */
> >  void GLAPIENTRY
> >  _mesa_StencilOp(GLenum fail, GLenum zfail, GLenum zpass)
> > @@ -391,9 +391,8 @@ _mesa_ActiveStencilFaceEXT(GLenum face)
> > 
> >  /**
> >   * OpenGL 2.0 function.
> > - * \todo Make StencilOp() call this function.  And eventually remove the
> > - * ctx->Driver.StencilOp function and use ctx->Driver.StencilOpSeparate
> > - * instead.
> > + * \todo Eventually remove the ctx->Driver.StencilOp function and use
> > + * ctx->Driver.StencilOpSeparate instead.

Seems the other todo was done in Mesa 6.5 (2006) so that can be removed too. 

You can probably just remove the whole comment as we don't normally have
comments saying what version of OpenGL functions were added.


> >   */
> >  void GLAPIENTRY
> >  _mesa_StencilOpSeparate(GLenum face, GLenum sfail, GLenum zfail, GLenum 
> > zpass)
> > --
> > 2.1.4
> > 
> > 
> A friendly ping to the mailing list. Is there a taker for code review and 
> subsequent push to master?
> _______________________________________________
> mesa-dev mailing list
> mesa-dev at lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/mesa-dev