diff options
| author | Erik Faye-Lund <erik.faye-lund@collabora.com> | 2021-04-15 15:32:26 +0200 |
|---|---|---|
| committer | Marge Bot <eric+marge@anholt.net> | 2021-04-26 08:39:02 +0000 |
| commit | 525f7b6a236fe3e0157937d7b3977e8f42255d33 (patch) | |
| tree | 9880140754b6fcb6dbdf5ee988525ee46d0ed22e /docs/codingstyle.rst | |
| parent | 1e4e22e6baa38143ef1637795b463917b326cab2 (diff) | |
docs: use tables instead of pre-formatted text
This makes this easier to read.
Reviewed-by: Eric Anholt <eric@anholt.net>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/10281>
Diffstat (limited to 'docs/codingstyle.rst')
| -rw-r--r-- | docs/codingstyle.rst | 22 |
1 files changed, 15 insertions, 7 deletions
diff --git a/docs/codingstyle.rst b/docs/codingstyle.rst index ab479e2e1c4..1383a31723c 100644 --- a/docs/codingstyle.rst +++ b/docs/codingstyle.rst @@ -101,13 +101,21 @@ Basic formatting guidelines - Function names follow various conventions depending on the type of function: - :: - - glFooBar() - a public GL entry point (in glapi_dispatch.c) - _mesa_FooBar() - the internal immediate mode function - save_FooBar() - retained mode (display list) function in dlist.c - foo_bar() - a static (private) function - _mesa_foo_bar() - an internal non-static Mesa function + +---------------------+------------------------------------------+ + | Convention | Explanation | + +=====================+==========================================+ + | ``glFooBar()`` | a public GL entry point (in | + | | :file:`glapi_dispatch.c`) | + +---------------------+------------------------------------------+ + | ``_mesa_FooBar()`` | the internal immediate mode function | + +---------------------+------------------------------------------+ + | ``save_FooBar()`` | retained mode (display list) function in | + | | :file:`dlist.c` | + +---------------------+------------------------------------------+ + | ``foo_bar()`` | a static (private) function | + +---------------------+------------------------------------------+ + | ``_mesa_foo_bar()`` | an internal non-static Mesa function | + +---------------------+------------------------------------------+ - Constants, macros and enum names are ``ALL_UPPERCASE``, with \_ between words. |