Skip to content

Guideline for one_liners

adrianbartyczak edited this page Mar 15, 2019 · 16 revisions

Guideline for one-liners in Gnu-linux-shell-use.

  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 other document section can be included if necessary.
  • A document line is a maximum length of 120 characters.
  • A continued document line is indented 2 spaces.

For an example, see cpu-property-information-retrieval.one-liners.

Code style

General

Lines and indentation
  • A one-liner must be on a single line and has no maximum length.
Variables
  • A variable name uses acronyms whenever possible.