diff options
Diffstat (limited to 'docs/docs/carbslinux/Conventions.html')
| -rw-r--r-- | docs/docs/carbslinux/Conventions.html | 97 |
1 files changed, 97 insertions, 0 deletions
diff --git a/docs/docs/carbslinux/Conventions.html b/docs/docs/carbslinux/Conventions.html new file mode 100644 index 0000000..b91b9a7 --- /dev/null +++ b/docs/docs/carbslinux/Conventions.html @@ -0,0 +1,97 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<!-- Copyright (C) 2020 Cem Keylan + +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with no +Invariant Sections, with no Front-Cover Texts and no Back-Cover Texts. +A copy of the license is included in the section entitled "GNU Free +Documentation License." + --> +<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<title>Conventions (Carbs Linux User Manual)</title> + +<meta name="description" content="Conventions (Carbs Linux User Manual)"> +<meta name="keywords" content="Conventions (Carbs Linux User Manual)"> +<meta name="resource-type" content="document"> +<meta name="distribution" content="global"> +<meta name="Generator" content="makeinfo"> +<link href="index.html" rel="start" title="Top"> +<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> +<link href="Contribution-Guidelines.html" rel="up" title="Contribution Guidelines"> +<link href="Shell-Conventions.html" rel="next" title="Shell Conventions"> +<link href="Contribution-Guidelines.html" rel="prev" title="Contribution Guidelines"> +<style type="text/css"> +<!-- +a.summary-letter {text-decoration: none} +blockquote.indentedblock {margin-right: 0em} +div.display {margin-left: 3.2em} +div.example {margin-left: 3.2em} +div.lisp {margin-left: 3.2em} +kbd {font-style: oblique} +pre.display {font-family: inherit} +pre.format {font-family: inherit} +pre.menu-comment {font-family: serif} +pre.menu-preformatted {font-family: serif} +span.nolinebreak {white-space: nowrap} +span.roman {font-family: initial; font-weight: normal} +span.sansserif {font-family: sans-serif; font-weight: normal} +ul.no-bullet {list-style: none} +--> +</style> +<link rel="stylesheet" type="text/css" href="https://www.gnu.org/software/gnulib/manual.css"> + + +</head> + +<body lang="en"> +<span id="Conventions"></span><div class="header"> +<p> +Up: <a href="Contribution-Guidelines.html" accesskey="u" rel="up">Contribution Guidelines</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +</div> +<hr> +<span id="Conventions-1"></span><h3 class="section">3.1 Conventions</h3> + + + +<dl compact="compact"> +<dt>[<span id="g_t0010"></span>0010]</dt> +<dd><p>Try to keep the file readable. +</p><dl compact="compact"> +<dt>[<span id="g_t0011"></span>0011]</dt> +<dd><p>Characters on a line shouldn’t exceed 100 characters. +</p></dd> +<dt>[<span id="g_t0012"></span>0012]</dt> +<dd><p>Make sure you don’t have code commented out during +commit. Uncomment them or remove them completely. +</p></dd> +<dt>[<span id="g_t0013"></span>0013]</dt> +<dd><p>Do not add comments following the code, add them to the +top of the code. It makes it harder to read, and lines longer. Here is an example: +</p></dd> +</dl> + +<div class="example"> +<pre class="example"># Good way of commenting. +your code goes here + +your code goes here # Avoid this way of commenting. +</pre></div> +</dd> +</dl> + +<table class="menu" border="0" cellspacing="0"> +<tr><td align="left" valign="top">• <a href="Shell-Conventions.html" accesskey="1">Shell Conventions</a></td><td> </td><td align="left" valign="top">Conventions for shell scripts +</td></tr> +<tr><td align="left" valign="top">• <a href="Repository-Conventions.html" accesskey="2">Repository Conventions</a></td><td> </td><td align="left" valign="top">Conventions for repository build scripts +</td></tr> +</table> + + + + +</body> +</html> |