Update `CONTRIBUTING.adoc`
authorPhilippe Proulx <eeppeliteloop@gmail.com>
Sat, 15 Jun 2019 18:08:28 +0000 (14:08 -0400)
committerJérémie Galarneau <jeremie.galarneau@efficios.com>
Thu, 20 Jun 2019 18:51:59 +0000 (14:51 -0400)
commit7715df7ba83e6b3be83ae96e71ed196e5ce8802f
tree8c979bedb403de9cecfd9c9cb06add66b64456d5
parentaa2ab94c01ff6cf53ab9c4e1d41c4c4f2055d62a
Update `CONTRIBUTING.adoc`

Changes:

* Change to Asciidoctor format. This is what GitHub uses, so this guide
  is correctly converted on GitHub.

* Update reference count section's terminology and function names.

* Update logging section:

  * Reorganize sections, making guides explicit.

  * Header paths.

  * More details about the available log levels.

  * Library-specific logging statement macros (more or less copied from
    `src/lib/logging.h`).

  * Component-specific logging statement macros.

  * Have clear guides on how to instrument generic, library, and
    component class C source and header file

  * More details about which log level to choose.

  * More details about which logging tag to choose.

Removing the `CONTRIBUTING.html` global Makefile target as we cannot
use Asciidoc to build `CONTRIBUTING.adoc` anymore.

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I98effa1fb087274c453014d95115d471b5b115ad
Reviewed-on: https://review.lttng.org/c/babeltrace/+/1446
Reviewed-by: Francis Deslauriers <francis.deslauriers@efficios.com>
CONTRIBUTING.adoc
Makefile.am
This page took 0.030674 seconds and 4 git commands to generate.