vyos/vyos-documentation
1
0
Fork 0
mirror of https://github.com/vyos/vyos-documentation.git synced 2025-10-26 08:41:46 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fix spelling in contributing

Browse Source
This commit is contained in:
Sebastian Weber 2024-01-17 21:40:04 +01:00
parent eeffa32cf0
commit 1eef218af2
No known key found for this signature in database
GPG Key ID: 4A64BA1D7E2F1FEA
3 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/contributing/debugging.rst
View File

@ -125,7 +125,7 @@ You can type ``help`` to get an overview of the available commands, and
Useful commands are: Useful commands are:
* examine variables using ``pp(var)`` * examine variables using ``pp(var)``
* contine execution using ``cont`` * continue execution using ``cont``
* get a backtrace using ``bt`` * get a backtrace using ``bt``
Config Migration Scripts Config Migration Scripts
@ -147,7 +147,7 @@ look like:
The reason is that the configuration migration backend is rewritten and uses The reason is that the configuration migration backend is rewritten and uses
a new form of "magic string" which is applied on demand when real config a new form of "magic string" which is applied on demand when real config
migration is run on boot. When runnint individual migrators for testing, migration is run on boot. When running individual migrators for testing,
you need to convert the "magic string" on your own by: you need to convert the "magic string" on your own by:
.. code-block:: none .. code-block:: none
@ -157,13 +157,13 @@ you need to convert the "magic string" on your own by:
Configuration Error on System Boot Configuration Error on System Boot
---------------------------------- ----------------------------------
Beeing brave and running the latest rolling releases will sometimes trigger Being brave and running the latest rolling releases will sometimes trigger
bugs due to corner cases we missed in our design. Those bugs should be filed bugs due to corner cases we missed in our design. Those bugs should be filed
via Phabricator_ but you can help us to narrow doen the issue. Login to your via Phabricator_ but you can help us to narrow down the issue. Login to your
VyOS system and change into configuration mode by typing ``configure``. Now VyOS system and change into configuration mode by typing ``configure``. Now
re-load your boot configuration by simply typing ``load`` followed by return. re-load your boot configuration by simply typing ``load`` followed by return.
You shoudl now see a Python backtrace which will help us to handle the issue, You should now see a Python backtrace which will help us to handle the issue,
please attach it to the Phabricator_ task. please attach it to the Phabricator_ task.
Boot Timing Boot Timing
@ -179,7 +179,7 @@ installed by default on the VyOS 1.3 (equuleus) branch. The configuration is
also versioned so we get comparable results. ``systemd-bootchart`` is configured also versioned so we get comparable results. ``systemd-bootchart`` is configured
using this file: bootchart.conf_ using this file: bootchart.conf_
To enable boot time graphing change the Kernel commandline and add the folowing To enable boot time graphing change the Kernel commandline and add the following
string: ``init=/usr/lib/systemd/systemd-bootchart`` string: ``init=/usr/lib/systemd/systemd-bootchart``
This can also be done permanently by changing ``/boot/grub/grub.cfg``. This can also be done permanently by changing ``/boot/grub/grub.cfg``.
@ -190,7 +190,7 @@ Priorities
VyOS CLI is all about priorities. Every CLI node has a corresponding VyOS CLI is all about priorities. Every CLI node has a corresponding
``node.def`` file and possibly an attached script that is executed when the ``node.def`` file and possibly an attached script that is executed when the
node is present. Nodes can have a priority, and on system bootup - or any node is present. Nodes can have a priority, and on system bootup - or any
other ``commit`` to the config all scripts are executed from lowest to higest other ``commit`` to the config all scripts are executed from lowest to highest
priority. This is good as this gives a deterministic behavior. priority. This is good as this gives a deterministic behavior.
To debug issues in priorities or to see what's going on in the background To debug issues in priorities or to see what's going on in the background

2
docs/contributing/development.rst
View File

@ -252,7 +252,7 @@ contributors to navigate through the sources and all the implied logic of
the spaghetti code. the spaghetti code.
Please use the following template as good starting point when developing new Please use the following template as good starting point when developing new
modules or even rewrite a whole bunch of code in the new style XML/Pyhon modules or even rewrite a whole bunch of code in the new style XML/Python
interface. interface.

6
docs/contributing/testing.rst
View File

@ -20,7 +20,7 @@ Jenkins CI
Our `VyOS CI`_ system is based on Jenkins and builds all our required packages Our `VyOS CI`_ system is based on Jenkins and builds all our required packages
for VyOS 1.2 to 1.4. In addition to the package build, there is the vyos-build for VyOS 1.2 to 1.4. In addition to the package build, there is the vyos-build
Job which builds and tests the VyOS ISO image which is published after a Job which builds and tests the VyOS ISO image which is published after a
successfull test drive. successful test drive.
We differentiate in two independent tests, which are both run in parallel by We differentiate in two independent tests, which are both run in parallel by
two separate QEmu instances which are launched via ``make test`` and ``make two separate QEmu instances which are launched via ``make test`` and ``make
@ -42,7 +42,7 @@ with the following packages:
if (params.BUILD_SMOKETESTS) if (params.BUILD_SMOKETESTS)
CUSTOM_PACKAGES = '--custom-package vyos-1x-smoketest' CUSTOM_PACKAGES = '--custom-package vyos-1x-smoketest'
So if you plan to build your own custom ISO image and wan't to make use of our So if you plan to build your own custom ISO image and want to make use of our
smoketests, ensure that you have the `vyos-1x-smoketest` package installed. smoketests, ensure that you have the `vyos-1x-smoketest` package installed.
The ``make test`` command from the vyos-build_ repository will launch a new The ``make test`` command from the vyos-build_ repository will launch a new
@ -106,7 +106,7 @@ Those common tests consists out of:
* VLANs (QinQ and regular 802.1q) * VLANs (QinQ and regular 802.1q)
* ... * ...
.. note:: When you are working on interface configuration and you also wan't to .. note:: When you are working on interface configuration and you also want to
test if the Smoketests pass you would normally loose the remote SSH connection test if the Smoketests pass you would normally loose the remote SSH connection
to your :abbr:`DUT (Device Under Test)`. To handle this issue, some of the to your :abbr:`DUT (Device Under Test)`. To handle this issue, some of the
interface based tests can be called with an environment variable beforehand interface based tests can be called with an environment variable beforehand