From dc70d8147f53a284cc2e056455a659d81db5738d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Thu, 22 Oct 2015 03:02:48 +0200 Subject: Add placeholders for missing chapters --- doc/src/guide/architecture.asciidoc | 5 ++++ doc/src/guide/asciidoc.asciidoc | 5 ++++ doc/src/guide/book.asciidoc | 38 +++++++++++++++++++++++++-- doc/src/guide/ci.asciidoc | 5 ++++ doc/src/guide/common_test.asciidoc | 5 ++++ doc/src/guide/contributing.asciidoc | 5 ++++ doc/src/guide/coverage.asciidoc | 5 ++++ doc/src/guide/dialyzer.asciidoc | 5 ++++ doc/src/guide/edoc.asciidoc | 5 ++++ doc/src/guide/escripts.asciidoc | 5 ++++ doc/src/guide/eunit.asciidoc | 5 ++++ doc/src/guide/history.asciidoc | 5 ++++ doc/src/guide/ports.asciidoc | 5 ++++ doc/src/guide/property_based_testing.asciidoc | 5 ++++ doc/src/guide/releases.asciidoc | 5 ++++ doc/src/guide/shell.asciidoc | 5 ++++ doc/src/guide/xref.asciidoc | 5 ++++ 17 files changed, 116 insertions(+), 2 deletions(-) create mode 100644 doc/src/guide/architecture.asciidoc create mode 100644 doc/src/guide/asciidoc.asciidoc create mode 100644 doc/src/guide/ci.asciidoc create mode 100644 doc/src/guide/common_test.asciidoc create mode 100644 doc/src/guide/contributing.asciidoc create mode 100644 doc/src/guide/coverage.asciidoc create mode 100644 doc/src/guide/dialyzer.asciidoc create mode 100644 doc/src/guide/edoc.asciidoc create mode 100644 doc/src/guide/escripts.asciidoc create mode 100644 doc/src/guide/eunit.asciidoc create mode 100644 doc/src/guide/history.asciidoc create mode 100644 doc/src/guide/ports.asciidoc create mode 100644 doc/src/guide/property_based_testing.asciidoc create mode 100644 doc/src/guide/releases.asciidoc create mode 100644 doc/src/guide/shell.asciidoc create mode 100644 doc/src/guide/xref.asciidoc diff --git a/doc/src/guide/architecture.asciidoc b/doc/src/guide/architecture.asciidoc new file mode 100644 index 0000000..f96606b --- /dev/null +++ b/doc/src/guide/architecture.asciidoc @@ -0,0 +1,5 @@ +== Architecture + +// @todo Write it. + +Placeholder chapter. diff --git a/doc/src/guide/asciidoc.asciidoc b/doc/src/guide/asciidoc.asciidoc new file mode 100644 index 0000000..6ba43ec --- /dev/null +++ b/doc/src/guide/asciidoc.asciidoc @@ -0,0 +1,5 @@ +== Asciidoc documentation + +// @todo Write it. + +Placeholder chapter. diff --git a/doc/src/guide/book.asciidoc b/doc/src/guide/book.asciidoc index 8533997..a54ab1b 100644 --- a/doc/src/guide/book.asciidoc +++ b/doc/src/guide/book.asciidoc @@ -20,12 +20,46 @@ include::app.asciidoc[Building] include::deps.asciidoc[Packages and dependencies] -include::compat.asciidoc[Compatibility with other build tools] +include::ports.asciidoc[NIFs and port drivers] + +include::releases.asciidoc[Releases] -= Advanced +include::escripts.asciidoc[Escripts] + +include::compat.asciidoc[Compatibility with other build tools] include::external_plugins.asciidoc[External plugins] += Documentation + +include::asciidoc.asciidoc[Asciidoc documentation] + +include::edoc.asciidoc[EDoc comments] + += Tests + +include::shell.asciidoc[Erlang shell] + +include::eunit.asciidoc[EUnit] + +include::common_test.asciidoc[Common Test] + +include::property_based_testing.asciidoc[Property based testing] + +include::coverage.asciidoc[Code coverage] + +include::ci.asciidoc[Continuous integration] + +include::dialyzer.asciidoc[Dialyzer] + +include::xref.asciidoc[Xref] + = About Erlang.mk include::why.asciidoc[Why erlang.mk?] + +include::history.asciidoc[Short history] + +include::architecture.asciidoc[Architecture] + +include::contributing.asciidoc[Contributing] diff --git a/doc/src/guide/ci.asciidoc b/doc/src/guide/ci.asciidoc new file mode 100644 index 0000000..8a96ed4 --- /dev/null +++ b/doc/src/guide/ci.asciidoc @@ -0,0 +1,5 @@ +== Continuous integration + +// @todo Write it. + +Placeholder chapter. diff --git a/doc/src/guide/common_test.asciidoc b/doc/src/guide/common_test.asciidoc new file mode 100644 index 0000000..7daeae5 --- /dev/null +++ b/doc/src/guide/common_test.asciidoc @@ -0,0 +1,5 @@ +== Common Test + +// @todo Write it. + +Placeholder chapter. diff --git a/doc/src/guide/contributing.asciidoc b/doc/src/guide/contributing.asciidoc new file mode 100644 index 0000000..e712788 --- /dev/null +++ b/doc/src/guide/contributing.asciidoc @@ -0,0 +1,5 @@ +== Contributing + +// @todo Write it. + +Placeholder chapter. diff --git a/doc/src/guide/coverage.asciidoc b/doc/src/guide/coverage.asciidoc new file mode 100644 index 0000000..5e74f36 --- /dev/null +++ b/doc/src/guide/coverage.asciidoc @@ -0,0 +1,5 @@ +== Code coverage + +// @todo Write it. + +Placeholder chapter. diff --git a/doc/src/guide/dialyzer.asciidoc b/doc/src/guide/dialyzer.asciidoc new file mode 100644 index 0000000..7377c82 --- /dev/null +++ b/doc/src/guide/dialyzer.asciidoc @@ -0,0 +1,5 @@ +== Dialyzer + +// @todo Write it. + +Placeholder chapter. diff --git a/doc/src/guide/edoc.asciidoc b/doc/src/guide/edoc.asciidoc new file mode 100644 index 0000000..f54d447 --- /dev/null +++ b/doc/src/guide/edoc.asciidoc @@ -0,0 +1,5 @@ +== EDoc comments + +// @todo Write it. + +Placeholder chapter. diff --git a/doc/src/guide/escripts.asciidoc b/doc/src/guide/escripts.asciidoc new file mode 100644 index 0000000..fcc6080 --- /dev/null +++ b/doc/src/guide/escripts.asciidoc @@ -0,0 +1,5 @@ +== Escripts + +// @todo Write it. + +Placeholder chapter. diff --git a/doc/src/guide/eunit.asciidoc b/doc/src/guide/eunit.asciidoc new file mode 100644 index 0000000..1a16776 --- /dev/null +++ b/doc/src/guide/eunit.asciidoc @@ -0,0 +1,5 @@ +== EUnit + +// @todo Write it. + +Placeholder chapter. diff --git a/doc/src/guide/history.asciidoc b/doc/src/guide/history.asciidoc new file mode 100644 index 0000000..41eec09 --- /dev/null +++ b/doc/src/guide/history.asciidoc @@ -0,0 +1,5 @@ +== Short history + +// @todo Write it. + +Placeholder chapter. diff --git a/doc/src/guide/ports.asciidoc b/doc/src/guide/ports.asciidoc new file mode 100644 index 0000000..98b1d45 --- /dev/null +++ b/doc/src/guide/ports.asciidoc @@ -0,0 +1,5 @@ +== NIFs and port drivers + +// @todo Write it. + +Placeholder chapter. diff --git a/doc/src/guide/property_based_testing.asciidoc b/doc/src/guide/property_based_testing.asciidoc new file mode 100644 index 0000000..c652b2b --- /dev/null +++ b/doc/src/guide/property_based_testing.asciidoc @@ -0,0 +1,5 @@ +== Property based testing + +// @todo Write it. + +Placeholder chapter. diff --git a/doc/src/guide/releases.asciidoc b/doc/src/guide/releases.asciidoc new file mode 100644 index 0000000..a098951 --- /dev/null +++ b/doc/src/guide/releases.asciidoc @@ -0,0 +1,5 @@ +== Releases + +// @todo Write it. + +Placeholder chapter. diff --git a/doc/src/guide/shell.asciidoc b/doc/src/guide/shell.asciidoc new file mode 100644 index 0000000..a5643c2 --- /dev/null +++ b/doc/src/guide/shell.asciidoc @@ -0,0 +1,5 @@ +== Erlang shell + +// @todo Write it. + +Placeholder chapter. diff --git a/doc/src/guide/xref.asciidoc b/doc/src/guide/xref.asciidoc new file mode 100644 index 0000000..889aa41 --- /dev/null +++ b/doc/src/guide/xref.asciidoc @@ -0,0 +1,5 @@ +== Xref + +// @todo Write it. + +Placeholder chapter. -- cgit v1.2.3