diff options
Diffstat (limited to 'docs/contributing')
| -rw-r--r-- | docs/contributing/coding_guidelines.rst | 4 | ||||
| -rw-r--r-- | docs/contributing/development.rst | 2 | ||||
| -rw-r--r-- | docs/contributing/vyos_cli.rst | 4 |
3 files changed, 5 insertions, 5 deletions
diff --git a/docs/contributing/coding_guidelines.rst b/docs/contributing/coding_guidelines.rst index ff863d61..9c996518 100644 --- a/docs/contributing/coding_guidelines.rst +++ b/docs/contributing/coding_guidelines.rst @@ -54,7 +54,7 @@ The **get_config()** function must convert the VyOS config to an abstract intern representation. No other function is allowed to call ``vyos.config.Config`` object methods directly. The rationale for it is that when config reads are mixed with other logic, it's very hard to change the config syntax since you need to weed -out every occurence of the old syntax. If syntax-specific code is confined to a +out every occurrence of the old syntax. If syntax-specific code is confined to a single function, the rest of the code can be left untouched as long as the internal representation remains compatible. @@ -75,7 +75,7 @@ The **apply()** function applies the generated configuration to the live system. It should use non-disruptive reload whenever possible. It may execute disruptive operations such as daemon process restart if a particular component does not support non-disruptive reload, or when the expected service degradation is minimal -(for example, in case of auxillary services such as LLDPd). In case of high impact +(for example, in case of auxiliary services such as LLDPd). In case of high impact services such as VPN daemon and routing protocols, when non-disruptive reload is supported for some but not all types of configuration changes, scripts authors should make effort to determine if a configuration change can be done in a diff --git a/docs/contributing/development.rst b/docs/contributing/development.rst index 4b762051..9e99ece8 100644 --- a/docs/contributing/development.rst +++ b/docs/contributing/development.rst @@ -31,7 +31,7 @@ This information is used in two ways: * Keep track of the progress (what we've already done in this branch and what we still need to do). * Prepare release notes. -To make this approach work, every change must be associated with a bug number and componant. +To make this approach work, every change must be associated with a bug number and component. If there is no bug/enhancement request for the changes you are going to make, you must create a `bugtracker`_ entry first. Once there is a `bugtracker`_ entry about it, you should reference in your commit message, as in: diff --git a/docs/contributing/vyos_cli.rst b/docs/contributing/vyos_cli.rst index f539efda..49f9a230 100644 --- a/docs/contributing/vyos_cli.rst +++ b/docs/contributing/vyos_cli.rst @@ -5,8 +5,8 @@ VyOS CLI The bash completion in VyOS is defined in *templates*. Templates are text files stored in a directory tree, where directory names define command names, and -template files define command behaviour. Befor VyOS 1.2.x this files were created -by hand. After a complex redesing process_ the new style template are in XML. +template files define command behaviour. Before VyOS 1.2.x this files were created +by hand. After a complex redesign process_ the new style template are in XML. XML interface definitions for VyOS come with a RelaxNG schema and are located in the vyos-1x_ module. This schema is a slightly modified schema from VyConf_ |