From a2c9509a4ab22380937a2b613fcc518da22f5166 Mon Sep 17 00:00:00 2001
From: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
Date: Fri, 8 Oct 2021 14:05:58 +0200
Subject: docs: convert extras doc md->rst

Type: improvement

Change-Id: Ie3b25a86b99098d2b3a21a11fc73234c8ed589d6
Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
---
 extras/snap/README.md  | 86 --------------------------------------------------
 extras/snap/README.rst | 84 ++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 84 insertions(+), 86 deletions(-)
 delete mode 100644 extras/snap/README.md
 create mode 100644 extras/snap/README.rst

(limited to 'extras/snap')

diff --git a/extras/snap/README.md b/extras/snap/README.md
deleted file mode 100644
index 47fdd3c204e..00000000000
--- a/extras/snap/README.md
+++ /dev/null
@@ -1,86 +0,0 @@
-VPP Snap Build   {#snap_doc}
---------------
-
-General
--------
-
-The external dependency package will not build in the snapcraft
-vm. The path of least resistance is to copy it to the root of the
-(original) workspace before running the prep script.
-
-Snapcraft has mount issues except under /home. Run the prep script and
-copy the entire directory (including the .tgz file) under
-/home/yourself.
-
-Run the prep script
--------------------
-
-```
-  $ cd <vpp-workspace>/extras/snap
-  $ ./prep
-```
-
-Copy data to /home (if necessary)
-
-```
-  $ mkdir /home/xxx
-  $ cd <vpp-workspace>/extras/snap
-  $ cp * /home/xxx
-
-Set snapcraft environment variables
------------------------------------
-
-Minimum requirements:
-
-```
-  SNAPCRAFT_BUILD_ENVIRONMENT_MEMORY=16G
-  SNAPCRAFT_BUILD_ENVIRONMENT_DISK=32G
-```
-
-Optional:
-
-```
-  SNAPCRAFT_BUILD_ENVIRONMENT_CPU=8
-  SNAPCRAFT_ENABLE_DEVELOPER_DEBUG=yes
-```
-
-Run snapcraft
--------------
-
-With luck, simply running snapcraft will produce the snap
-
-```
-  $ <environment-variable-settings> snapcraft [--debug]
-```
-
-Rerunning snapcraft phases
---------------------------
-
-Here's how to (re)run individual phases, to avoid starting from
-scratch N times in case of errors:
-
-```
-  snapcraft pull [<part-name>]
-  snapcraft build [<part-name>]
-  snapcraft stage [<part-name>]
-  snapcraft prime [<part-name>]
-  snapcraft snap or snapcraft
-```
-
-Restart without rebuilding VM
------------------------------
-
-To restart from scratch without rebuilding the VM:
-
-```
-  snapcraft clean vpp
-```
-
-Delete (all) snapcraft VMs
---------------------------
-
-```
-  for vm in $(multipass list | awk '{print $1}' | grep ^snapcraft-); do
-  	multipass delete $vm --purge
-  done
-```
diff --git a/extras/snap/README.rst b/extras/snap/README.rst
new file mode 100644
index 00000000000..1a455565814
--- /dev/null
+++ b/extras/snap/README.rst
@@ -0,0 +1,84 @@
+.. _snap_doc:
+
+VPP Snap Build
+==============
+
+The external dependency package will not build in the snapcraft vm. The
+path of least resistance is to copy it to the root of the (original)
+workspace before running the prep script.
+
+Snapcraft has mount issues except under /home. Run the prep script and
+copy the entire directory (including the .tgz file) under
+/home/yourself.
+
+Run the prep script
+-------------------
+
+::
+
+     $ cd <vpp-workspace>/extras/snap
+     $ ./prep
+
+Copy data to /home (if necessary)
+
+::
+
+     $ mkdir /home/xxx
+     $ cd <vpp-workspace>/extras/snap
+     $ cp * /home/xxx
+
+   Set snapcraft environment variables
+   -----------------------------------
+
+   Minimum requirements:
+
+SNAPCRAFT_BUILD_ENVIRONMENT_MEMORY=16G
+SNAPCRAFT_BUILD_ENVIRONMENT_DISK=32G
+
+::
+
+
+   Optional:
+
+SNAPCRAFT_BUILD_ENVIRONMENT_CPU=8 SNAPCRAFT_ENABLE_DEVELOPER_DEBUG=yes
+
+::
+
+
+   Run snapcraft
+   -------------
+
+   With luck, simply running snapcraft will produce the snap
+
+$ snapcraft [–debug]
+
+::
+
+
+   Rerunning snapcraft phases
+   --------------------------
+
+   Here's how to (re)run individual phases, to avoid starting from
+   scratch N times in case of errors:
+
+snapcraft pull [] snapcraft build [] snapcraft stage [] snapcraft prime
+[] snapcraft snap or snapcraft
+
+::
+
+
+   Restart without rebuilding VM
+   -----------------------------
+
+   To restart from scratch without rebuilding the VM:
+
+snapcraft clean vpp
+
+::
+
+
+   Delete (all) snapcraft VMs
+   --------------------------
+
+for vm in $(multipass list \| awk ‘{print $1}’ \| grep ^snapcraft-); do
+multipass delete $vm –purge done \``\`
-- 
cgit 1.2.3-korg