mirror of
https://github.com/ibm-s390-linux/s390-tools.git
synced 2026-08-05 02:14:52 +00:00
c12c4af760
To get consistent and readable code let's try to advertise some common abbreviations. Signed-off-by: Michael Holzheu <holzheu@linux.vnet.ibm.com>
47 lines
2.4 KiB
Markdown
47 lines
2.4 KiB
Markdown
Coding guidelines for s390-tools
|
|
================================
|
|
|
|
For s390-tools the preferred language is C. We provide libraries, e.g. libutil
|
|
that should be used by all tools if possible.
|
|
|
|
The coding style is based on the Linux kernel guidelines. Therefore, use
|
|
the checkpatch tool for verification before you submit a patch:
|
|
|
|
- https://github.com/torvalds/linux/blob/master/scripts/checkpatch.pl
|
|
|
|
Below we describe some additional things that we want you to consider when
|
|
writing new code for s390-tools.
|
|
|
|
This package started in 2001 and has a long "tradition" - therefore, older tools
|
|
might not follow all recommendations. Note that when changing existing code,
|
|
consistency could have priority over applying rules.
|
|
|
|
Standard abbreviations
|
|
----------------------
|
|
|
|
The abbreviations below are recommended to be used in the source code.
|
|
|
|
| __Short Name__ | __Long Name__ |
|
|
|:----------------|:--------------------------------------------------|
|
|
| attr | Attribute |
|
|
| blk | Block |
|
|
| buf | Buffer |
|
|
| col | Column |
|
|
| count | Count |
|
|
| desc | Description |
|
|
| dir | Directory |
|
|
| fd | File descriptor (open) |
|
|
| fp | File pointer (fopen) |
|
|
| len | Length |
|
|
| lib | Library |
|
|
| mod | Module |
|
|
| nr | Number |
|
|
| parm | Parameter |
|
|
| path | File path |
|
|
| ptr | Pointer |
|
|
| rc | Return code |
|
|
| size | Size |
|
|
| src | Source |
|
|
| str | String |
|
|
| sym | Symbol |
|