Guideline for one_liners

Guideline for one-liners in General-purpose-computing.

1. Format
2. Code style

Format

One-liner files are created in the following format:

# Description
one-liner

# Description
one-liner

# Description
# Note: Note line 1
#   Note line 2
#   ...
one-liner

• Any documentation section not shown is included if necessary.

---

For an example, see cpu-hardware-management.one-liners.

Code style

General

Lines and indentation

• A one-liner must be on a single line and has no maximum length.
• A documentation line is a maximum length of 120 characters.
• A continued documentation line is indented 2 spaces.

Variables

• A variable name uses acronyms whenever possible.