Next generation libstorage
Clone or download
aschnell Merge pull request #582 from MeggyCal/patch-1
make format of po files consistent with gettext
Latest commit b5b8100 Oct 19, 2018
Permalink
Failed to load latest commit information.
bindings Allow bcache to have partitions (fate#325346) Sep 13, 2018
doc
examples
integration-tests
package
po
storage
testsuite
utils
.editorconfig
.gitignore
.travis.sh
.travis.yml
AUTHORS
Dockerfile
LIBVERSION
LICENSE
Makefile.am
Makefile.ci
Makefile.repo
README.md
Rakefile
configure.ac
libstorage-ng.spec.in

README.md

libstorage-ng

Build Status

libstorage-ng is the designated successor of libstorage, a C++ library used by YaST to perform most storage related tasks.

The main idea of libstorage-ng compared to libstorage is to keep all information about storage devices in a graph instead of lists. For more information have a look at the overview.

Requirements

Some required tools for compiling and testing libstorage-ng are:

gcc-c++ boost-devel libjson-c-devel libxml2-devel libtool doxygen graphviz python3-devel python3-networkx ruby ruby-devel rubygem-test-unit swig >= 3.0.3 and != 3.0.8 (from YaST:storage-ng)

In addition to the previous packages, add these distribution-specific packages as well.

For some openSUSE/SUSE distributions the naming of rubygem-test-unit might be the following:

ruby2.1-rubygem-test-unit

For Fedora:

rubypick

Compiling

make -f Makefile.repo
make -j$(nproc)

Some files used to generate the bindings must be updated using tools in the utils directory.

When changing any exception specification (those in comments for doxygen) you have to run ./generate-catches.py > ../bindings/storage-catches.i.

When changing the class hierarchy of classes derived from Device or Holder you have to run ./generate-downcast.py > ../bindings/storage-downcast.i.

Make sure the documentation generated by doxygen is up-to-date before running the utils above.

Running Unit Tests

make -j$(nproc) install DESTDIR=/tmp/scratch
make -j$(nproc) check LOCALEDIR=/tmp/scratch/usr/share/locale

Making an RPM

make -f Makefile.repo
make package
cd package
osc build --local-package --alternative-project=openSUSE:Factory

Creating Changes And Package And Submitting To OBS

Creating the changes file and tar archive are handled by jenkins using linuxrc-devtools.

You can generate a preview of the changes file by running

make changes

and create the tar.xz source archive by running

make archive

Package versions are tracked by setting version tags in git. The last version digit is auto-increased with every OBS commit.

The version can always be set manually by setting an appropriate tag in git.

Notes

  1. The VERSION file is auto-generated from the latest git tag.

  2. The spec file template libstorage-ng.spec.in is not used. Instead, the spec file from the OBS is used.

For a more detailed description about the handling of version numbers and changelog entries look here.

Package Versions

Versioning follows YaST's versioning scheme.

Currently this means

  • 4.1.X for the master branch submitted to Factory and SLE-15-SP1
  • 3.3.X for the SLE-15-GA branch submitted to SLE-15:Update

Code Documentation

xdg-open doc/autodocs/html/index.html

See especially the class hierarchy:

xdg-open doc/autodocs/html/inherits.html

Travis CI

For continuous integration at GiHub the Travis CI service is used. To have the required build environment we use the yastdevel/libstorage-ng docker image. See the Travis documentation for more details.

To speed up the builds there we use the ccache tool and the Travis caching support.

Travis Cache Cleanup

The cache is maintained automatically and does not need any intervention. However, in a very rare case you might need to clear the cache and start from scratch.

  • You can directly remove the cache archive at Travis, but this requires the appropriate access permissions.
  • If you are not allowed to remove the cache at Travis then temporarily uncomment the cache cleanup code in the .travis.sh file. After the cache is cleared you can remove this temporary commit, Travis will use empty cache for the next build.