Skip to content

Commit 73f5eba

Browse files
committed
Remove autorefer.py documentation
This pull request (ComplianceAsCode#6908) was rejected upstream; remove its corresponding documentation. Signed-off-by: Alexander Scheel <[email protected]>
1 parent 2883979 commit 73f5eba

File tree

1 file changed

+0
-41
lines changed

1 file changed

+0
-41
lines changed

docs/manual/developer/05_tools_and_utilities.md

Lines changed: 0 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -144,47 +144,6 @@ For example:
144144
Note that it is generally good practice to commit all changes prior to running
145145
one of these commands and then commit the results separately.
146146

147-
### `utils/autorefer.py` -- automatically add and update references in rules
148-
149-
When building a profile for a product-specific benchmark such as CIS or STIG,
150-
it is helpful to ensure all selected rules have that reference added. Usually
151-
these types of profiles are constructed by copying the benchmark's structure
152-
as a comment in the profile YAML file. For example:
153-
154-
```yaml
155-
selections:
156-
# 1 Initial Setup #
157-
## 1.1 Filesystem Configuration ##
158-
### 1.1.1 Disable unused filesystems ###
159-
#### 1.1.1.1 Ensure mounting of cramfs filesystems is disabled (Automated)
160-
- kernel_module_cramfs_disabled
161-
162-
#### 1.1.1.2 Ensure mounting of freevxfs filesystems is disabled (Automated)
163-
- kernel_module_freevxfs_disabled
164-
```
165-
166-
This utility automatically updates the rules below each section identifier with
167-
the relevant references. Currently CIS is the most supported reference format.
168-
169-
Iterating through each rule in the profile, we grab the reference identifier
170-
from the immediately preceding rule. The reference identifier MUST be the first
171-
token after the comment character(s) after a space. Another space character MAY
172-
follow, and then any additional content (such as the actual heading of this
173-
section in the benchmark).
174-
175-
Variable definitions are ignored.
176-
177-
To execute:
178-
179-
$ ./utils/autorefer.py <product> <profile> <reference>
180-
181-
For example:
182-
183-
$ ./utils/autorefer.py ubuntu2004 cis_level1_server cis
184-
185-
Note that it is generally good practice to commit all changes prior to running
186-
one of these commands and then commit the results separately.
187-
188147
### `utils/refchecker.py` -- automatically check `rule.yml` for references
189148

190149
This utility checks all `rule.yml` referenced from a given profile for the

0 commit comments

Comments
 (0)