diff --git a/.gitignore b/.gitignore index 5ea0c648e..8419b131e 100644 --- a/.gitignore +++ b/.gitignore @@ -21,9 +21,12 @@ configure /m4/* !/m4/ax_*.m4 +# build-aux/release.mk related litter +/.tarball-version +/tag-* + libtool .version -.tarball-version libqb.spec libqb-* cov diff --git a/build-aux/release.mk b/build-aux/release.mk index 3f1b1f924..d4d195b3c 100644 --- a/build-aux/release.mk +++ b/build-aux/release.mk @@ -66,7 +66,7 @@ $(project)-$(version).sha256: .PHONY: sign ifeq (,$(gpgsignkey)) -sign: tarballs +sign: $(deliverables) @echo No GPG signing key defined else sign: $(deliverables:=.asc) diff --git a/docs/man8/qb-blackbox.8 b/docs/man8/qb-blackbox.8 index 976848cc7..3df924d25 100644 --- a/docs/man8/qb-blackbox.8 +++ b/docs/man8/qb-blackbox.8 @@ -18,14 +18,22 @@ .\" * You should have received a copy of the GNU Lesser General Public License .\" * along with libqb. If not, see . .\" */ -.TH QB-BLACKBOX 8 2012-05-28 +.TH QB-BLACKBOX 8 2017-07-27 .SH NAME qb-blackbox \- Display "flight data" from the "blackbox". .SH SYNOPSIS -.B "qb-blackbox ..." +\fBqb-blackbox\fR [\fIblackbox-file\fR...] .SH DESCRIPTION -.B qb-blackbox -Print out the logs (including debug logs) that were recorded using libqb's blackbox. +\fBqb-blackbox\fR prints out the logs (including debug logs) that were +recorded using libqb's blackbox mechanism. +.SS Portability notes +Due to variations amongst platforms, some of which directly impact +the libqb's blackbox format handling (e.g. page size), there's currently +only the commitment that \fBqb-blackbox\fR shall decode the blackbox files +recorded at the same plaform (plus the same page size) while using libqb +compiled with the same relevant compile-time options +(e.g. \fBUSE_CACHE_LINE_ALIGNMENT\fR) as linked to this decoder. +Otherwise, your mileage may vary. .SH EXAMPLES .TP Get info to help developers diagnose a crash. @@ -53,7 +61,7 @@ Mar 23 20:58:57 member_object_joined():301 Member joined: r(0) ip(192.168.122.1) Mar 23 20:58:57 sync_abort():594 ENTERING sync_abort() .br .SH SEE ALSO -.BR qblog.h (3), +.BR qblog.h (3) .SH AUTHOR Angus Salkeld .PP diff --git a/include/qb/qbloop.h b/include/qb/qbloop.h index ff5a7d263..6bded75bb 100644 --- a/include/qb/qbloop.h +++ b/include/qb/qbloop.h @@ -189,7 +189,7 @@ int32_t qb_loop_poll_low_fds_event_set(qb_loop_t *l, /** * Add a poll job to the mainloop. - * @note it is a re-occuring job. + * @note it is a re-occurring job. * * @param l pointer to the loop instance * @param p the priority diff --git a/include/qb/qbrb.h b/include/qb/qbrb.h index 6a51d7308..cde793d48 100644 --- a/include/qb/qbrb.h +++ b/include/qb/qbrb.h @@ -171,7 +171,7 @@ ssize_t qb_rb_chunk_write(qb_ringbuffer_t * rb, const void *data, size_t len); * Allocate space for a chunk of the given size. * * If type == QB_RB_FLAG_OVERWRITE and NULL is returned, memory corruption of - * the memory file has occured. The ringbuffer should be destroyed. + * the memory file has occurred. The ringbuffer should be destroyed. * If type == QB_RB_NORMAL then when there is not enough space it will * return NULL. *