gbm: Clarify acceptable formats for gbm_bo
authorDaniel Stone <daniels@collabora.com>
Thu, 1 Nov 2018 11:30:36 +0000 (11:30 +0000)
committerDaniel Stone <daniels@collabora.com>
Fri, 16 Nov 2018 09:40:46 +0000 (09:40 +0000)
commit5e1fe240c43537150e124e99915702d193ea9430
treea132aa12e4ffefdeac4d52ab9303d3fb5584067c
parentba94a00c7ce1514372bfe9b35c8e0c7fb8cd710e
gbm: Clarify acceptable formats for gbm_bo

gbm_bo_create() was presumably meant to originally accept gbm_bo_format
enums, but it's accepted GBM_FORMAT_* tokens since the dawn of time.
This is good, since gbm_bo_format is rarely used and covers a lot less
ground than GBM_FORMAT_*.

Change the documentation to refer to both; this involves removing a 'see
also' for gbm_bo_format, since we can't also use \sa to refer to a
family of anonymous #defines.

Signed-off-by: Daniel Stone <daniels@collabora.com>
Reported-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk>
Reviewed-by: Eric Anholt <eric@anholt.net>
src/gbm/main/gbm.c