See cclib/cclib@1c7aa93 from refs/heads/master

Author: cclib

_sources/development.rst.txt

@@ -197,8 +197,13 @@ Adding a new program version
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 There are a few conventions when adding a new supported program version to the unit tests:
+
 * Two different recent versions are typically used in the unit tests. If there already are two, move the older version(s) the regression suite (see below).
-* When adding files for the new version, first copy the corresponding files for the last version already in cclib. Afterwards, check in files from the new program version as changes to the copied files. This procedure makes it easy to look at the differences introduced with the new version in git clients.
+* When adding files for the new version:
+
+  #. Make a commit that copies the corresponding files from the last version already in cclib to the new directory.
+  #. Make a commit that replaces these files with those for the actual new version. This procedure makes it easy to look at the differences introduced with the new version in git clients.
+  #. See https://github.com/cclib/cclib/pull/575/commits for an example.
 
 .. index::
     single: testing; regressions
@@ -221,7 +226,7 @@ Using both the unit and regression tests, the line-by-line `test coverage`_ show
 Adding a new regression test
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-A regression test consists of one or more output files and optionally a test function or class.
+A regression test consists of one or more output files and optionally a test function and/or multiple test classes.
 
 New regression tests are added by creating entries in `regressionfiles.yaml`_. There are three kinds of tests:
 

_sources/how_to_install.rst.txt

@@ -80,17 +80,18 @@ There are in fact multiple packages, `python3-cclib`_ containing the Python modu
 .. _`Debian GNU/Linux`: https://www.debian.org
 .. _`Ubuntu`: https://ubuntu.com/
 .. _`cclib packages`: https://packages.debian.org/search?searchon=sourcenames&keywords=cclib
-.. _`python3-cclib`: https://packages.debian.org/bullseye/python3-cclib
-.. _`cclib`: https://packages.debian.org/bullseye/cclib
-.. _`cclib-data`: https://packages.debian.org/bullseye/cclib-data
+.. _`python3-cclib`: https://packages.debian.org/bookworm/python3-cclib
+.. _`cclib`: https://packages.debian.org/bookworm/cclib
+.. _`cclib-data`: https://packages.debian.org/bookworm/cclib-data
 
 Manual download and install
 ---------------------------
 
 The source code of the newest release of cclib (version |release|) is distributed as:
- * A .zip file: https://github.com/cclib/cclib/releases/download/v1.8.1/cclib-1.8.1.zip
- * A .tar.gz file: https://github.com/cclib/cclib/releases/download/v1.8.1/cclib-1.8.1.tar.gz
- * Windows binary installers (see the `newest release page`_)
+
+* A .zip file: https://github.com/cclib/cclib/releases/download/v1.8.1/cclib-1.8.1.zip
+* A .tar.gz file: https://github.com/cclib/cclib/releases/download/v1.8.1/cclib-1.8.1.tar.gz
+* Windows binary installers (see the `newest release page`_)
 
 On Windows, if you choose to download the .exe files instead, you can install simply by double-clicking on the file. To uninstall, use the "Add and Remove Programs" menu in the Control Panel.
 

development.html

@@ -239,9 +239,17 @@ <h4>Adding a new unit test<a class="headerlink" href="#adding-a-new-unit-test" t
 </section>
 <section id="adding-a-new-program-version">
 <h4>Adding a new program version<a class="headerlink" href="#adding-a-new-program-version" title="Link to this heading"></a></h4>
-<p>There are a few conventions when adding a new supported program version to the unit tests:
-* Two different recent versions are typically used in the unit tests. If there already are two, move the older version(s) the regression suite (see below).
-* When adding files for the new version, first copy the corresponding files for the last version already in cclib. Afterwards, check in files from the new program version as changes to the copied files. This procedure makes it easy to look at the differences introduced with the new version in git clients.</p>
+<p>There are a few conventions when adding a new supported program version to the unit tests:</p>
+<ul class="simple">
+<li><p>Two different recent versions are typically used in the unit tests. If there already are two, move the older version(s) the regression suite (see below).</p></li>
+<li><p>When adding files for the new version:</p>
+<ol class="arabic simple">
+<li><p>Make a commit that copies the corresponding files from the last version already in cclib to the new directory.</p></li>
+<li><p>Make a commit that replaces these files with those for the actual new version. This procedure makes it easy to look at the differences introduced with the new version in git clients.</p></li>
+<li><p>See <a class="reference external" href="https://github.com/cclib/cclib/pull/575/commits">https://github.com/cclib/cclib/pull/575/commits</a> for an example.</p></li>
+</ol>
+</li>
+</ul>
 </section>
 </section>
 <section id="regression-tests">
