diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/appendix/vyos-on-baremetal.rst | 2 | ||||
| -rw-r--r-- | docs/contributing/build-vyos.rst | 12 | ||||
| -rw-r--r-- | docs/contributing/development.rst | 2 |
3 files changed, 11 insertions, 5 deletions
diff --git a/docs/appendix/vyos-on-baremetal.rst b/docs/appendix/vyos-on-baremetal.rst index 36c58317..79835e7d 100644 --- a/docs/appendix/vyos-on-baremetal.rst +++ b/docs/appendix/vyos-on-baremetal.rst @@ -76,7 +76,7 @@ Pictures PC Engines APU4 *************** -As this platform seems to be quiet common in terms of noise, cost, power and +As this platform seems to be quite common in terms of noise, cost, power and performance it makes sense to write a small installation manual. This guide was developed using an APU4C4 board with the following specs: diff --git a/docs/contributing/build-vyos.rst b/docs/contributing/build-vyos.rst index 26a9c674..3481a585 100644 --- a/docs/contributing/build-vyos.rst +++ b/docs/contributing/build-vyos.rst @@ -36,6 +36,8 @@ To be able to use Docker_, the current non-root user should be added to the .. note:: The build process needs to be built on a local file system, building on SMB or NFS shares will result in the container failing to build properly! + VirtualBox Drive Share is also not an option as block device operations + are not implemented and the drive is always mounted as "nodev" Build Docker Container ---------------------- @@ -53,10 +55,10 @@ The container can always be built directly from source: $ git clone -b current --single-branch https://github.com/vyos/vyos-build $ docker build -t vyos/vyos-build docker -.. note: The container is automatically downloaded from Dockerhub if it is not +.. note:: The container is automatically downloaded from Dockerhub if it is not found on your local machine when the below command is executed. -.. note: We require one container per build branch, this means that the used +.. note:: We require one container per build branch, this means that the used container in ``crux`` and ``current`` can and will differ once VyOS makes the move towards Debian (10) Buster. @@ -76,6 +78,10 @@ a fresh build of the VyOS ISO can begin. --build-type release --version 1.2.0 vyos_bld@d4220bb519a0:/vyos# sudo make iso +.. note:: Attempting to use the docker build image on MacOS or Windows will fail + as docker does not expose all the filesystem feature required to the container. + Building within a VirtualBox server on Mac or Windows is however possible. + To select the container you want to run, you need to specify the branch you are interested in, this can be easily done by selecting the appropriate container image: @@ -369,7 +375,7 @@ Drivers are build as part of the Kernel Pipeline - read above. Accel-PPP ^^^^^^^^^ -Accel-PPP used to be an upstream fork for quiet some time but now has been +Accel-PPP used to be an upstream fork for quite some time but now has been converted to make use of the upstream source code and build system. It is build as part of the Kernel Pipeline - read above. diff --git a/docs/contributing/development.rst b/docs/contributing/development.rst index 220dd362..009e84f7 100644 --- a/docs/contributing/development.rst +++ b/docs/contributing/development.rst @@ -201,7 +201,7 @@ Formatting * Python: Tabs **shall not** be used. Every indentation level should be 4 spaces * XML: Tabs **shall not** be used. Every indentation level should be 2 spaces -.. note: There are extensions to e.g. VIM (xmllint) which will help you to get +.. note:: There are extensions to e.g. VIM (xmllint) which will help you to get your indention levels correct. Add to following to your .vimrc file: ``au FileType xml setlocal equalprg=xmllint\ --format\ --recover\ -\ 2>/dev/null`` now you can call the linter using ``gg=G`` in command mode. |