1
1
NUT Quality Assurance
2
- =====================
2
+ ---------------------
3
3
4
4
Recognizing the critical nature of NUT, the NUT Quality Assurance (NQA) effort
5
5
has been established to improve NUT where necessary, and to maintain software
@@ -8,7 +8,7 @@ quality as high as it should be.
8
8
NQA is present in many aspects and areas of NUT.
9
9
10
10
Documentation
11
- -------------
11
+ ~~~~~~~~~~~~~
12
12
13
13
The documentation toolchain uses
14
14
link:https://asciidoc.org/[AsciiDoc] to output both HTML pages and
@@ -17,28 +17,28 @@ suppresses many redundancies, and optimizes documentation management in
17
17
general.
18
18
19
19
- The NUT website and HTML documentation are tested for W3C XHTML 1.1 and CSS
20
- compliance. This can be counter verified by clicking the W3C XHTML 1.1 and CSS
21
- icons, at the bottom of each page.
20
+ compliance. This can be counter verified by clicking the W3C XHTML 1.1 and
21
+ CSS icons, at the bottom of each page.
22
22
23
23
////////////////////////////////////////////////////////////////////////////////
24
24
- the manual pages conformance is tested with
25
25
link:http://catb.org/~esr/doclifter/index.html[doclifter] (outdated)
26
26
////////////////////////////////////////////////////////////////////////////////
27
27
28
28
- Documentation source files are spell checked, using
29
- link:http://aspell.net[Aspell], both interactively (using
30
- 'make spellcheck-interactive') and automatically in Buildbot (using
31
- 'make spellcheck').
29
+ link:http://aspell.net[Aspell], both interactively (using
30
+ 'make spellcheck-interactive') and automatically in Buildbot (using
31
+ 'make spellcheck').
32
32
33
- NOTE: A NUT dictionary is also available (docs/nut.dict), providing a
34
- glossary of terms related to power devices and management, as well as
35
- partial terms, technical jargon and author names.
33
+ NOTE: A NUT dictionary is also available (as ` docs/nut.dict` in NUT sources),
34
+ providing a glossary of terms related to power devices and management, as well
35
+ as partial terms, technical jargon and author names.
36
36
37
37
Source code
38
- -----------
38
+ ~~~~~~~~~~~
39
39
40
40
Use of standards
41
- ~~~~~~~~~~~~~~~~
41
+ ^^^^^^^^^^^^^^^^
42
42
43
43
NUT promotes and uses many standards, such as:
44
44
@@ -54,12 +54,12 @@ NUT promotes and uses many standards, such as:
54
54
* the TCP Wrappers library.
55
55
56
56
QA tools and metrics
57
- ~~~~~~~~~~~~~~~~~~~~
57
+ ^^^^^^^^^^^^^^^^^^^^
58
58
59
59
NUT's quality is constantly monitored using many tools, like:
60
60
61
- - a Revision Control System (link:https://github.com/networkupstools/nut[Git]) to
62
- track development and ease regression fixes.
61
+ - a Revision Control System (link:https://github.com/networkupstools/nut[Git])
62
+ to track development and ease regression fixes.
63
63
64
64
////////////////////////////////////////////////////////////////////////////////
65
65
Any modification on the NUT source
@@ -140,13 +140,13 @@ It installs NUT packages, configures it with the dummy-ups driver, changes
140
140
provides metrics on NUT source code base and activity.
141
141
142
142
Runtime quality
143
- ~~~~~~~~~~~~~~~
143
+ ^^^^^^^^^^^^^^^
144
144
145
145
- NUT provides many link:user-manual.html#NUT_Security[security features] to
146
- ensure a maximum runtime security level.
146
+ ensure a maximum runtime security level.
147
147
148
148
- Packages use several link:http://wiki.debian.org/Hardening[Hardening methods]
149
- to protect NUT binaries.
149
+ to protect NUT binaries.
150
150
151
151
////////////////////////////////////////////////////////////////////////////////
152
152
FIXME (POST):
0 commit comments