/usr/share/gtk-doc/html/libdmapsharing-3.0/coding-standards.html is in libdmapsharing-3.0-dev 2.9.14-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Libdmapsharing Coding Standards</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="libdmapsharing Reference Manual">
<link rel="up" href="ch03.html" title="Libdmapsharing Internals">
<link rel="prev" href="ch03.html" title="Libdmapsharing Internals">
<link rel="next" href="server-internals.html" title="Libdmapsharing Server Internals">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
<td><a accesskey="p" href="ch03.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch03.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libdmapsharing Reference Manual</th>
<td><a accesskey="n" href="server-internals.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="coding-standards"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle">Libdmapsharing Coding Standards</span></h2>
<p>Libdmapsharing Coding Standards —
Description of libdmapsharing's coding standards
</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="id533880"></a><h2>Libdmapsharing Coding Standards</h2>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">Use tabs to indent</li>
<li class="listitem">Use spaces to align</li>
<li class="listitem">Attempt to limit lines to 80 characters</li>
<li class="listitem">Use whitespace to keep expressions clear:
<pre class="programlisting">
int foo = x + 1 - bar (y);
</pre>
</li>
<li class="listitem">In order to protect against an accidental use of assignment in a Boolean expression, use:
<pre class="programlisting">if (CONSTANT == variable)</pre>
not:
<pre class="programlisting">if (variable == CONSTANT)</pre>
</li>
<li class="listitem">Braces should be formatted as follows:
<pre class="programlisting">
if (foo) {
something ();
}
</pre>
or, in the case of function definitions:
<pre class="programlisting">
void foo (void)
{
something ();
}
</pre>
</li>
<li class="listitem">Place a semicolon following function-like preprocessor macros because the lack of one might confuse tools such as <span class="application">indent</span> (even if the semicolon is actually repetitive):
<pre class="programlisting">
CPPFUNC(foo);
</pre>
</li>
<li class="listitem">Perform a Git commit after finishing a single
task</li>
<li class="listitem">Patches submitted should perform one task (e.g.,
don't add functionality and reformat existing code in the same
patch)</li>
<li class="listitem">Git commit messages should be of the following form:
<div class="literallayout"><p>single line summary with no period<br>
<br>
Optional detailed description. This should use paragraph grammar,<br>
including periods. This may be any number of lines long. Paragraphs are<br>
separated by an empty line but are not indented. Lines are less than 80<br>
characters long.<br>
</p></div>
</li>
<li class="listitem">Use GObject conventions for things not covered here</li>
<li class="listitem">You may use the following indent command to format libdmapsharing code:
<pre class="programlisting">
indent -i8 -bad -bap -br -ce -d0 -ndj -lp -pcs -psl -sc -sob foo.c
</pre>
</li>
</ul></div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|