Merge drgn/master to 6.0/stage

.github/workflows/ci.yml

@@ -0,0 +1,41 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.9, 3.8, 3.7, 3.6]
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install busybox-static libelf-dev libdw-dev qemu-kvm zstd
+          pip install mypy
+      - name: Generate version.py
+        run: python setup.py --version
+      - name: Check with mypy
+        run: mypy --strict --no-warn-return-any drgn _drgn.pyi
+      - name: Build and test
+        run: python setup.py test -K
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+      - name: Install dependencies
+        run: pip install black isort
+      - name: Check with black
+        run: black --check --diff .
+      - name: Check with isort
+        run: isort --check --diff .

CONTRIBUTING.rst

@@ -87,6 +87,40 @@ Submitting PRs
 Pull requests and issues are always welcome. Feel free to start a discussion
 with a prototype.
 
+Signing Off
+^^^^^^^^^^^
+
 All commits must be signed off (i.e., ``Signed-off-by: Jane Doe
 <[email protected]>``) as per the `Developer Certificate of Origin
 <https://developercertificate.org/>`_. ``git commit -s`` can do this for you.
+
+Separating Changes
+^^^^^^^^^^^^^^^^^^
+
+Each logical change should be a separate commit. For example, if a PR adds new
+functionality to the core library and a new helper that uses the new
+functionality, the core change and the helper should be separate commits. This
+makes code review much easier.
+
+Each commit should build, pass tests, follow coding guidelines, and run
+correctly. (In other words, within a PR, later commits often build on top of
+earlier commits, but later commits shouldn't need to "fix" earlier commits.)
+This makes it easier to track down problems with tools like ``git bisect``
+which may check out any commit in the middle of a PR.
+
+Commit Messages
+^^^^^^^^^^^^^^^
+
+The template for a good commit message is:
+
+.. code-block:: none
+
+    One line summary
+
+    Longer explanation including more details, background, and/or
+    motivation.
+
+    Signed-off-by: Jane Doe <[email protected]>
+
+See `this post <https://chris.beams.io/posts/git-commit/>`_ for more
+information about writing good commit messages.

README.rst

@@ -5,9 +5,9 @@ drgn
     :target: https://pypi.org/project/drgn/
     :alt: PyPI
 
-.. image:: https://travis-ci.org/osandov/drgn.svg?branch=master
-    :target: https://travis-ci.org/osandov/drgn
-    :alt: Build Status
+.. image:: https://github.com/osandov/drgn/workflows/CI/badge.svg
+    :target: https://github.com/osandov/drgn/actions
+    :alt: CI Status
 
 .. image:: https://readthedocs.org/projects/drgn/badge/?version=latest
     :target: https://drgn.readthedocs.io/en/latest/?badge=latest
@@ -62,13 +62,13 @@ Arch Linux:
 
 .. code-block:: console
 
-    $ sudo pacman -S --needed autoconf automake bison bzip2 flex gawk gcc libtool make pkgconf python python-setuptools xz zlib
+    $ sudo pacman -S --needed autoconf automake gawk gcc libelf libtool make pkgconf python python-setuptools
 
 Debian/Ubuntu:
 
 .. code-block:: console
 
-    $ sudo apt-get install autoconf automake bison flex gawk gcc libbz2-dev liblzma-dev libtool make pkgconf python3 python3-dev python3-setuptools zlib1g-dev
+    $ sudo apt-get install autoconf automake gawk gcc libelf-dev libdw-dev libtool make pkgconf python3 python3-dev python3-setuptools
 
 Note that Debian Stretch, Ubuntu Trusty, and Ubuntu Xenial (and older) ship
 Python versions which are too old. Python 3.6 or newer must be installed
@@ -78,7 +78,7 @@ Fedora:
 
 .. code-block:: console
 
-    $ sudo dnf install autoconf automake bison bzip2-devel flex gawk gcc libtool make pkgconf python3 python3-devel python3-setuptools xz-devel zlib-devel
+    $ sudo dnf install autoconf automake elfutils-devel gawk gcc libtool make pkgconf python3 python3-devel python3-setuptools
 
 Optionally, install: