aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMattias Andrée <maandree@operamail.com>2015-08-25 22:19:53 +0200
committerMattias Andrée <maandree@operamail.com>2015-08-25 22:19:53 +0200
commit7f4e3178a56b33d7efd07b2356c256696dd6e730 (patch)
tree88e59e8504766945d8b425f0c7a4ace264f90906 /doc
parentadd pkg-config files and soname to libs and versioned so files (diff)
downloadmds-7f4e3178a56b33d7efd07b2356c256696dd6e730.tar.gz
mds-7f4e3178a56b33d7efd07b2356c256696dd6e730.tar.bz2
mds-7f4e3178a56b33d7efd07b2356c256696dd6e730.tar.xz
info: libmdsclient: prefix and inclusion-guards
Signed-off-by: Mattias Andrée <maandree@operamail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/info/mds.texinfo10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/info/mds.texinfo b/doc/info/mds.texinfo
index aa39942..88edf7f 100644
--- a/doc/info/mds.texinfo
+++ b/doc/info/mds.texinfo
@@ -8674,6 +8674,16 @@ all libmdsclient headers; you may cherrypick them if
you so choose. When compiling and linking your programs,
use the @command{pkg-config} package @code{libmdsclient}.
+Definitions@footnote{Structures, unions, enumerations,
+type-definitions, functions, macros and variables.} in
+libmdsclients use the prefixes @code{libmds_} and
+@code{LIBMDS_}@footnote{@code{LIBMDS_} is reserved for
+macros, but function-like macros and lvalue-macros use
+@code{libmds_}.}, rather than @code{libmdsclient_} and
+@code{LIBMDSCLIENT_}. This is to make the identifiers
+shorter. Inclusion-guards are formatted
+@code{MDS_LIBMDSCLIENT_*_H}.
+
@node libmdslltk