diff options
Diffstat (limited to 'docs/docs/Repository-Conventions.html')
| -rw-r--r-- | docs/docs/Repository-Conventions.html | 81 |
1 files changed, 36 insertions, 45 deletions
diff --git a/docs/docs/Repository-Conventions.html b/docs/docs/Repository-Conventions.html index e333ff6..598cc7a 100644 --- a/docs/docs/Repository-Conventions.html +++ b/docs/docs/Repository-Conventions.html @@ -7,7 +7,8 @@ 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." --> +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"> @@ -21,7 +22,7 @@ Documentation License." --> <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="Sending-Git-mails.html" rel="next" title="Sending Git mails"> +<link href="GNU-Free-Documentation-License.html" rel="next" title="GNU Free Documentation License"> <link href="Shell-Conventions.html" rel="prev" title="Shell Conventions"> <style type="text/css"> <!-- @@ -51,52 +52,49 @@ ul.no-bullet {list-style: none} Previous: <a href="Shell-Conventions.html" accesskey="p" rel="prev">Shell 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="Repository-Conventions-_002d_002d-20"></span><h4 class="subsection">4.1.3 Repository Conventions – 20</h4> +<span id="Repository-Conventions-1"></span><h4 class="subsection">3.1.2 Repository Conventions</h4> <p>Repository conventions are important in order to ensure every package resemble themselves. Here are the things to keep in mind: </p> <dl compact="compact"> -<dt><strong>[<span id="g_t2010"></span>2010]</strong></dt> -<dd><p>Prefer tarballs over git packages unless there is a sensible reason. -Here are some: -</p> -<ul> +<dt>[<span id="g_t2010"></span>2010]</dt> +<dd><p>Prefer tarballs over git packages unless there is a +sensible reason. Here are some: +</p><ul> <li> Every patch is a new release. (See <a href="https://github.com/vim/vim">vim</a>) -</li><li> There are no releases. (See <a href="https://git.suckless.org/sbase">https://git.suckless.org/sbase</a>) +</li><li> There are no releases. (See <a href="https://git.suckless.org/sbase">sbase</a>) </li><li> Following a development branch. -</li><li> There has been a long time since the latest release, but upstream is far ahead. +</li><li> There has been a long time since the latest release, but upstream is far +ahead. </li></ul> - </dd> -<dt><strong>[<span id="g_t2020"></span>2020]</strong></dt> -<dd><p>Prefer sources without a dependency to <code>automake</code>. There are usually -distribution tarballs that are <code>autoconf</code>’ed. Don’t submit tarballs -with an automake dependency unless you are <strong>sure</strong> there is no -alternative. +<dt>[<span id="g_t2020"></span>2020]</dt> +<dd><p>Prefer sources without a dependency to ‘<samp>automake</samp>’. There +are usually distribution tarballs that are ‘<samp>autoconf</samp>’’ed. Don’t submit tarballs +with an automake dependency unless you are ‘<samp>sure</samp>’ there is no alternative. </p></dd> -<dt><strong>[<span id="g_t2030"></span>2030]</strong></dt> +<dt>[<span id="g_t2030"></span>2030]</dt> <dd><p>Avoid these packages: </p><dl compact="compact"> -<dt><code>dbus</code></dt> -<dd><p>Usually can be disabled by <samp>--disable-dbus</samp> +<dt>dbus</dt> +<dd><p>Usually can be disabled by <code>--disable-dbus</code>. </p></dd> -<dt><code>gettext</code></dt> -<dd><p>Usually can be disabled by <samp>--disable-nls</samp> +<dt>gettext</dt> +<dd><p>Usually can be disabled by <code>--disable-nls</code>. </p></dd> </dl> </dd> -<dt><strong>[<span id="g_t2040"></span>2040]</strong></dt> +<dt>[<span id="g_t2040"></span>2040]</dt> <dd><ul> -<li> Always install a package to the <samp>/usr</samp> prefix. -</li><li> All binaries should go to <samp>/usr/bin</samp>, not <samp>/usr/sbin</samp> or any other -directory. -</li><li> All libraries should go to <samp>/usr/lib</samp>. +<li> Always install a package to the ‘<samp>/usr</samp>’ prefix. +</li><li> All binaries should go to ‘<samp>/usr/bin</samp>’, not ‘<samp>/usr/sbin</samp>’ or any other directory. +</li><li> All libraries should go to ‘<samp>/usr/lib</samp>’. </li></ul> </dd> -<dt><strong>[<span id="g_t2050"></span>2050]</strong></dt> -<dd><p>All build files on the repository should be a POSIX shell script, and must start -with <code>#!/bin/sh -e</code>. +<dt>[<span id="g_t2050"></span>2050]</dt> +<dd><p>All build files on the repository should be a POSIX +shell script, and must start with <code>#!/bin/sh -e</code>. </p></dd> </dl> @@ -104,10 +102,10 @@ with <code>#!/bin/sh -e</code>. ensure stylistic consistency. Note that the option configurations shouldn’t be taken literally, they are meant as examples. </p> +<ol> +<li> Make [<span id="g_t2210"></span>2210] -<p><strong>[<span id="g_t2210"></span>2210] Make</strong> -</p> <div class="example"> <pre class="example">#!/bin/sh -e @@ -115,10 +113,9 @@ make make DESTDIR="$1" PREFIX=/usr install </pre></div> +</li><li> Configure/Make [<span id="g_t2211"></span>2211] -<p><strong>[<span id="g_t2211"></span>2211] Configure/Make</strong> -</p> <div class="example"> <pre class="example">#!/bin/sh -e @@ -131,10 +128,9 @@ make make DESTDIR="$1" install </pre></div> +</li><li> Autoconf/Automake [<span id="g_t2212"></span>2212] -<p><strong>[<span id="g_t2212"></span>2212] Autoconf/Automake</strong> -</p> <p>See <a href="#g_t2020">2020</a> </p> <div class="example"> @@ -151,10 +147,9 @@ make make DESTDIR="$1" install </pre></div> +</li><li> Meson [<span id="g_t2220"></span>2220] -<p><strong>[<span id="g_t2220"></span>2220] Meson</strong> -</p> <div class="example"> <pre class="example">#!/bin/sh -e @@ -170,10 +165,9 @@ ninja -C output ninja -C output install </pre></div> +</li><li> Cmake [<span id="g_t2230"></span>2230] -<p><strong>[<span id="g_t2230"></span>2230] Cmake</strong> -</p> <div class="example"> <pre class="example">#!/bin/sh -e @@ -188,10 +182,9 @@ cmake --build build cmake --install build </pre></div> +</li><li> Go [<span id="g_t2240"></span>2240] -<p><strong>[<span id="g_t2240"></span>2240] Go</strong> -</p> <div class="example"> <pre class="example">#!/bin/sh -e @@ -203,18 +196,16 @@ go build install -Dm755 program "$1/usr/bin/program" </pre></div> +</li><li> Python [<span id="g_t2241"></span>2241] -<p><strong>[<span id="g_t2241"></span>2241] Python</strong> -</p> <div class="example"> <pre class="example">#!/bin/sh -e python setup.py build python setup.py install --prefix=/usr --root="$1" </pre></div> - - +</li></ol> <hr> <div class="header"> |