GNOME.org
 

[pygobject] docs: remove/update everything autotools related

commit df64a58d6f1677a179e9815f18bb66995f6a1a76
Author: Christoph Reiter <reiter christoph gmail com>
Date:   Tue Mar 27 23:31:33 2018 +0200

    docs: remove/update everything autotools related

 docs/devguide/building_testing.rst | 48 +++++----------------
 docs/devguide/dev_environ.rst      | 86 --------------------------------------
 docs/maintguide.rst                | 22 +++++-----
 docs/packagingguide.rst            | 20 +++------
 4 files changed, 26 insertions(+), 150 deletions(-)
---
diff --git a/docs/devguide/building_testing.rst b/docs/devguide/building_testing.rst
index 963bb85b..4f4c0758 100644
--- a/docs/devguide/building_testing.rst
+++ b/docs/devguide/building_testing.rst
@@ -11,43 +11,6 @@ To pass extra arguments to pytest you can set "PYTEST_ADDOPTS":
     python3 setup.py test
 
 
-Using Autotools
----------------
-
-.. code:: shell
-
-    # Building for Python 2
-    ./autogen.sh --with-python=python2
-    make
-
-    # Building for Python 3
-    ./autogen.sh --with-python=python3
-    make
-
-    # Executing some code after the build
-    PYTHONPATH=. python3 foo.py
-
-    # To run the test suite
-    make check
-
-    # To test only a specific file/class/function::
-    make check TEST_NAMES=test_gi
-    make check TEST_NAMES=test_gi.TestUtf8
-    make check TEST_NAMES=test_gi.TestUtf8.test_utf8_full_return
-
-    # To display stdout and pytest verbose output:
-    PYGI_TEST_VERBOSE=yes make check
-
-    # To execute all the tests in a gdb session
-    make check.gdb
-
-    # To executes all the tests in valgrind
-    make check.valgrind
-
-    # To execute flake8 tests
-    make check.quality
-
-
 Using Setuptools
 ----------------
 
@@ -72,9 +35,20 @@ Using Setuptools
 
     # To display stdout and pytest verbose output:
     PYGI_TEST_VERBOSE=yes python3 setup.py test
+    # or:
+    python3 setup.py test -s
 
     # using pytest directly
     py.test-3 tests/test_gi.py
 
     # Running flake8 tests
     python3 setup.py quality
+
+    # Run under gdb
+    python3 setup.py test --gdb
+
+    # Run under valgrind
+    python3 setup.py test --valgrind --valgrind-log-file=valgrind.log
+
+    # Create a release tarball for GNOME
+    python3 setup.py sdist_gnome
diff --git a/docs/devguide/dev_environ.rst b/docs/devguide/dev_environ.rst
index d94abf48..3e0db366 100644
--- a/docs/devguide/dev_environ.rst
+++ b/docs/devguide/dev_environ.rst
@@ -259,92 +259,6 @@ additional steps:
     pipenv install flake8
     pipenv shell
 
-.. _additional-platform-steps:
-
-Additional Steps Per Platform
-=============================
-
-================================================= ============================================== 
====================================================
-|ubuntu-logo| :ref:`Ubuntu <ubuntu-pygobject>`    |fedora-logo| :ref:`Fedora <fedora-pygobject>` |arch-logo| 
:ref:`Arch Linux <arch-pygobject>`
-|windows-logo| :ref:`Windows <windows-pygobject>` |macosx-logo| :ref:`macOS <macosx-pygobject>`  
|opensuse-logo| :ref:`openSUSE <opensuse-pygobject>`
-================================================= ============================================== 
====================================================
-
-.. _ubuntu-pygobject:
-
-|ubuntu-logo| Ubuntu / |debian-logo| Debian
--------------------------------------------
-
-.. code:: console
-
-    sudo apt build-pygobject pygobject
-    sudo apt install autoconf-archive
-    ./autogen.sh
-    make
-    make check
-
-
-.. _fedora-pygobject:
-
-|fedora-logo| Fedora
---------------------
-
-.. code:: console
-
-    sudo dnf build pygobject
-    ./autogen.sh
-    make
-    make check
-
-
-.. _arch-pygobject:
-
-|arch-logo| Arch Linux
-----------------------
-
-.. code:: console
-
-    makepkg -s pygobject
-    ./autogen.sh
-    make
-    make check
-
-
-.. _opensuse-pygobject:
-
-|opensuse-logo| openSUSE
-------------------------
-
-.. code:: console
-
-    sudo zypper si -d python3-gobject
-    ./autogen.sh
-    make
-    make check
-
-
-.. _windows-pygobject:
-
-|windows-logo| Windows
-----------------------
-
-.. code:: console
-
-    pacman -S --needed --noconfirm autoconf-archive
-    ./autogen.sh
-    make
-    make check
-
-
-.. _macosx-pygobject:
-
-|macosx-logo| macOS
--------------------
-
-.. code:: console
-
-    ./autogen.sh
-    make
-    make check
 
 .. _pyenv: https://github.com/pyenv/pyenv
 .. _pipsi: https://github.com/mitsuhiko/pipsi
