Skip to content

Latest commit

 

History

History
78 lines (56 loc) · 2.49 KB

README.md

File metadata and controls

78 lines (56 loc) · 2.49 KB

libkdumpfile

Kernel coredump file access

To compile this package, you'll need the following:

  • zlib. You can usually find it in a zlib-devel package.
  • lzo. Often found in a lzo-devel package.
  • snappy. Often found in a snappy-devel package.
  • libzstd. Often found in a libzstd-devel package.
  • GNU C Library. Almost any version will do. Other C libraries may also work, but since there is no standard interface for byte-order macros, this may need some porting.
  • GCC. The source uses a few construct specific to GCC (such as variable attributes). Porting should be easy, though.

If you want to build kdumpid, you'll also need:

  • BFD. Any version with disassemblers for x86, ppc and s390 will do. This usually comes with the distro packaged as binutils-devel or similar.

To create documentation files, you'll need:

  • Doxygen. Usually packaged as doxygen.

Once you've got the prerequisites, simply unpack the tarball and run

./configure
make
make install

To generate documentation files, run:

make doxygen-doc

If you updated directly from git, there is no configure script. That's becuase this script itself is generated by autoconf. To bootstrap this project from scratch, you will need:

To generate the configure script, run

autoreconf -fi

Python

This repository contains some manually written Python bindings. These are now deprecated in favour of a fresh rewrite using CFFI. See pykdumpfile.

Making Releases

To make a new public release:

  1. Make sure that the NEWS file is updated with all important changes

  2. Update the version information:

    • configure.ac: update pkg_version_* macros
    • src/Makefile.am: libtool versioning (see Libtool info file)
    • src/addrxlat/Makefile.am: addrxlat libtool versioning
  3. Make a new commit ("Prepare release x.y.z")

  4. Run make distcheck

  5. Create a signed tag using git tag -s

  6. Upload the tarballs to GitHub and create a new release

  7. Write an announcement