diff options
Diffstat (limited to 'docs/contributing')
| -rw-r--r-- | docs/contributing/build-vyos.rst | 27 | ||||
| -rw-r--r-- | docs/contributing/development.rst | 19 |
2 files changed, 39 insertions, 7 deletions
diff --git a/docs/contributing/build-vyos.rst b/docs/contributing/build-vyos.rst index afb1c27c..83b4c84d 100644 --- a/docs/contributing/build-vyos.rst +++ b/docs/contributing/build-vyos.rst @@ -88,9 +88,11 @@ The container can also be built directly from source: # For VyOS 1.2 (crux) $ git clone -b crux --single-branch https://github.com/vyos/vyos-build - # For VyOS 1.3 (equuleus, current) + # For VyOS 1.3 (equuleus) + $ git clone -b equuleus --single-branch https://github.com/vyos/vyos-build + # For VyOS 1.4 (sagitta, current) $ git clone -b current --single-branch https://github.com/vyos/vyos-build - + $ cd vyos-build $ docker build -t vyos/vyos-build:crux docker # For VyOS 1.2 $ docker build -t vyos/vyos-build:current docker # For rolling release @@ -146,7 +148,8 @@ To build VyOS natively you require a properly configured build host with the following Debian versions installed: - Debian Jessie for VyOS 1.2 (crux) -- Debian Buster for VyOS 1.3 (equuleus, current) - aka the rolling release +- Debian Buster for VyOS 1.3 (equuleus) +- Debian Bullseye for VyOS 1.4 (sagitta, current) - aka the rolling release To start, clone the repository to your local machine: @@ -155,9 +158,13 @@ To start, clone the repository to your local machine: # For VyOS 1.2 (crux) $ git clone -b crux --single-branch https://github.com/vyos/vyos-build - # For VyOS 1.3 (equuleus, current) + # For VyOS 1.3 (equuleus) + $ git clone -b equuleus --single-branch https://github.com/vyos/vyos-build + + # For VyOS 1.4 (sagitta, current) $ git clone -b current --single-branch https://github.com/vyos/vyos-build + For the packages required, you can refer to the ``docker/Dockerfile`` file in the repository_. The ``./build-vyos-image`` script will also warn you if any dependencies are missing. @@ -181,7 +188,10 @@ Please note as this will differ for both `current` and `crux`. # For VyOS 1.2 (crux) $ git clone -b crux --single-branch https://github.com/vyos/vyos-build - # For VyOS 1.3 (equuleus, current) + # For VyOS 1.3 (equuleus) + $ git clone -b equuleus --single-branch https://github.com/vyos/vyos-build + + # For VyOS 1.4 (sagitta, current) $ git clone -b current --single-branch https://github.com/vyos/vyos-build Now a fresh build of the VyOS ISO can begin. Change directory to the @@ -193,9 +203,12 @@ Now a fresh build of the VyOS ISO can begin. Change directory to the # For VyOS 1.2 (crux) $ docker run --rm -it --privileged -v $(pwd):/vyos -w /vyos vyos/vyos-build:crux bash - # For VyOS 1.3 (equuleus, current) - $ docker run --rm -it --privileged -v $(pwd):/vyos -w /vyos vyos/vyos-build:current bash + # For VyOS 1.3 (equuleus) + $ docker run --rm -it --privileged -v $(pwd):/vyos -w /vyos vyos/vyos-build:equuleus bash + # For VyOS 1.4 (sagitta, current) + $ docker run --rm -it --privileged -v $(pwd):/vyos -w /vyos vyos/vyos-build:current bash + .. code-block:: none # For MacOS (crux, equuleus, sagitta) diff --git a/docs/contributing/development.rst b/docs/contributing/development.rst index 7d90ac0f..1f296144 100644 --- a/docs/contributing/development.rst +++ b/docs/contributing/development.rst @@ -682,6 +682,25 @@ Migrating old CLI - None - All logic should be in the scripts +C++ Backend Code +================ + +The CLI parser used in VyOS is a mix of bash, bash-completion helper and the +C++ backend library [vyatta-cfg](https://github.com/vyos/vyatta-cfg). This +section is a reference of common CLI commands and the respective entry point +in the C/C++ code. + +* ``set`` + + - https://github.com/vyos/vyatta-cfg/blob/0f42786a0b3/src/cstore/cstore.cpp#L352 + - https://github.com/vyos/vyatta-cfg/blob/0f42786a0b3/src/cstore/cstore.cpp#L2549 + + +* ``commit`` + + - https://github.com/vyos/vyatta-cfg/blob/0f42786a0b3/src/commit/commit-algorithm.cpp#L1252 + + Continuous Integration ====================== |