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

Build: fixed several build errors

Browse Source
This commit is contained in:
rebortg 2020-06-30 22:02:45 +02:00
parent c5f06930d8
commit 5cd60bf028
6 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/contributing/build-vyos.rst
View File

@ -38,7 +38,7 @@ To be able to use Docker_, the current non-root user should be added to the
Generating the container
----------------------
------------------------
The container can built by hand or by fetching the pre-built one from
DockerHub. Using the pre-built VyOS DockerHub organisation (https://hub.docker.com/u/vyos) will

7
docs/contributing/development.rst
View File

@ -31,6 +31,7 @@ eases the automatic generation of a changelog file.
A good approach for writing commit messages is actually to have a look at the
file(s) history by invoking ``git log path/to/file.txt``.
.. _prepare_commit:
Preparding patch/commit
^^^^^^^^^^^^^^^^^^^^^^^
@ -81,12 +82,12 @@ post: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
* All text of the commit message should be wrapped at 72 characters if
possible which makes reading commit logs easier with ``git log`` on a
standard terminal (which happens to be 80x25)
standard terminal (which happens to be 80x25)
* If applicable a reference to a previous commit should be made linking
those commits nicely when browsing the history: ``After commit abcd12ef
("snmp: this is a headline") a Python import statement is missing,
throwing the follwoing exception: ABCDEF``
("snmp: this is a headline") a Python import statement is missing,
throwing the following exception: ABCDEF``
* Always use the ``-x`` option to the ``git cherry-pick`` command when back or
forward porting an individual commit. This automatically appends the line:

2
docs/contributing/documentation.rst
View File

@ -30,7 +30,7 @@ project maintainer can push to the official repository. This allows the
maintainer to accept commits from any developer without giving them write
access to the official codebase.
.. node:: Updates to our documentation should be delivered by a GitHub
.. note:: Updates to our documentation should be delivered by a GitHub
pull-request. This requires you already have a GitHub account.
* Fork this project on GitHub https://github.com/vyos/vyos-documentation/fork

2
docs/contributing/vyos_cli.rst
View File

@ -183,7 +183,7 @@ Examples:
* Bad: "Set TCP connection timeout"
If a verb is essential, keep it. For example, in the help text of ``set system
ipv6 disable-forwarding`, "Disable IPv6 forwarding on all interfaces" is a
ipv6 disable-forwarding``, "Disable IPv6 forwarding on all interfaces" is a
perfectly justified wording.
Prefer infinitives

2
docs/qos.rst
View File

@ -423,7 +423,7 @@ fashion. You can configure the length of the queue.
.. _FQ-CoDel
.. _FQ-CoDel:
FQ-CoDel
--------

6
docs/routing/multicast.rst
View File

@ -31,7 +31,7 @@ source-specific multicast).
Example
-------
=======
In the following example we can see a basic multicast setup:
@ -87,7 +87,7 @@ In the following example we can see a basic multicast setup:
Basic commands
--------------
==============
These are the commands for a basic setup.
@ -114,7 +114,7 @@ These are the commands for a basic setup.
Tuning commands
---------------
===============
You can also tune multicast with the following commands.