summaryrefslogtreecommitdiffstats
path: root/extras/snap/README.md
diff options
context:
space:
mode:
authorNathan Skrzypczak <nathan.skrzypczak@gmail.com>2021-10-08 14:05:58 +0200
committerDave Wallace <dwallacelf@gmail.com>2021-10-13 15:32:22 +0000
commita2c9509a4ab22380937a2b613fcc518da22f5166 (patch)
tree93e0629de82c99ca4b1f9802083cf9362f1dc325 /extras/snap/README.md
parent8acc5ee9079d0b03229a72e72a5308e7de0a359a (diff)
docs: convert extras doc md->rst
Type: improvement Change-Id: Ie3b25a86b99098d2b3a21a11fc73234c8ed589d6 Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
Diffstat (limited to 'extras/snap/README.md')
-rw-r--r--extras/snap/README.md86
1 files changed, 0 insertions, 86 deletions
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
-```