From a370e97c1bc1c5545a58eed3bc7d7a4c70145b77 Mon Sep 17 00:00:00 2001 From: rebortg Date: Fri, 11 Dec 2020 14:11:21 +0100 Subject: debugging: fix lint errors --- docs/debugging.rst | 28 +++++++++++++++------------- 1 file changed, 15 insertions(+), 13 deletions(-) (limited to 'docs/debugging.rst') diff --git a/docs/debugging.rst b/docs/debugging.rst index e65e06ab..90313a88 100644 --- a/docs/debugging.rst +++ b/docs/debugging.rst @@ -29,7 +29,8 @@ Kernel CLI. In this circumstance, the kernel boot parameter ``vyos-config-debug`` will ensure access to the system as user ``vyos``, and will log a Python stack trace to the file ``/tmp/boot-config-trace``. - File ``boot-config-trace`` will generate only if config loaded with a failure status. + File ``boot-config-trace`` will generate only if config loaded with a failure + status. Live System =========== @@ -72,9 +73,9 @@ will have the same effect as ``touch /tmp/vyos.ifconfig.debug``. file. The default file is ``/tmp/full-log`` but it can be changed. .. note:: In order to retrieve the debug output on the command-line you need to - disable ``vyos-configd`` in addition. This can be run either one-time by calling - ``sudo systemctl stop vyos-configd`` or make this reboot-safe by calling - ``sudo systemctl disable vyos-configd``. + disable ``vyos-configd`` in addition. This can be run either one-time by + calling ``sudo systemctl stop vyos-configd`` or make this reboot-safe by + calling ``sudo systemctl disable vyos-configd``. Debugging Python Code with PDB ------------------------------ @@ -171,17 +172,18 @@ This can also be done permanently by changing ``/boot/grub/grub.cfg``. Priorities ========== -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 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 priority. This is good as -this gives a deterministic behavior. +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 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 +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 you can -use the ``/opt/vyatta/sbin/priority.pl`` script which lists to you the execution -order of the scripts. +To debug issues in priorities or to see what's going on in the background +you can use the ``/opt/vyatta/sbin/priority.pl`` script which lists to you +the execution order of the scripts. +.. stop_vyoslinter .. _vyatta-cfg: https://github.com/vyos/vyatta-cfg .. _bootchart.conf: https://github.com/vyos/vyos-build/blob/current/data/live-build-config/includes.chroot/etc/systemd/bootchart.conf - .. include:: /_include/common-references.txt +.. start_vyoslinter \ No newline at end of file -- cgit v1.2.3