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>
This commit is contained in:
Jan Pokorný 2017-08-07 11:21:25 +02:00 committed by Chrissie Caulfield
parent 1fa701489a
commit 37b4e73a27
5 changed files with 20 additions and 9 deletions

5
.gitignore vendored
View File

@ -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

View File

@ -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)

View File

@ -18,14 +18,22 @@
.\" * You should have received a copy of the GNU Lesser General Public License
.\" * along with libqb. If not, see <http://www.gnu.org/licenses/>.
.\" */
.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 <blackbox files>..."
\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

View File

@ -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

View File

@ -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.
*