diff options
Diffstat (limited to 'docs/docs/carbslinux/Shell-Conventions.html')
| -rw-r--r-- | docs/docs/carbslinux/Shell-Conventions.html | 105 |
1 files changed, 105 insertions, 0 deletions
diff --git a/docs/docs/carbslinux/Shell-Conventions.html b/docs/docs/carbslinux/Shell-Conventions.html new file mode 100644 index 0000000..5902238 --- /dev/null +++ b/docs/docs/carbslinux/Shell-Conventions.html @@ -0,0 +1,105 @@ +<!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>Shell Conventions (Carbs Linux User Manual)</title> + +<meta name="description" content="Shell Conventions (Carbs Linux User Manual)"> +<meta name="keywords" content="Shell 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="Conventions.html" rel="up" title="Conventions"> +<link href="Repository-Conventions.html" rel="next" title="Repository Conventions"> +<link href="Conventions.html" rel="prev" title="Conventions"> +<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="Shell-Conventions"></span><div class="header"> +<p> +Next: <a href="Repository-Conventions.html" accesskey="n" rel="next">Repository Conventions</a>, Up: <a href="Conventions.html" accesskey="u" rel="up">Conventions</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> +</div> +<hr> +<span id="Shell-Conventions-1"></span><h4 class="subsection">3.1.1 Shell Conventions</h4> + +<p>Shell is central to Carbs Linux projects. Most of the tools and packages are +written in POSIX sh. +</p> +<dl compact="compact"> +<dt>[<span id="g_t1010"></span>1010]</dt> +<dd><p>Use 4 spaces for indentation, don’t use tabs. +</p></dd> +<dt>[<span id="g_t1020"></span>1020]</dt> +<dd><p>Make sure you don’t use bash-specific code. +</p></dd> +<dt>[<span id="g_t1030"></span>1030]</dt> +<dd><p>Make sure you lint your code with ‘<samp>shellcheck</samp>’ and if +you are new to POSIX sh, use ‘<samp>checkbashisms</samp>’. +</p></dd> +<dt>[<span id="g_t1040"></span>1040]</dt> +<dd><p>Don’t spawn new processes if you don’t absolutely need +to, especially during string manipulation. +</p><dl compact="compact"> +<dt>[<span id="g_t1041"></span>1041]</dt> +<dd><p>Never use a program for text manupilation that isn’t +defined in the POSIX standard. This includes ‘<samp>gawk</samp>’ and ‘<samp>perl</samp>’. +</p></dd> +<dt>[<span id="g_t1042"></span>1042]</dt> +<dd><p>Instead of <code>$(basename $file)</code>, use <code>${file##*}</code>. +</p></dd> +<dt>[<span id="g_t1043"></span>1043]</dt> +<dd><p>Instead of <code>$(dirname $file)</code>, use <code>${file%/*}</code>. +</p></dd> +</dl> + +<div class="example"> +<pre class="example"># This is the same thing as basename /path/to/test.asc .asc + +$ file=/path/to/test.asc file=${file##*/} file=${file%.asc} +$ echo $file +test +</pre></div> +</dd> +<dt>[<span id="g_t1050"></span>1050]</dt> +<dd><p>Instead of backticks, use <code>$(..)</code>. +</p></dd> +</dl> + + + + +</body> +</html> |