@@ -251,7 +259,7 @@ <h4>Adding a new program version<a class="headerlink" href="#adding-a-new-progra
 <p>Using both the unit and regression tests, the line-by-line <a class="reference external" href="coverage/index.html">test coverage</a> shows which parts of cclib are touched by at least one test. When adding new features and tests, the GitHub Actions <a class="reference external" href="https://github.com/cclib/cclib/blob/master/.github/scripts/run_pytest.bash">testing script</a> can be run locally to generate the HTML coverage pages and ensure that the tests exercise the feature code.</p>
 <section id="adding-a-new-regression-test">
 <h4>Adding a new regression test<a class="headerlink" href="#adding-a-new-regression-test" title="Link to this heading"></a></h4>
-<p>A regression test consists of one or more output files and optionally a test function or class.</p>
+<p>A regression test consists of one or more output files and optionally a test function and/or multiple test classes.</p>
 <p>New regression tests are added by creating entries in <a class="reference external" href="https://github.com/cclib/cclib-data/blob/master/regressionfiles.yaml">regressionfiles.yaml</a>. There are three kinds of tests:</p>
 <ul class="simple">
 <li><p>A regression may be parsed, but specific attributes on the regression are not checked: no test function or class is added.</p></li>

how_to_install.html

@@ -150,18 +150,16 @@ <h2>Installing using a system package manager<a class="headerlink" href="#instal
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>apt<span class="w"> </span>install<span class="w"> </span>cclib
 </pre></div>
 </div>
-<p>There are in fact multiple packages, <a class="reference external" href="https://packages.debian.org/bullseye/python3-cclib">python3-cclib</a> containing the Python module, and <a class="reference external" href="https://packages.debian.org/bullseye/cclib">cclib</a> which installs the user scripts and depends on the Python module. If you also need to also install the unittests and logfiles we distribute, you will need to install the <a class="reference external" href="https://packages.debian.org/bullseye/cclib-data">cclib-data</a> package from the non-free repositories (due to license issues). Because of distribution release cycles, package manager versions of cclib may be out of date compared to the PyPI version.</p>
+<p>There are in fact multiple packages, <a class="reference external" href="https://packages.debian.org/bookworm/python3-cclib">python3-cclib</a> containing the Python module, and <a class="reference external" href="https://packages.debian.org/bookworm/cclib">cclib</a> which installs the user scripts and depends on the Python module. If you also need to also install the unittests and logfiles we distribute, you will need to install the <a class="reference external" href="https://packages.debian.org/bookworm/cclib-data">cclib-data</a> package from the non-free repositories (due to license issues). Because of distribution release cycles, package manager versions of cclib may be out of date compared to the PyPI version.</p>
 </section>
 <section id="manual-download-and-install">
 <h2>Manual download and install<a class="headerlink" href="#manual-download-and-install" title="Link to this heading"></a></h2>
-<dl class="simple">
-<dt>The source code of the newest release of cclib (version 1.8.1) is distributed as:</dt><dd><ul class="simple">
+<p>The source code of the newest release of cclib (version 1.8.1) is distributed as:</p>
+<ul class="simple">
 <li><p>A .zip file: <a class="reference external" href="https://github.com/cclib/cclib/releases/download/v1.8.1/cclib-1.8.1.zip">https://github.com/cclib/cclib/releases/download/v1.8.1/cclib-1.8.1.zip</a></p></li>
 <li><p>A .tar.gz file: <a class="reference external" href="https://github.com/cclib/cclib/releases/download/v1.8.1/cclib-1.8.1.tar.gz">https://github.com/cclib/cclib/releases/download/v1.8.1/cclib-1.8.1.tar.gz</a></p></li>
 <li><p>Windows binary installers (see the <a class="reference external" href="https://github.com/cclib/cclib/releases/tag/v1.8.1">newest release page</a>)</p></li>
 </ul>
-</dd>
-</dl>
 <p>On Windows, if you choose to download the .exe files instead, you can install simply by double-clicking on the file. To uninstall, use the “Add and Remove Programs” menu in the Control Panel.</p>
 <p>None of these files include the tests and logfiles used for testing. In order to download all tests, we also provide source archives on the <a class="reference external" href="https://github.com/cclib/cclib/releases/tag/v1.8.1">newest release page</a>.</p>
 <p>If you are using the .zip or .tar.gz files, extract the contents of the file at an appropriate location, which we will call INSTALLDIR. Open a command prompt and change directory to INSTALLDIR. Next, run the following commands to install cclib:</p>