[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[8f65da99] | 2 | <!DOCTYPE sect2 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
| 7 | <!ENTITY hatch-vcs-download-http "https://files.pythonhosted.org/packages/source/h/hatch-vcs/hatch_vcs-&hatch-vcs-version;.tar.gz">
|
---|
| 8 | <!ENTITY hatch-vcs-download-ftp " ">
|
---|
[569925c7] | 9 | <!ENTITY hatch-vcs-md5sum "&hatch-vcs-md5sum;">
|
---|
[8f65da99] | 10 | <!ENTITY hatch-vcs-size "9.9 KB">
|
---|
[b112f043] | 11 | <!ENTITY hatch-vcs-buildsize "436 KB (with tests)">
|
---|
[8f65da99] | 12 | <!ENTITY hatch-vcs-time "less than 0.1 SBU (with tests)">
|
---|
| 13 | ]>
|
---|
| 14 |
|
---|
[35879fc] | 15 | <sect2 id="hatch-vcs" xreflabel="hatch_vcs-&hatch-vcs-version;">
|
---|
[8f65da99] | 16 |
|
---|
[35879fc] | 17 | <title>Hatch_vcs-&hatch-vcs-version;</title>
|
---|
[8f65da99] | 18 |
|
---|
| 19 | <indexterm zone="hatch-vcs">
|
---|
[35879fc] | 20 | <primary sortas="a-hatch_vcs">hatch_vcs</primary>
|
---|
[8f65da99] | 21 | </indexterm>
|
---|
| 22 |
|
---|
| 23 | <sect3 role="package">
|
---|
| 24 | <title>Introduction to Hatch-vcs Module</title>
|
---|
| 25 |
|
---|
| 26 | <para>
|
---|
[35879fc] | 27 | <application>Hatch_vcs</application> is a Hatch plugin for versioning
|
---|
[8f65da99] | 28 | with several <xref linkend="gVCS"/>.
|
---|
| 29 | </para>
|
---|
| 30 |
|
---|
[09ddf35a] | 31 | &lfs122_checked;
|
---|
[8f65da99] | 32 |
|
---|
| 33 | <bridgehead renderas="sect4">Package Information</bridgehead>
|
---|
| 34 | <itemizedlist spacing="compact">
|
---|
| 35 | <listitem>
|
---|
| 36 | <para>
|
---|
| 37 | Download (HTTP): <ulink url="&hatch-vcs-download-http;"/>
|
---|
| 38 | </para>
|
---|
| 39 | </listitem>
|
---|
| 40 | <listitem>
|
---|
| 41 | <para>
|
---|
| 42 | Download (FTP): <ulink url="&hatch-vcs-download-ftp;"/>
|
---|
| 43 | </para>
|
---|
| 44 | </listitem>
|
---|
| 45 | <listitem>
|
---|
| 46 | <para>
|
---|
| 47 | Download MD5 sum: &hatch-vcs-md5sum;
|
---|
| 48 | </para>
|
---|
| 49 | </listitem>
|
---|
| 50 | <listitem>
|
---|
| 51 | <para>
|
---|
| 52 | Download size: &hatch-vcs-size;
|
---|
| 53 | </para>
|
---|
| 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
| 56 | <para>
|
---|
| 57 | Estimated disk space required: &hatch-vcs-buildsize;
|
---|
| 58 | </para>
|
---|
| 59 | </listitem>
|
---|
| 60 | <listitem>
|
---|
| 61 | <para>
|
---|
| 62 | Estimated build time: &hatch-vcs-time;
|
---|
| 63 | </para>
|
---|
| 64 | </listitem>
|
---|
| 65 | </itemizedlist>
|
---|
| 66 |
|
---|
[35879fc] | 67 | <bridgehead renderas="sect4">Hatch_vcs Dependencies</bridgehead>
|
---|
[8f65da99] | 68 |
|
---|
| 69 | <bridgehead renderas="sect5">Required</bridgehead>
|
---|
| 70 | <para role="required">
|
---|
| 71 | <xref linkend="hatchling"/> and
|
---|
| 72 | <xref linkend="setuptools_scm"/>
|
---|
| 73 | </para>
|
---|
| 74 |
|
---|
| 75 | <bridgehead renderas="sect5">Optional (for testing)</bridgehead>
|
---|
| 76 | <para role="optional">
|
---|
[f5096a7d] | 77 | <xref linkend='git'/> and <xref linkend="pytest"/>
|
---|
[8f65da99] | 78 | </para>
|
---|
| 79 |
|
---|
| 80 | </sect3>
|
---|
| 81 |
|
---|
| 82 | <sect3 role="installation">
|
---|
[35879fc] | 83 | <title>Installation of Hatch_vcs</title>
|
---|
[8f65da99] | 84 |
|
---|
| 85 | <para>Build the module: </para>
|
---|
| 86 |
|
---|
[082e722] | 87 | &build-wheel;
|
---|
[8f65da99] | 88 |
|
---|
| 89 | <para>
|
---|
| 90 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 91 | </para>
|
---|
| 92 |
|
---|
[082e722] | 93 | <screen role="root"><userinput>&install-wheel; hatch_vcs</userinput></screen>
|
---|
[8f65da99] | 94 |
|
---|
| 95 | <para>
|
---|
[f192a5c] | 96 | To test the installation, issue <command>pytest</command>. One test,
|
---|
| 97 | <application>tests/test_build.py::test_write</application>, is known
|
---|
| 98 | to fail.
|
---|
[8f65da99] | 99 | </para>
|
---|
| 100 |
|
---|
| 101 | </sect3>
|
---|
| 102 |
|
---|
| 103 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 104 | href="../../../xincludes/pip3-cmd-explain.xml"/>
|
---|
| 105 |
|
---|
| 106 | <sect3 role="content">
|
---|
| 107 | <title>Contents</title>
|
---|
| 108 |
|
---|
| 109 | <segmentedlist>
|
---|
| 110 | <segtitle>Installed Programs</segtitle>
|
---|
| 111 | <segtitle>Installed Libraries</segtitle>
|
---|
| 112 | <segtitle>Installed Directories</segtitle>
|
---|
| 113 |
|
---|
| 114 | <seglistitem>
|
---|
| 115 | <seg>None</seg>
|
---|
| 116 | <seg>None</seg>
|
---|
| 117 | <seg>
|
---|
| 118 | /usr/lib/python&python3-majorver;/site-packages/hatch_vcs and
|
---|
| 119 | /usr/lib/python&python3-majorver;/site-packages/hatch_vcs-&hatch-vcs-version;.dist-info
|
---|
| 120 | </seg>
|
---|
| 121 | </seglistitem>
|
---|
| 122 | </segmentedlist>
|
---|
| 123 |
|
---|
| 124 | </sect3>
|
---|
| 125 |
|
---|
| 126 | </sect2>
|
---|