From 59d4147a907ba7086fba001d8ad7becc9a908942 Mon Sep 17 00:00:00 2001
From: Christian Poessinger <christian@poessinger.com>
Date: Fri, 6 Sep 2019 11:29:53 +0200
Subject: build: builds on NFS/SMB shares are not supported

---
 docs/build-vyos.rst | 35 ++++++++++++++++++-----------------
 1 file changed, 18 insertions(+), 17 deletions(-)

(limited to 'docs/build-vyos.rst')

diff --git a/docs/build-vyos.rst b/docs/build-vyos.rst
index 8b6410d7..2ea2c217 100644
--- a/docs/build-vyos.rst
+++ b/docs/build-vyos.rst
@@ -3,13 +3,16 @@
 Building VyOS using Docker
 ==========================
 
-This will guide you though the process of building a VyOS ISO yourself using Docker and works best on a fresh installation of Debain 8 (Jessie).
+This will guide you though the process of building a VyOS ISO yourself using
+Docker and works best on a fresh installation of Debain 8 (Jessie).
+
+.. note:: Starting with VyOS 1.2 the developers have decided to change their
+   release model. VyOS is now **free as in speech, but not as in beer**, meaning
+   that while VyOS is still an open source project, the release ISO's are no
+   longer free and can only be obtained via subscription, or by contributing to
+   the community. Since the source code is still public you can build your own
+   ISO using the process described here.
 
-.. note:: Starting with VyOS 1.2 the developers have decided to change their release model. 
-   VyOS is now **free as in speech, but not as in beer**, meaning that while VyOS is still an open source project, the release      ISO's are no longer free and can only be obtained via subscription, or by contributing to the community. 
-   Since the source code is still public you can build your own ISO using the process described here. 
-   
-   
 Installing Docker and it's prequisites
 
 .. code-block:: sh
@@ -20,16 +23,18 @@ Installing Docker and it's prequisites
   root@build:~$ add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/debian $(lsb_release -cs) stable"
   root@build:~$ apt update
   root@build:~$ apt install docker-ce
-  
 
-Adding you user to the docker group to be able to execute the docker command without sudo
+Adding you user to the docker group to be able to execute the ``docker`` command
+without sudo.
 
 .. code-block:: sh
 
   root@build:~$ usermod -aG docker user
 
-.. note:: It is recommended to use a non-root user from here on out 
+.. note:: It is recommended to use a non-root user from here on out.
 
+.. note:: The build process needs to be built on a local file system, building
+          on SMB or NFS shares is not supported!
 
 Cloning the vyos-build crux branch and creating the docker container
 
@@ -38,21 +43,17 @@ Cloning the vyos-build crux branch and creating the docker container
   user@build:~$ git clone -b crux --single-branch https://github.com/vyos/vyos-build.git
   user@build:~$ cd vyos-build
   user@build:~/vyos-build$ docker build -t vyos-builder docker
-  
-  
-Running the container and building the ISO 
 
+Running the container and building the ISO
 
 .. code-block:: sh
 
   user@build:~$ docker run --rm -it --privileged -v $(pwd):/vyos -w /vyos vyos-builder bash
   vyos_bld@d4220bb519a0:/vyos# ./configure --architecture amd64 --build-by "your@email.tld" --build-type release --version 1.2.0
   vyos_bld@d4220bb519a0:/vyos# sudo make iso
-  
-  
-You may use these options to customize you ISO
 
-.. code-block:: sh
+You may use these options to customize you ISO
+code-block:: sh
 
   -h, --help            show this help message and exit
   --architecture ARCHITECTURE
@@ -76,5 +77,5 @@ You may use these options to customize you ISO
                         Custom APT entry
   --custom-apt-key CUSTOM_APT_KEY
                         Custom APT key file
-  
+
 *Your freshly built ISO should now be in the build directory. Good luck!*
-- 
cgit v1.2.3