Document barectf 3
authorPhilippe Proulx <eeppeliteloop@gmail.com>
Thu, 24 Sep 2020 00:01:30 +0000 (20:01 -0400)
committerPhilippe Proulx <eeppeliteloop@gmail.com>
Thu, 24 Sep 2020 03:04:40 +0000 (23:04 -0400)
commit016a4d971883775693f30570419b85358a1a63d0
tree492a35f4677beac69a166b38ce73ffbb573b52bc
parent6412698ccd98ee71eb492c77ef224ac7f35251b1
Document barectf 3

This patch adds the complete documentation of barectf 3 (upcoming major
release of the project).

The new `docs` directory is an Antora [1] documentation component
version. You can include it in an Antora site.

All the pages are written in AsciiDoc (Asciidoctor version).

Some contents were copied (and adapted) from the barectf wiki [2], but
most of the pages feature brand new text. The logo and diagrams are also
refreshed.

I'm removing the `barectf` CLI tool's manual page (`doc/man`) as it's
now documented in `docs/modules/cli/pages/usage.adoc`. Having the CLI
documented within the whole project's documentation makes it possible to
have critical links to and from other parts of it. This is to the
advantage of the reader.

[1]: https://antora.org/
[2]: https://github.com/efficios/barectf/wiki
56 files changed:
.gitignore
doc/man/.gitignore [deleted file]
doc/man/Makefile [deleted file]
doc/man/asciidoc.conf [deleted file]
doc/man/barectf.1 [deleted file]
doc/man/barectf.1.txt [deleted file]
doc/man/xsl/manpage-bold-literal.xsl [deleted file]
doc/man/xsl/manpage-callouts.xsl [deleted file]
doc/man/xsl/manpage-links.xsl [deleted file]
doc/man/xsl/manpage.xsl [deleted file]
docs/antora.yml [new file with mode: 0644]
docs/modules/ROOT/images/barectf-logo.svg [new file with mode: 0644]
docs/modules/ROOT/images/getting-started-trace-compass.png [new file with mode: 0644]
docs/modules/ROOT/nav.adoc [new file with mode: 0644]
docs/modules/ROOT/pages/get-help.adoc [new file with mode: 0644]
docs/modules/ROOT/pages/getting-started.adoc [new file with mode: 0644]
docs/modules/ROOT/pages/index.adoc [new file with mode: 0644]
docs/modules/ROOT/pages/install.adoc [new file with mode: 0644]
docs/modules/ROOT/pages/whats-new.adoc [new file with mode: 0644]
docs/modules/ROOT/partials/def-prefix-note.adoc [new file with mode: 0644]
docs/modules/cli/pages/index.adoc [new file with mode: 0644]
docs/modules/cli/pages/usage.adoc [new file with mode: 0644]
docs/modules/how-barectf-works/images/barectf-data-flow.svg [new file with mode: 0644]
docs/modules/how-barectf-works/images/ctf-data-stream.svg [new file with mode: 0644]
docs/modules/how-barectf-works/images/ctf-event-record.svg [new file with mode: 0644]
docs/modules/how-barectf-works/images/ctf-overview.svg [new file with mode: 0644]
docs/modules/how-barectf-works/images/ctf-packet.svg [new file with mode: 0644]
docs/modules/how-barectf-works/images/ctf-trace.svg [new file with mode: 0644]
docs/modules/how-barectf-works/pages/ctf-primer.adoc [new file with mode: 0644]
docs/modules/how-barectf-works/pages/index.adoc [new file with mode: 0644]
docs/modules/platform/pages/api.adoc [new file with mode: 0644]
docs/modules/platform/pages/example.adoc [new file with mode: 0644]
docs/modules/platform/pages/index.adoc [new file with mode: 0644]
docs/modules/tracing-funcs/pages/index.adoc [new file with mode: 0644]
docs/modules/yaml/pages/cfg-obj.adoc [new file with mode: 0644]
docs/modules/yaml/pages/clk-type-obj.adoc [new file with mode: 0644]
docs/modules/yaml/pages/common-values.adoc [new file with mode: 0644]
docs/modules/yaml/pages/dst-obj.adoc [new file with mode: 0644]
docs/modules/yaml/pages/dyn-array-ft-obj.adoc [new file with mode: 0644]
docs/modules/yaml/pages/enum-ft-obj.adoc [new file with mode: 0644]
docs/modules/yaml/pages/ert-obj.adoc [new file with mode: 0644]
docs/modules/yaml/pages/ft-obj.adoc [new file with mode: 0644]
docs/modules/yaml/pages/include.adoc [new file with mode: 0644]
docs/modules/yaml/pages/index.adoc [new file with mode: 0644]
docs/modules/yaml/pages/int-ft-obj.adoc [new file with mode: 0644]
docs/modules/yaml/pages/real-ft-obj.adoc [new file with mode: 0644]
docs/modules/yaml/pages/static-array-ft-obj.adoc [new file with mode: 0644]
docs/modules/yaml/pages/str-ft-obj.adoc [new file with mode: 0644]
docs/modules/yaml/pages/struct-ft-obj.adoc [new file with mode: 0644]
docs/modules/yaml/pages/trace-obj.adoc [new file with mode: 0644]
docs/modules/yaml/pages/trace-type-obj.adoc [new file with mode: 0644]
docs/modules/yaml/pages/yaml-primer.adoc [new file with mode: 0644]
docs/modules/yaml/partials/ft-obj-inherit-prop.adoc [new file with mode: 0644]
docs/modules/yaml/partials/int-ft-obj-base-props.adoc [new file with mode: 0644]
docs/modules/yaml/partials/int-ft-obj-c-types-table.adoc [new file with mode: 0644]
docs/modules/yaml/partials/patching-rules-table.adoc [new file with mode: 0644]
This page took 0.027473 seconds and 4 git commands to generate.