Convert documentation to AsciiDoc
authorPhilippe Proulx <eeppeliteloop@gmail.com>
Thu, 26 May 2016 22:23:52 +0000 (18:23 -0400)
committerPhilippe Proulx <eeppeliteloop@gmail.com>
Thu, 27 Oct 2016 08:41:33 +0000 (04:41 -0400)
commitf0287ae19ba24983cb17b0614879195ffd051e77
treef80fbdf14c5dc128b66cc5837c806611839c1cc0
parentce42e1818dc493540c735143e73495cb78f3ea28
Convert documentation to AsciiDoc

This huge patch converts the LTTng Documentation sources to the
AsciiDoc format. A few advantages of this move are:

* The AsciiDoc language is much more complete and semantically
  correct than Markdown (or even kramdown). Labeled lists,
  source file inclusion, admonition blocks, custom block and
  inline elements, and complex table layouts are just a few
  of the many features that Markdown lacks and which are needed
  for a high quality technical documentation. The previous
  solution to have those features was to embed HTML elements in
  the Markdown source files, which is a bad idea for an
  appropriate separation of presentation and content.
* The asciidoc(1) tool can convert an AsciiDoc input file to
  a DocBook XML file, making it possible to render the LTTng
  Documentation in any desired format thanks to XSLT and/or
  custom scripts.
* The asciidoc(1) tool can also convert an AsciiDoc input file
  to an HTML5 file, so that the LTTng Documentation can be
  previewed by anyone with tools that are available for all
  the major distributions.

The actual content of the documentation is also completely altered
here. A major overhaul was necessary after two years of untouched
content. The text of v2.7 now follows the Microsoft Manual of Style
(4th Edition), as it is clearly stated in the new
CONTRIBUTING.adoc file. Various improvements are introduced to this
documentation, including:

* Diagrams are redesigned and updated, and new diagrams are
  added.
* The "What's new" section presents the new features as categorized
  lists instead of flat paragraphs.
