[Mesa-dev] [PATCH] glsl/linker: complete documentation for assign_attribute_or_color_locations

[Tapani Pälli]

Thanks Andres;
Reviewed-by: Tapani Pälli <tapani.palli at intel.com>

On 1/2/19 3:21 PM, Andres Gomez wrote:
> Commit 27f1298b9d9 ("glsl/linker: validate attribute aliasing before optimizations")
> forgot to complete the documentation.
> 
> Cc: Tapani Pälli <tapani.palli at intel.com>
> Signed-off-by: Andres Gomez <agomez at igalia.com>
> ---
>   src/compiler/glsl/linker.cpp | 22 +++++++++++++---------
>   1 file changed, 13 insertions(+), 9 deletions(-)
> 
> diff --git a/src/compiler/glsl/linker.cpp b/src/compiler/glsl/linker.cpp
> index 17fe0a58448..08e9fb721f8 100644
> --- a/src/compiler/glsl/linker.cpp
> +++ b/src/compiler/glsl/linker.cpp
> @@ -2693,18 +2693,22 @@ find_available_slots(unsigned used_mask, unsigned needed_count)
>   #define SAFE_MASK_FROM_INDEX(i) (((i) >= 32) ? ~0 : ((1 << (i)) - 1))
>   
>   /**
> - * Assign locations for either VS inputs or FS outputs
> + * Assign locations for either VS inputs or FS outputs.
>    *
> - * \param mem_ctx       Temporary ralloc context used for linking
> - * \param prog          Shader program whose variables need locations assigned
> - * \param constants     Driver specific constant values for the program.
> - * \param target_index  Selector for the program target to receive location
> - *                      assignmnets.  Must be either \c MESA_SHADER_VERTEX or
> - *                      \c MESA_SHADER_FRAGMENT.
> + * \param mem_ctx        Temporary ralloc context used for linking.
> + * \param prog           Shader program whose variables need locations
> + *                       assigned.
> + * \param constants      Driver specific constant values for the program.
> + * \param target_index   Selector for the program target to receive location
> + *                       assignmnets.  Must be either \c MESA_SHADER_VERTEX or
> + *                       \c MESA_SHADER_FRAGMENT.
> + * \param do_assignment  Whether we are actually marking the assignment or we
> + *                       are just doing a dry-run checking.
>    *
>    * \return
> - * If locations are successfully assigned, true is returned.  Otherwise an
> - * error is emitted to the shader link log and false is returned.
> + * If locations are (or can be, in case of dry-running) successfully assigned,
> + * true is returned.  Otherwise an error is emitted to the shader link log and
> + * false is returned.
>    */
>   static bool
>   assign_attribute_or_color_locations(void *mem_ctx,
>