Commit Graph

60 Commits

Author SHA1 Message Date
wferi
6853eeaea6
doc related fixups (#421)
* Fix documentation typo in qbrb.h

* Fix section number in doxygen2man manual

* Point Doxygen to our examples

* No HTML documentation anymore
2020-09-25 08:52:36 +01:00
Chrissie Caulfield
6d35611524
doxygen2man: Add option to read copyright line from the header file (#415)
* doxygen2man: Add option to read copyright line from the header file

This should help make builds reproducible.

I tried various methods of getting the date, using 'git' is no use as
it could be run from a tarball, using the file date doesn't work either
so this seems a reasonable compromise.

* man: Use SOURCE_EPOCH to make manpage dates reproducible

Also add build-aux/update-copyright.sh to keep header file
copyright lines up-to-date.

All code taken from knet
2020-09-09 15:06:55 +01:00
Christine Caulfield
71a9c8c923 doxygen2man: Tidy RETURN VALUE 2020-07-02 14:04:17 +01:00
Fabio M. Di Nitto
20ff7bcad5
[docs] fix man page distribution (#407)
Signed-off-by: Fabio M. Di Nitto <fdinitto@redhat.com>
2020-06-29 07:33:09 +01:00
Chrissie Caulfield
b19f706144
Make manpages (#405)
* man: Use doxygen2man to make the API manpages

* [build] drop unused target

Signed-off-by: Fabio M. Di Nitto <fdinitto@redhat.com>

* [build] update gitignore

Signed-off-by: Fabio M. Di Nitto <fdinitto@redhat.com>

* [docs] make build -j safe and drop unnecessary dox config files

Signed-off-by: Fabio M. Di Nitto <fdinitto@redhat.com>

* man: Use doxygen2man to generate *.h.3 man pages

so we don't need to use the awful doxygen ones

Co-authored-by: Fabio M. Di Nitto <fdinitto@redhat.com>
2020-06-26 13:03:48 +01:00
wferi
153956c75b Fix comment typo (#296)
* Fix misleading comment on preprocessor conditional
* Fix spelling: plaform -> platform

Signed-off-by: Ferenc Wágner <wferi@debian.org>
2018-03-20 13:12:06 +00:00
Jan Pokorný
37b4e73a27 Typo fix + qb blackbox(8) tweaks and extension + gitignore follow-up (#262)
* Fix typo: occur{ -> r}(ed|ing)

* doc: qb-blackbox(8): cosmetic touches

* doc: qb-blackbox(8): add "Portability notes" subsection

* Low: build: git-ignore build-aux/release.mk "overhead" files
This should have been part of ae5138d.

* build: release.mk: ensure checksum file generated even w/o signing
This should have been part of d20e48a.

Signed-off-by: Jan Pokorný <jpokorny@redhat.com>
2017-08-07 10:21:25 +01:00
Christine Caulfield
536b4c25ed doc: Clarify IPC caution text
It was not clear to non-native English speakers.

Signed-off-by: Christine Caulfield <ccaulfie@redhat.com>
Reviewed by: Jan Pokorný <jpokorny@redhat.com>
2017-05-02 10:29:44 +01:00
Chrissie Caulfield
41a24a3df7 Allow Linux to use filesystem sockets (#248)
* IPC: Allow filesystem sockets to be chosen at run-time on Linux

Most of this patch came from Andrew Beekhof.
Keep a global variable that decides whether or not to use filesystem sockets
or abstract sockets for IPC connections. This variable is set by the presence of a file (default /etc/libqb/force-filesystem-sockets).

* tests: Fix test_ipcc_truncate_when_unlink_fails_shm test using FS sockets

When using filesystem sockets, the
test_ipcc_truncate_when_unlink_fails_shm test always fails, this was
because the unlink() call is wrapped to fail and so it never cleans up
the old version of the socket.
The fix is to preemptively remove the file before unlink gets wrapped.

* doc: Explain the force-filesystem-sockets option

Signed-off-by: Christine Caulfield <ccaulfie@redhat.com>
2017-04-28 16:13:02 +01:00
Christine Caulfield
f38a877889 doc: Remove unclear part of the clarification on IPC threading.
Signed-off-by: Christine Caulfield <ccaulfie@redhat.com>
2017-04-05 09:49:45 +01:00
Christine Caulfield
60122a4a4e doc: clarify thread-safety (or not) in IPC doc
Signed-off-by: Christine Caulfield <ccaulfie@redhat.com>
2017-03-24 13:44:17 +00:00
Jan Pokorný
85b82bd615
build: ensure debug make flags are not derived when unsuitable
Unfortunately, debug messages of GNU make are emitted to stdout, which
spoils the extracted output we rely on.  So prevent it (as well as
any other extraneous option) by force.

(discovered during git -> automatic COPR builds integration)
2016-11-18 23:29:07 +01:00
Jan Pokorný
617730b3ed
doc: elaborate more on thread safety as it's not so pure 2016-10-17 18:25:03 +02:00
Jan Pokorný
3ed7c63aef
docs: fix "make doxygen" target not generating anything 2016-03-17 20:33:30 +01:00
Jan Pokorný
4c4ac25cc9
docs: *.dox.in: comment out the defaults/empty values
This should also silent most of the warning when using older doxygen
to compile the docs.
2016-03-17 13:30:23 +01:00
Jan Pokorný
4393322950
docs: common.dox: use symbolic PROJECT_NAME 2016-03-17 13:29:50 +01:00
Jan Pokorný
464817579e
docs: {html,man}.dox.in: extract common parts to common.dox 2016-03-17 13:29:28 +01:00
Jan Pokorný
cd39a021f4
docs: {html,man}.dox.in: unify where reasonable 2016-03-17 13:27:44 +01:00
Jan Pokorný
ecdf33cf7c
docs: {html,man}.dox.in: strip options for unused outputs 2016-03-17 13:27:18 +01:00
Jan Pokorný
bc96571cd7
docs: apply "doxygen -u" on {html,man}.dox.in, fix deprecations
Previously, "make" in the top-level dir resulted in:

> doxygen man.dox
> warning: Tag `XML_SCHEMA' at line 1787 of file `man.dox' has become
>          obsolete.
>          To avoid this warning please remove this line from your
>          configuration file or upgrade it using "doxygen -u"
> warning: Tag `XML_DTD' at line 1793 of file `man.dox' has become
>          obsolete.

Reference doxygen version: doxygen-1.8.10-6.fc22.x86_64.

This is to serve as a reference full-blown versions only to be
subsequently compacted...
2016-03-17 13:26:58 +01:00
Jan Pokorný
63dc43bb79
build: docs: {dependent -> public}_headers + more robust obtaining 2016-03-10 21:11:01 +01:00
Jan Pokorný
2468e46a56
build: extra clean-local rule instead of overriding clean-generic
Previously, stuffing CLEANFILES with anything would not work in the
affected files.
2016-03-10 21:06:29 +01:00
Jan Pokorný
b69c74357f
build: fix out-of-tree build broken with 0b04ed5 (#184)
Generating the man pages definitely doesn't depend on existence of
(possibly generated) header files that we omit anyway.
2016-03-10 16:37:16 +01:00
Jan Pokorný
4df20fbb53
build: fix man3 pages not installed
Issue with original version of the patch spotted by Chrissie (thanks).
2016-02-22 14:50:37 +01:00
Jan Pokorný
792c34bf6b
build: header-based man pages: include also qbdefs.h+qbrb.h
No reason not to do that.  Situation with qbconfig.h is a bit more
complicated as this file gets generated from .in file and there is
currently no reliable inter-dir/makefile (siblings) targets
dependency tracking in place, AFAICT.
2016-02-18 19:04:48 +01:00
Jan Pokorný
cf1588c6ec
build: header-based man pages: dependent_headers - blacklist
IOW, make tracking of interfaces to document via man pages maintainable.
2016-02-18 18:56:54 +01:00
Jan Pokorný
0b04ed5e77
build: grab "dependent_headers" from respective Makefile.am
...with "echo path/*.h" fallback (equivalent of wildcard function) if
the new methods fails for some reason.
2016-02-18 18:33:14 +01:00
Jan Pokorný
cabe021d47
build: fix "dependant" typo 2016-02-18 18:28:03 +01:00
Jan Pokorný
fdbb80a87b
doc: IPC overview: fix typos 2016-02-16 17:49:01 +01:00
Jan Pokorný
3ef3ae434f
doc: main overview: fix style + reword per spec file 2016-02-16 17:48:35 +01:00
Ken Gaillot
6957f24738 docs: update doxygen files
These are the results of "doxygen -u" to get rid of warnings.
2015-09-09 15:54:29 -05:00
Ferenc Wágner
fcc9d5e8bd Clear DOT_FONTNAME, since FreeSans is not included anymore
The new default is Helvetica.
2015-04-20 16:12:55 +02:00
Ferenc Wágner
9e0eb16682 Remove obsolete options from doxyfiles
The SYMBOL_CACHE_SIZE, HTML_ALIGN_MEMBERS and USE_INLINE_TREES options
were at their default values, so it is safe to remove them now that they
only generate warnings.
2015-04-20 16:12:54 +02:00
Ferenc Wágner
5a140cea38 Do not suppress echoing of Doxygen commands
This makes fixing Doxygen warnings easier.
2015-04-20 16:12:50 +02:00
Angus Salkeld
a6797c5c19 docs: install qb-blackbox.8 if doxygen is not available.
fixes bug #54

Signed-off-by: Angus Salkeld <asalkeld@redhat.com>
2013-02-13 15:45:40 +11:00
Angus Salkeld
59bdedf59b Upgrade the doxygen config.
The new doxygen says SHOW_DIRECTORIES is deprecated.

Signed-off-by: Angus Salkeld <asalkeld@redhat.com>
2012-07-14 22:30:24 +10:00
Angus Salkeld
70a9623a48 Remove message queues
Signed-off-by: Angus Salkeld <asalkeld@redhat.com>
2012-05-28 13:41:04 +10:00
Angus Salkeld
c41f2c93a0 Add a tool to dump the blackbox.
Signed-off-by: Angus Salkeld <asalkeld@redhat.com>
2012-05-28 11:16:00 +10:00
Angus Salkeld
dfe624f5a9 examples: add ipc client/server
Signed-off-by: Angus Salkeld <asalkeld@redhat.com>
2011-10-23 22:40:26 +11:00
Angus Salkeld
94767b18b8 Initial map using either a skiplist or a hashtable
Signed-off-by: Angus Salkeld <asalkeld@redhat.com>
2011-08-22 14:11:43 +10:00
Angus Salkeld
835eefeff8 docs: add utils to the mainpage
Signed-off-by: Angus Salkeld <asalkeld@redhat.com>
2011-08-22 13:27:51 +10:00
Angus Salkeld
04b76a0f27 LOG: fix make install and distcheck
Signed-off-by: Angus Salkeld <asalkeld@redhat.com>
2011-03-28 12:25:06 +11:00
Angus Salkeld
fcf4ddfd59 LOG: improve the doxygen overview.
Signed-off-by: Angus Salkeld <asalkeld@redhat.com>
2011-03-27 21:56:59 +11:00
Angus Salkeld
e910f8bc18 Add logging infrastructure.
Signed-off-by: Angus Salkeld <asalkeld@redhat.com>
2011-03-25 23:34:12 +11:00
Angus Salkeld
28ff1546ba DOCS: set the version from a configure variable
Signed-off-by: Angus Salkeld <asalkeld@redhat.com>
2010-12-13 15:51:47 +11:00
Angus Salkeld
f0efc457db DOCS: add some doxygen comments to array & hdb.
Signed-off-by: Angus Salkeld <asalkeld@redhat.com>
2010-10-19 08:59:51 +11:00
Angus Salkeld
9745d4feb7 Add a resizable array that doesn't move memory.
Signed-off-by: Angus Salkeld <asalkeld@redhat.com>
2010-10-19 07:05:54 +11:00
Angus Salkeld
e7b46822d5 ATOMIC: fix make distcheck
Signed-off-by: Angus Salkeld <asalkeld@redhat.com>
2010-10-19 07:05:54 +11:00
Angus Salkeld
43d8b36518 Add atomic operations.
This was initially copied from glib. How ever I have
simplified it to only support proper atomic operations
with gcc builtin __sync calls. The backup is pthread_spin_lock().
I have also obviously namespaced the code to qb_.

Signed-off-by: Angus Salkeld <asalkeld@redhat.com>
2010-10-18 11:24:07 +11:00
Angus Salkeld
47443a5b63 DOCS: do some work on the doxygen output.
Signed-off-by: Angus Salkeld <asalkeld@redhat.com>
2010-10-17 19:31:24 +11:00