From d87a2feac05b3e3ff3750449740ce93b6bbc6192 Mon Sep 17 00:00:00 2001 From: Thomas Mangin Date: Sat, 8 Feb 2020 15:30:26 +0000 Subject: fix note due to : vs :: typo --- docs/contributing/build-vyos.rst | 4 ++-- docs/contributing/development.rst | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) (limited to 'docs/contributing') diff --git a/docs/contributing/build-vyos.rst b/docs/contributing/build-vyos.rst index 26a9c674..f5875bb4 100644 --- a/docs/contributing/build-vyos.rst +++ b/docs/contributing/build-vyos.rst @@ -53,10 +53,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. 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. -- cgit v1.2.3