* The "What is tracing?" section was proofread by a professional.
* LTTng alternatives are added.
* More tables are used.
* New LTTng availability in major distributions.
* Clear examples.
* New glossary section.

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
190 files changed:
.gitignore [new file with mode: 0644]
2.5/images/export/core-concepts.png [new file with mode: 0644]
2.5/images/export/lttng-live-relayd.png [new file with mode: 0644]
2.5/images/export/lttng-lttng-gen-tp.png [new file with mode: 0644]
2.5/images/export/plumbing.png [new file with mode: 0644]
2.5/images/src/core-concepts [new file with mode: 0644]
2.5/images/src/getting-started-lttng-gen-tp [new file with mode: 0644]
2.5/images/src/lttng-live-relayd [new file with mode: 0644]
2.5/images/src/plumbing [new file with mode: 0644]
2.5/lttng-docs-2.5.txt [new file with mode: 0644]
2.6/images/export/concepts.png [new file with mode: 0644]
2.6/images/export/lttng-live.png [new file with mode: 0644]
2.6/images/export/many-sessions.png [new file with mode: 0644]
2.6/images/export/plumbing-26.png [new file with mode: 0644]
2.6/images/export/ust-flow.png [new file with mode: 0644]
2.6/lttng-docs-2.6.txt [new file with mode: 0644]
2.7/images/export/concepts.png [new file with mode: 0644]
2.7/images/export/event-rule.png [new file with mode: 0644]
2.7/images/export/java-app.png [new file with mode: 0644]
2.7/images/export/live.png [new file with mode: 0644]
2.7/images/export/lttng-logger.png [new file with mode: 0644]
2.7/images/export/many-sessions.png [new file with mode: 0644]
2.7/images/export/per-process-buffering.png [new file with mode: 0644]
2.7/images/export/per-user-buffering.png [new file with mode: 0644]
2.7/images/export/plumbing-consumerd.png [new file with mode: 0644]
2.7/images/export/plumbing-liblttng-ctl.png [new file with mode: 0644]
2.7/images/export/plumbing-liblttng-ust.png [new file with mode: 0644]
2.7/images/export/plumbing-lttng-cli.png [new file with mode: 0644]
2.7/images/export/plumbing-lttng-modules.png [new file with mode: 0644]
2.7/images/export/plumbing-lttng-ust-agents.png [new file with mode: 0644]
2.7/images/export/plumbing-relayd.png [new file with mode: 0644]
2.7/images/export/plumbing-sessiond.png [new file with mode: 0644]
2.7/images/export/plumbing.png [new file with mode: 0644]
2.7/images/export/python-app.png [new file with mode: 0644]
2.7/images/export/track-1-3-4-7-10-13-15-16.png [new file with mode: 0644]
2.7/images/export/track-1-4-15-16.png [new file with mode: 0644]
2.7/images/export/track-3-4-7-10-13.png [new file with mode: 0644]
2.7/images/export/track-6-11.png [new file with mode: 0644]
2.7/images/export/track-all.png [new file with mode: 0644]
2.7/images/export/untrack-all.png [new file with mode: 0644]
2.7/images/export/ust-app.png [new file with mode: 0644]
2.7/images/export/ust-flow.png [new file with mode: 0644]
2.7/images/export/ust-sit+app-dlopens-lib+lib-dlopens-tp-so+lib-instrumented.png [new file with mode: 0644]
2.7/images/export/ust-sit+app-dlopens-lib+lib-linked-with-tp-so+lib-instrumented.png [new file with mode: 0644]
2.7/images/export/ust-sit+app-dlopens-tp-so+app-instrumented.png [new file with mode: 0644]
2.7/images/export/ust-sit+app-linked-with-lib+lib-dlopens-tp-so+lib-instrumented.png [new file with mode: 0644]
2.7/images/export/ust-sit+app-linked-with-lib+lib-linked-with-tp-o+lib-instrumented.png [new file with mode: 0644]
2.7/images/export/ust-sit+app-linked-with-lib+lib-linked-with-tp-so+lib-instrumented.png [new file with mode: 0644]
2.7/images/export/ust-sit+app-linked-with-tp-a+app-instrumented.png [new file with mode: 0644]
2.7/images/export/ust-sit+app-linked-with-tp-o+app-dlopens-lib+lib-instrumented.png [new file with mode: 0644]
2.7/images/export/ust-sit+app-linked-with-tp-o+app-instrumented.png [new file with mode: 0644]
2.7/images/export/ust-sit+app-linked-with-tp-o+app-linked-with-lib+lib-instrumented.png [new file with mode: 0644]
2.7/images/export/ust-sit+app-linked-with-tp-so+app-instrumented.png [new file with mode: 0644]
2.7/images/export/ust-sit+tp-so-preloaded+app-dlopens-lib+lib-instrumented.png [new file with mode: 0644]
2.7/images/export/ust-sit+tp-so-preloaded+app-instrumented.png [new file with mode: 0644]
2.7/images/export/ust-sit+tp-so-preloaded+app-linked-with-lib+lib-instrumented.png [new file with mode: 0644]
2.7/lttng-docs-2.7.txt [new file with mode: 0644]
CONTRIBUTING.adoc [new file with mode: 0644]
CONTRIBUTING.md [deleted file]
Makefile [new file with mode: 0644]
README.adoc [new file with mode: 0644]
README.md [deleted file]
asciidoc.html5.conf [new file with mode: 0644]
common/acknowledgements.txt [new file with mode: 0644]
common/audience.txt [new file with mode: 0644]
common/convention.txt [new file with mode: 0644]
common/copyright.txt [new file with mode: 0644]
common/ust-sit-step-tp-o-fpic.txt [new file with mode: 0644]
common/ust-sit-step-tp-o.txt [new file with mode: 0644]
common/ust-sit-step-tp-so.txt [new file with mode: 0644]
common/warning-not-maintained.txt [new file with mode: 0644]
common/welcome.txt [new file with mode: 0644]
contents/getting-started/intro.md [deleted file]
contents/getting-started/tracing-the-linux-kernel.md [deleted file]
contents/getting-started/tracing-your-own-user-application.md [deleted file]
contents/getting-started/viewing-and-analyzing.md [deleted file]
contents/installing-lttng/building-from-source.md [deleted file]
contents/installing-lttng/desktop-distributions/archlinux.md [deleted file]
contents/installing-lttng/desktop-distributions/debian.md [deleted file]
contents/installing-lttng/desktop-distributions/intro.md [deleted file]
contents/installing-lttng/desktop-distributions/opensuse.md [deleted file]
contents/installing-lttng/desktop-distributions/ubuntu/intro.md [deleted file]
contents/installing-lttng/desktop-distributions/ubuntu/official-repositories.md [deleted file]
contents/installing-lttng/desktop-distributions/ubuntu/ppa.md [deleted file]
contents/installing-lttng/enterprise.md [deleted file]
contents/installing-lttng/intro.md [deleted file]
contents/nuts-and-bolts/intro.md [deleted file]
contents/nuts-and-bolts/lttng-alternatives.md [deleted file]
contents/nuts-and-bolts/what-is-tracing.md [deleted file]
contents/preface.md [deleted file]
contents/reference/intro.md [deleted file]
contents/reference/lttng-modules/intro.md [deleted file]
contents/reference/lttng-modules/lttng-modules-tp-fields.md [deleted file]
contents/reference/lttng-ust/intro.md [deleted file]
contents/reference/lttng-ust/liblttng-ust/intro.md [deleted file]
contents/reference/lttng-ust/liblttng-ust/liblttng-ust-tp-fields.md [deleted file]
contents/reference/lttng-ust/liblttng-ust/liblttng-ust-tracepoint-loglevel.md [deleted file]
contents/reference/online-manpages.md [deleted file]
contents/understanding-lttng/core-concepts/channel/channel-buffering-schemes.md [deleted file]
contents/understanding-lttng/core-concepts/channel/channel-overwrite-mode-vs-discard-mode.md [deleted file]
contents/understanding-lttng/core-concepts/channel/channel-subbuf-size-vs-subbuf-count.md [deleted file]
contents/understanding-lttng/core-concepts/channel/channel-timers.md [deleted file]
contents/understanding-lttng/core-concepts/channel/intro.md [deleted file]
contents/understanding-lttng/core-concepts/domain.md [deleted file]
contents/understanding-lttng/core-concepts/event.md [deleted file]
contents/understanding-lttng/core-concepts/intro.md [deleted file]
contents/understanding-lttng/core-concepts/tracing-session.md [deleted file]
contents/understanding-lttng/intro.md [deleted file]
contents/understanding-lttng/plumbing/intro.md [deleted file]
contents/understanding-lttng/plumbing/liblttng-ctl-lttng.md [deleted file]
contents/understanding-lttng/plumbing/lttng-consumerd.md [deleted file]
contents/understanding-lttng/plumbing/lttng-modules.md [deleted file]
contents/understanding-lttng/plumbing/lttng-relayd.md [deleted file]
contents/understanding-lttng/plumbing/lttng-sessiond.md [deleted file]
contents/understanding-lttng/plumbing/lttng-ust.md [deleted file]
contents/understanding-lttng/plumbing/overview.md [deleted file]
contents/using-lttng/controlling-tracing/adding-context.md [deleted file]
contents/using-lttng/controlling-tracing/basic-tracing-session-control.md [deleted file]
contents/using-lttng/controlling-tracing/creating-destroying-tracing-sessions.md [deleted file]
contents/using-lttng/controlling-tracing/enabling-disabling-channels/fine-tuning-channels.md [deleted file]
contents/using-lttng/controlling-tracing/enabling-disabling-channels/intro.md [deleted file]
contents/using-lttng/controlling-tracing/enabling-disabling-events.md [deleted file]
contents/using-lttng/controlling-tracing/intro.md [deleted file]
contents/using-lttng/controlling-tracing/lttng-live.md [deleted file]
contents/using-lttng/controlling-tracing/mi.md [deleted file]
contents/using-lttng/controlling-tracing/persistent-memory-file-systems.md [deleted file]
contents/using-lttng/controlling-tracing/pid-tracking.md [deleted file]
contents/using-lttng/controlling-tracing/saving-loading-tracing-session.md [deleted file]
contents/using-lttng/controlling-tracing/sending-trace-data-over-the-network.md [deleted file]
contents/using-lttng/controlling-tracing/taking-a-snapshot.md [deleted file]
contents/using-lttng/instrumenting/advanced-techniques/32-bit-on-64-bit/building-32-bit-lttng-tools.md [deleted file]
contents/using-lttng/instrumenting/advanced-techniques/32-bit-on-64-bit/building-32-bit-lttng-ust.md [deleted file]
contents/using-lttng/instrumenting/advanced-techniques/32-bit-on-64-bit/building-32-bit-userspace-rcu.md [deleted file]
contents/using-lttng/instrumenting/advanced-techniques/32-bit-on-64-bit/building-64-bit-lttng-tools.md [deleted file]
contents/using-lttng/instrumenting/advanced-techniques/32-bit-on-64-bit/building-instrumented-32-bit-c-application.md [deleted file]
contents/using-lttng/instrumenting/advanced-techniques/32-bit-on-64-bit/intro.md [deleted file]
contents/using-lttng/instrumenting/advanced-techniques/32-bit-on-64-bit/running-32-bit-and-64-bit-c-applications.md [deleted file]
contents/using-lttng/instrumenting/advanced-techniques/intro.md [deleted file]
contents/using-lttng/instrumenting/c-application/assigning-log-levels.md [deleted file]
contents/using-lttng/instrumenting/c-application/building-linking/dynamic-linking.md [deleted file]
contents/using-lttng/instrumenting/c-application/building-linking/intro.md [deleted file]
contents/using-lttng/instrumenting/c-application/building-linking/lttng-ust-pkg-config.md [deleted file]
contents/using-lttng/instrumenting/c-application/building-linking/static-linking.md [deleted file]
contents/using-lttng/instrumenting/c-application/building-linking/using-lttng-ust-with-daemons.md [deleted file]
contents/using-lttng/instrumenting/c-application/defining-tracepoints.md [deleted file]
contents/using-lttng/instrumenting/c-application/intro.md [deleted file]
contents/using-lttng/instrumenting/c-application/lttng-gen-tp.md [deleted file]
contents/using-lttng/instrumenting/c-application/lttng-ust-environment-variables-compiler-flags.md [deleted file]
contents/using-lttng/instrumenting/c-application/probing-the-application-source-code.md [deleted file]
contents/using-lttng/instrumenting/c-application/tracef.md [deleted file]
contents/using-lttng/instrumenting/c-application/tracelog.md [deleted file]
contents/using-lttng/instrumenting/c-application/tracepoint-provider.md [deleted file]
contents/using-lttng/instrumenting/c-application/using-tracepoint-classes.md [deleted file]
contents/using-lttng/instrumenting/cxx-application.md [deleted file]
contents/using-lttng/instrumenting/instrumenting-linux-kernel/instrumenting-linux-kernel-itself/instrumenting-linux-kernel-tracing.md [deleted file]
contents/using-lttng/instrumenting/instrumenting-linux-kernel/instrumenting-linux-kernel-itself/intro.md [deleted file]
contents/using-lttng/instrumenting/instrumenting-linux-kernel/instrumenting-linux-kernel-itself/lttng-adaptation-layer.md [deleted file]
contents/using-lttng/instrumenting/instrumenting-linux-kernel/instrumenting-linux-kernel-itself/lttng-tracepoint-event-code.md [deleted file]
contents/using-lttng/instrumenting/instrumenting-linux-kernel/instrumenting-linux-kernel-itself/mainline-trace-event.md [deleted file]
contents/using-lttng/instrumenting/instrumenting-linux-kernel/instrumenting-out-of-tree-linux-kernel.md [deleted file]
contents/using-lttng/instrumenting/instrumenting-linux-kernel/intro.md [deleted file]
contents/using-lttng/instrumenting/intro.md [deleted file]
contents/using-lttng/instrumenting/java-application/intro.md [deleted file]
contents/using-lttng/instrumenting/java-application/jul.md [deleted file]
contents/using-lttng/instrumenting/java-application/log4j.md [deleted file]
contents/using-lttng/instrumenting/prebuilt-ust-helpers/intro.md [deleted file]
contents/using-lttng/instrumenting/prebuilt-ust-helpers/liblttng-ust-cyg-profile.md [deleted file]
contents/using-lttng/instrumenting/prebuilt-ust-helpers/liblttng-ust-dl.md [deleted file]
contents/using-lttng/instrumenting/prebuilt-ust-helpers/liblttng-ust-libc-pthread-wrapper.md [deleted file]
contents/using-lttng/instrumenting/proc-lttng-logger-abi.md [deleted file]
contents/using-lttng/instrumenting/python-application.md [deleted file]
contents/using-lttng/intro.md [deleted file]
contents/whats-new.md [deleted file]
images/export/concepts.png [deleted file]
images/export/lttng-live.png [deleted file]
images/export/many-sessions.png [deleted file]
images/export/plumbing-27.png [deleted file]
images/export/track-1-3-4-7-10-13-15-16.png [deleted file]
images/export/track-1-4-15-16.png [deleted file]
images/export/track-3-4-7-10-13.png [deleted file]
images/export/track-6-11.png [deleted file]
images/export/track-all.png [deleted file]
images/export/untrack-all.png [deleted file]
images/export/ust-flow.png [deleted file]
toc/docs.yml [deleted file]
tools/.gitignore [new file with mode: 0644]
tools/asciidoc.check.conf [new file with mode: 0644]
tools/check.py [new file with mode: 0644]
tools/docs2json.py [deleted file]
tools/dotlinks.py [deleted file]
This page took 0.035706 seconds and 4 git commands to generate.