[buildstream] 04/07: doc: Adding initial structure for a porting guide

[tv...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

tvb pushed a commit to branch tristan/porting-guide
in repository https://gitbox.apache.org/repos/asf/buildstream.git

commit 912b5d693e194ba6ed9edf0aaee601251be0696b
Author: Tristan van Berkom <tr...@codethink.co.uk>
AuthorDate: Fri Dec 31 14:47:04 2021 +0900

    doc: Adding initial structure for a porting guide
---
 doc/source/index.rst                      |  1 +
 doc/source/main_porting.rst               | 16 ++++++++++++++++
 doc/source/porting_command_line.rst       |  6 ++++++
 doc/source/porting_project.rst            |  6 ++++++
 doc/source/porting_user_configuration.rst |  6 ++++++
 5 files changed, 35 insertions(+)

diff --git a/doc/source/index.rst b/doc/source/index.rst
index 68b13da..57f9b21 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -20,6 +20,7 @@ Later sections provide detailed information on BuildStream internals.
    main_install
    main_using
    main_core
+   main_porting.rst
    CONTRIBUTING
    main_architecture
    main_glossary
diff --git a/doc/source/main_porting.rst b/doc/source/main_porting.rst
new file mode 100644
index 0000000..07ac9ef
--- /dev/null
+++ b/doc/source/main_porting.rst
@@ -0,0 +1,16 @@
+
+
+.. _main_porting:
+
+Porting guide
+=============
+This document focuses on porting your existing BuildStream 1 projects to
+using BuildStream 2.
+
+
+.. toctree::
+   :maxdepth: 1
+
+   porting_user_configuration
+   porting_command_line
+   porting_project
diff --git a/doc/source/porting_command_line.rst b/doc/source/porting_command_line.rst
new file mode 100644
index 0000000..b0cd905
--- /dev/null
+++ b/doc/source/porting_command_line.rst
@@ -0,0 +1,6 @@
+
+
+.. _porting_command_line:
+
+Porting command line usage
+==========================
diff --git a/doc/source/porting_project.rst b/doc/source/porting_project.rst
new file mode 100644
index 0000000..4c240d7
--- /dev/null
+++ b/doc/source/porting_project.rst
@@ -0,0 +1,6 @@
+
+
+.. _porting_project:
+
+Porting the project.conf
+========================
diff --git a/doc/source/porting_user_configuration.rst b/doc/source/porting_user_configuration.rst
new file mode 100644
index 0000000..f862da7
--- /dev/null
+++ b/doc/source/porting_user_configuration.rst
@@ -0,0 +1,6 @@
+
+
+.. _porting_user_configuration:
+
+Porting the buildstream.conf
+============================