diff --git a/docs/maintguide.rst b/docs/maintguide.rst
index 88f015fc..5715ab88 100644
--- a/docs/maintguide.rst
+++ b/docs/maintguide.rst
@@ -5,24 +5,22 @@ Maintainer Guide
 Making a Release
 ----------------
 
-#. Make sure configure.ac has the right version number
-#. Update NEWS file (use ``make release-news`` target and then edit as you see
-   fit)
-#. Run ``make distcheck``, fix any issues and commit.
+#. Make sure setup.py has the right version number
+#. Update NEWS file
+#. Run ``python3 setup.py distcheck``, fix any issues and commit.
 #. Commit NEWS as ``"release 3.X.Y"`` and push
 #. Tag with: ``git tag -s 3.X.Y -m "release 3.X.Y"``
 #. Push tag with: ``git push origin 3.X.Y``
-#. In case of a stable release ``python3 setup.py distcheck`` and
-   ``python3 setup.py sdist register upload``
-#. Commit post-release version bump to configure.ac
-#. Upload tarball: ``scp pygobject-3.X.Y.tar.gz user master gnome org:``
+#. In case of a stable release, upload to PyPI:
+   ``twine upload dist/PyGObject-3.X.Y.tar.gz``
+#. Commit post-release version bump to setup.py
+#. Create GNOME tarball ``python3 setup.py sdist_gnome``
+#. Upload tarball: ``scp pygobject-3.X.Y.tar.xz user master gnome org:``
 #. Install tarball:
-   ``ssh user master gnome org 'ftpadmin install pygobject-3.X.Y.tar.gz'``
+   ``ssh user master gnome org 'ftpadmin install pygobject-3.X.Y.tar.xz'``
 #. In case the release happens on a stable branch copy the NEWS changes to
    the master branch
 
-Based on https://wiki.gnome.org/MaintainersCorner/Releasing
-
 
 Branching
 ---------
@@ -32,5 +30,5 @@ can continue in the master branch unaffected by the freezes.
 
 #. Create the branch locally with: ``git checkout -b pygobject-3-2``
 #. Push new branch: ``git push origin pygobject-3-2``
-#. In master, update configure.ac to what will be the next version number
+#. In master, update setup.py to what will be the next version number
    (3.3.0)
diff --git a/docs/packagingguide.rst b/docs/packagingguide.rst
index ab1fffe7..7d6fafa9 100644
--- a/docs/packagingguide.rst
+++ b/docs/packagingguide.rst
@@ -6,19 +6,17 @@ Some notes on how to package PyGObject
 Source packages can be found at
 https://ftp.gnome.org/pub/GNOME/sources/pygobject
 
-
 Existing Packages:
 
 * https://www.archlinux.org/packages/extra/x86_64/python-gobject
-* https://packages.qa.debian.org/p/pygobject.html
+* https://tracker.debian.org/pkg/pygobject
 * https://github.com/Alexpux/MINGW-packages/tree/master/mingw-w64-pygobject
 
-
 Building::
 
-    ./configure --with-python=${PYTHON} --prefix="${PREFIX}"
-    make check # if you want to run the test suite
-    make DESTDIR="${PKGDIR}" install
+    python3 setup.py build
+    python3 setup.py test # if you want to run the test suite
+    python3 setup.py install --prefix="${PREFIX}" --root="${PKGDIR}"
 
 Runtime dependencies:
 
@@ -37,15 +35,7 @@ Build dependencies:
     * cairo (optional)
     * pycairo (optional)
     * pkg-config
-
-    If autotools is used:
-
-        * gnome-common for PyGObject < 3.26
-        * autoconf-archive for PyGObject >= 3.26
-
-    If setup.py is used:
-
-        * setuptools
+    * setuptools (optional)
 
 Test Suite dependencies:
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]