Skip to content

Commit 972ebc8

Browse files
committed
Separate examples and improve their wording
1 parent 5a49840 commit 972ebc8

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

docs/manual/manual.adoc

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -450,34 +450,43 @@ This table lists the possible results of a single rule:
450450

451451
.XCCDF results
452452
|===
453-
|Result |Description
453+
|Result |Description |Example Situation
454454

455455
|pass
456456
|The target system or system component satisfied all the conditions of the rule.
457+
|
457458

458459
|fail
459460
|The target system or system component did not satisfy all the conditions of the rule.
461+
|
460462

461463
|error
462-
|The checking engine could not complete the evaluation, therefore the status of the target’s compliance with the rule is not certain. This could happen, for example, if a testing tool was run with insufficient privileges and could not gather all of the necessary information.
464+
|The checking engine could not complete the evaluation, therefore the status of the target’s compliance with the rule is not certain.
465+
|OpenSCAP was run with insufficient privileges and could not gather all of the necessary information.
463466

464467
|unknown
465-
|The testing tool encountered some problem and the result is unknown. For example, a result of ‘unknown’ might be given if the testing tool was unable to interpret the output of the checking engine (the output has no meaning to the testing tool)
468+
|The testing tool encountered some problem and the result is unknown.
469+
|OpenSCAP was unable to interpret the output of the checking engine (the output has no meaning to OpenSCAP).
466470

467471
|notapplicable
468-
|The rule was not applicable to the target of the test. For example, the rule might have been specific to a different version of the target OS, or it might have been a test against a platform feature that was not installed.
472+
|The rule was not applicable to the target of the test.
473+
|The rule might have been specific to a different version of the target OS, or it might have been a test against a platform feature that was not installed.
469474

470475
|notchecked
471-
|The rule was not evaluated by the checking engine. This status is designed for rules that have no <xccdf:check> elements or that correspond to an unsupported checking system. It may also correspond to a status returned by a checking engine if the checking engine does not support the indicated check code. For example, the rule does not reference any OVAL check.
476+
|The rule was not evaluated by the checking engine. This status is designed for rules that have no <xccdf:check> elements or that correspond to an unsupported checking system. It may also correspond to a status returned by a checking engine if the checking engine does not support the indicated check code.
477+
|The rule does not reference any OVAL check.
472478

473479
|notselected
474480
|The rule was not selected in the benchmark. OpenSCAP does not display rules that were not selected.
481+
|The rule exists in the benchmark, but is not a part of selected profile.
475482

476483
|informational
477484
|The rule was checked, but the output from the checking engine is simply information for auditors or administrators; it is not a compliance category. This status value is designed for rules whose main purpose is to extract information from the target rather than test the target.
485+
|
478486

479487
|fixed
480488
|The rule had failed, but was then fixed by automated remediation.
489+
|
481490
|===
482491

483492
The CPE dictionary is used to determine whether the content is

0 commit comments

Comments
 (0)