This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project gfxprim.git. The branch, master has been updated via 10ac58d34771e81c0c00f1e5d6d812427af2c2d8 (commit) from fd131ab40d827e66825dfe9202e2e02021ba07c1 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- http://repo.or.cz/w/gfxprim.git/commit/10ac58d34771e81c0c00f1e5d6d812427af2c... commit 10ac58d34771e81c0c00f1e5d6d812427af2c2d8 Author: Cyril Hrubis <metan@ucw.cz> Date: Mon Dec 31 17:28:54 2012 +0100 doc: backends, coding_style: Typos and fixes. diff --git a/doc/backends.txt b/doc/backends.txt index a4fb226..aca70f6 100644 --- a/doc/backends.txt +++ b/doc/backends.txt @@ -7,7 +7,8 @@ initialization interface each backend has it's specific function and semantics but once backend is initialized the backend structure provides unified API for controlling the drawing. -So far there are backends for Linux mmaped frame-buffer, libSDL and X11. +So far there are backends for Linux mmaped 'frame-buffer', 'libSDL' and +'X Window System'. TIP: For example usage see backend link:example_backend.html[example]. @@ -220,9 +221,9 @@ WARNING: It's very important to call this functions on application exit. If you doesn't do so, the state of the display, resolution etc. may not be reset back to its original state. This includes program crashes and iterruptions. Also this function may not be signal-async-safe, it's - better to set signal hanlers that calls it as this usually works and - not doing so may leave non-working system with black display or - non-responding keyboard. + better to set signal hanlers that calls it on SEGFAULT and SIGBUS + as this usually works and not doing so may leave non-working system + with black display or non-responding keyboard. [source,c] ------------------------------------------------------------------------------- @@ -273,14 +274,16 @@ void GP_BackendWait(GP_Backend *backend); Blocks until backend event arrives. -NOTE: Events recieved by backend are not necessarily translated into the input - events. +[NOTE] +Events recieved by backend are not necessarily translated into the input +events. -WARNING: Using GP_BackendWait() in multithreaded program will most likely - cause deadlocks. As the backend data structures and connection is - guarded by a lock any other backend function (called from different - thread while GP_BackendWait() is blocking) will lock until - GP_BackendWait() returns (i.e. event was recieved). +[WARNING] +Using GP_BackendWait() in multithreaded program will most likely cause +deadlocks. As the backend data structures and connection is guarded by a lock +any other backend function (called from different thread while +GP_BackendWait() is blocking) will lock until GP_BackendWait() returns (i.e. +event was recieved). [source,c] ------------------------------------------------------------------------------- @@ -326,4 +329,4 @@ multithreaded application where one threads waits for events and others draws into the buffer so you can stop the drawing threads before the backend context size change. -See input link:input.html[input events] for more information. +TIP: For more information see link:input.html[input events] documentation. diff --git a/doc/coding_style.txt b/doc/coding_style.txt index 37bb19e..b4afeaf 100644 --- a/doc/coding_style.txt +++ b/doc/coding_style.txt @@ -19,7 +19,7 @@ enligthening reading). * We use tabs for indentation and tab is eight spaces wide. -* Lines should be maximally 80 chars long. +* Lines should be at most 80 chars long. * No additional whitespaces (other than newline) at the end of line. @@ -101,26 +101,26 @@ break; } ---- -TIP: You can use Linux Kernel +scripts/checkpatch.pl+ to check your code. +TIP: You can use Linux Kernel 'scripts/checkpatch.pl' to check your code. GFXprim Specific Rules ^^^^^^^^^^^^^^^^^^^^^^ * Library external API uses CamelCase -** Together with mandatory +GP_+ prefix. -** For example +GP_PixelType+, +GP_Context+, etc. +** Together with mandatory 'GP_' prefix. +** For example 'GP_PixelType', 'GP_Context', etc. ** We will not change that, get over it. (It could have been worse, trust me.) * Basic library types are typedefed -** We have +GP_Size+ and +GP_Coord+ integer types to better distinguish +** We have 'GP_Size' and 'GP_Coord' integer types to better distinguish roles of function parameters. -** The basic structures are also typedefed so you can wite +GP_Context+ - instead of +struct GP_Context+. +** The basic structures are also typedefed so you can wite 'GP_Context' + instead of 'struct GP_Context'. ** Other uses of typedef are frowned upon. -* When you add a externally symbol visible symbol, i.e. new API function - please add its name into the corresponding file at +build/syms/+. You may - also run the +buld/check_symbols.sh+ script to check that you haven't +* When you add an externally visible symbol, i.e. new API function + please add its name into the corresponding file at 'build/syms/'. You may + also run the 'buld/check_symbols.sh' script to check that you haven't accidentally exposed intenal only interfaces. Python Coding Style ----------------------------------------------------------------------- Summary of changes: doc/backends.txt | 27 +++++++++++++++------------ doc/coding_style.txt | 20 ++++++++++---------- 2 files changed, 25 insertions(+), 22 deletions(-) repo.or.cz automatic notification. Contact project admin jiri.bluebear.dluhos@gmail.com if you want to unsubscribe, or site admin admin@repo.or.cz if you receive no reply. -- gfxprim.git ("A simple 2D graphics library with emphasis on correctness and well-defined operation.")