Commit 0df4e06f authored by Camilla Berglund's avatar Camilla Berglund
Browse files

Make more RFC 2119 compliant use of may

parent 8f0f1cf6
......@@ -261,7 +261,7 @@ configurations and to create contexts. The options are:
Wayland and Mir both require the EGL backend.
If you are building GLFW as a shared library / dynamic library / DLL then you
must also define `_GLFW_BUILD_DLL`. Otherwise, you may not define it.
must also define `_GLFW_BUILD_DLL`. Otherwise, you must not define it.
If you are using the X11 window creation API, support for the following X11
extensions can be enabled:
......
......@@ -87,7 +87,7 @@ disabled with a [compile-time option](@ref compile_options_osx).
You can disable context creation by setting the
[GLFW_CLIENT_API](@ref window_hints_ctx) hint to `GLFW_NO_API`. Windows without
contexts may not be passed to @ref glfwMakeContextCurrent or @ref
contexts must not be passed to @ref glfwMakeContextCurrent or @ref
glfwSwapBuffers.
......
......@@ -184,7 +184,7 @@ releases.
@subsection reentrancy Reentrancy
GLFW event processing and object creation and destruction are not reentrant.
This means that the following functions may not be called from any callback
This means that the following functions must not be called from any callback
function:
- @ref glfwCreateWindow
......@@ -202,7 +202,7 @@ functions not on this list will not be made non-reentrant.
@subsection thread_safety Thread safety
Most GLFW functions may only be called from the main thread, but some may be
Most GLFW functions must only be called from the main thread, but some may be
called from any thread. However, no GLFW function may be called from any thread
but the main thread until GLFW has been successfully initialized, including
functions that may called before initialization.
......
......@@ -53,7 +53,7 @@ TinyCThread.
However, GLFW 3 has better support for _use from multiple threads_ than GLFW
2 had. Contexts can be made current on any thread, although only a single
thread at a time, and the documentation explicitly states which functions may be
used from any thread and which may only be used from the main thread.
used from any thread and which must only be used from the main thread.
@par Removed functions
`glfwSleep`, `glfwCreateThread`, `glfwDestroyThread`, `glfwWaitThread`,
......@@ -416,7 +416,7 @@ these hotkeys to function even when running in full screen mode.
GLFW 3 does not register @ref glfwTerminate with `atexit` at initialization,
because `exit` calls registered functions from the calling thread and while it
is permitted to call `exit` from any thread, @ref glfwTerminate may only be
is permitted to call `exit` from any thread, @ref glfwTerminate must only be
called from the main thread.
To release all resources allocated by GLFW, you should call @ref glfwTerminate
......
......@@ -252,7 +252,7 @@ compatible with 1.x.
`GLFW_OPENGL_FORWARD_COMPAT` specifies whether the OpenGL context should be
forward-compatible, i.e. one where all functionality deprecated in the requested
version of OpenGL is removed. This may only be used if the requested OpenGL
version of OpenGL is removed. This must only be used if the requested OpenGL
version is 3.0 or above. If OpenGL ES is requested, this hint is ignored.
@par
......
This diff is collapsed.
......@@ -300,8 +300,8 @@ int _glfwInitContextAPI(void)
//
void _glfwTerminateContextAPI(void)
{
// NOTE: This function may not call any X11 functions, as it is called after
// XCloseDisplay (see _glfwPlatformTerminate for details)
// NOTE: This function must not call any X11 functions, as it is called
// after XCloseDisplay (see _glfwPlatformTerminate for details)
if (_glfw.glx.handle)
{
......
......@@ -41,7 +41,7 @@
defined(GLFW_INCLUDE_GLEXT) || \
defined(GLFW_INCLUDE_GLU) || \
defined(GLFW_DLL)
#error "You may not define any header option macros when compiling GLFW"
#error "You must not define any header option macros when compiling GLFW"
#endif
#define GLFW_INCLUDE_NONE
......@@ -124,7 +124,7 @@ typedef int GLFWbool;
* @brief Various utility functions for internal use.
*
* These functions are shared code and may be used by any part of GLFW
* Each platform may add its own utility functions, but those may only be
* Each platform may add its own utility functions, but those must only be
* called by the platform-specific code
*/
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment