diff doc/build.rst @ 235:fb304a94a05c

rpg: prepare equipment
author David Demelier <markand@malikania.fr>
date Thu, 26 Nov 2020 18:00:45 +0100
parents 081c71d1f723
children
line wrap: on
line diff
--- a/doc/build.rst	Thu Nov 26 13:33:31 2020 +0100
+++ b/doc/build.rst	Thu Nov 26 18:00:45 2020 +0100
@@ -33,24 +33,48 @@
 features from both C versions are required. Here's a list of functionalities
 that are required:
 
-From C99:
+From C99
+^^^^^^^^
+
+Features:
 
 - `Compound literals`_,
-- `stdbool.h`_ header,
-- `snprintf`_ function and friends,
 - `inline`_ keyword.
 
-From C11:
+Headers:
+
+- `stdbool.h`_
+
+Functions:
+
+- `snprintf`_
 
-- `stdnoreturn.h`_ header.
+From C11
+^^^^^^^^
 
-From POSIX:
+- `stdnoreturn.h`_
+
+From POSIX
+^^^^^^^^^^
 
-We use a few parts of POSIX_ specification but try to keep its use limited as
-not all platforms are POSIX compliant.
+Expectations:
+
+- We use a few parts of POSIX_ specification but try to keep its use limited as
+  not all platforms are POSIX compliant.
+- We assume that ``fopen``, ``malloc`` and friends set errno in case of failures.
+
+Functions:
 
-- `getopt(3)`_: to parse arguments,
-- We assume that ``fopen``, ``malloc`` and friends set errno in case of failures.
+- `dirname`_,
+- `getopt`_.
+
+Headers:
+
+- `libgen.h`_
+
+Macros:
+
+- PATH_MAX: in limits.h.
 
 .. note:: When a POSIX requirement isn't present it is replaced by a shim
    specified for the platform.
@@ -65,8 +89,10 @@
 .. _SDL2_ttf: https://www.libsdl.org/projects/SDL_ttf
 .. _brew: https://brew.sh
 .. _cmake: http://cmake.org
-.. _getopt(3): https://pubs.opengroup.org/onlinepubs/9699919799/functions/getopt.html
+.. _dirname: https://pubs.opengroup.org/onlinepubs/9699919799/functions/dirname.html
+.. _getopt: https://pubs.opengroup.org/onlinepubs/9699919799/functions/getopt.html
 .. _inline: https://en.cppreference.com/w/c/language/inline
+.. _libgen.h: https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/libgen.h.html
 .. _snprintf: https://en.cppreference.com/w/c/io/fprintf
 .. _stdbool.h: https://en.cppreference.com/w/c/language/arithmetic_types#Boolean_type
 .. _stdnoreturn.h: https://en.cppreference.com/w/c/types