shaba/ostree
1
0
Fork 0
mirror of https://github.com/ostreedev/ostree.git synced 2024-10-27 10:25:07 +03:00
Code Issues Projects Releases Wiki Activity
Operating system and container binary deployment and upgrades
3,046 Commits 6 Branches 140 Tags 32 MiB
C 73.4%
Shell 15.4%
Rust 7.5%
Yacc 1%
M4 0.9%
Other 1.7%
305db981d4
Go to file
Colin Walters 305db981d4 Add Coccinelle usage: one for blacklisting, one for patch collection 
This is inspired by the [Coccinelle](http://coccinelle.lip6.fr/) usage
in systemd.  I also took it a bit further and added infrastructure
to have spatches which should never apply.  This acts as a blacklist.

The reason to do the latter is that coccinelle is *way* more powerful than the
regular expresssions we have in `make syntax-check`.

I started with blacklisting `g_error_free()` directly. The reason that's bad is
it leaves a dangling pointer.

Closes: #754
Approved by: jlebon
2017-03-30 19:19:54 +00:00
apidoc sysroot: Add ostree_sysroot_write_deployments_with_options() 2017-03-23 19:28:42 +00:00
bsdiff@1edf9f6568 bsdiff: change submodule location 2015-03-26 23:33:07 +01:00
build-aux Add infrastructure for "make syntax-check" 2015-01-30 15:27:36 +01:00
buildutil Terminate individual tests after (10 * $TEST_TIMEOUT_FACTOR) minutes 2016-12-01 18:22:51 +00:00
coccinelle Add Coccinelle usage: one for blacklisting, one for patch collection 2017-03-30 19:19:54 +00:00
docs doc: fix typo in CONTRIBUTING 2017-02-03 19:05:40 +00:00
libglnx@602fdd93cb Bump libglnx, port a few callers to new error API 2017-03-22 16:04:58 +00:00
man diff: Add ostree_diff_dirs_with_options(), expose via cmdline 2017-03-21 13:38:04 +00:00
manual-tests repo+tests: Add [core]disable-xattrs=true, use it on overlayfs 2017-03-24 22:16:43 +00:00
rust rust: Support make dist -> cargo vendor 2017-02-07 16:50:37 +00:00
src Add Coccinelle usage: one for blacklisting, one for patch collection 2017-03-30 19:19:54 +00:00
tests Add Coccinelle usage: one for blacklisting, one for patch collection 2017-03-30 19:19:54 +00:00
.dir-locals.el .dir-locals.el: Standard Emacs indentation config 2017-01-12 16:09:34 +00:00
.gitmodules bsdiff: change submodule location 2015-03-26 23:33:07 +01:00
.redhat-ci.Dockerfile Add Coccinelle usage: one for blacklisting, one for patch collection 2017-03-30 19:19:54 +00:00
.redhat-ci.yml Add Coccinelle usage: one for blacklisting, one for patch collection 2017-03-30 19:19:54 +00:00
.travis.yml libcurl backend 2017-02-09 16:37:45 +00:00
autogen.sh libglnx porting: Migrate to new tempfile code 2016-07-29 19:02:41 +00:00
cfg.mk cfg.mk: Add a syntax check for a redundant : in glnx_throw 2017-03-23 19:09:52 +00:00
configure.ac ci: Enable -Werror=unused-result with -Wp,-D_FORTIFY_SOURCE=2 2017-03-28 18:56:18 +00:00
CONTRIBUTING.md Rewrite manual in mkdocs 2016-01-28 09:31:37 -05:00
COPYING COPYING: Update to latest FSF with current address 2014-01-16 10:22:30 -05:00
git.mk Use git.mk 2016-04-07 12:49:40 +00:00
GNUmakefile Add infrastructure for "make syntax-check" 2015-01-30 15:27:36 +01:00
maint.mk tests: prefix invocation of ostree with where missing 2015-11-16 11:07:55 +01:00
Makefile-boot.am Move ostree-* executables to /usr/lib/ostree 2016-08-11 14:04:59 +00:00
Makefile-decls.am build-sys: Minor makefile tweaks 2017-01-04 16:32:11 +00:00
Makefile-libostree-defines.am libostree: add versioning macros 2017-03-11 15:38:56 +00:00
Makefile-libostree.am build: Dist ostree-sepolicy-private.h 2017-03-23 21:58:55 +00:00
Makefile-man.am build: Actually distribute man page XML source 2016-09-01 19:23:49 +00:00
Makefile-ostree.am libostree: add versioning macros 2017-03-11 15:38:56 +00:00
Makefile-otutil.am libutil: Delete unused threadpool wrapper 2017-03-30 13:14:43 +00:00
Makefile-switchroot.am build: clean up ostree-remount if building without systemd 2016-11-29 14:11:50 +00:00
Makefile-tests.am Add Coccinelle usage: one for blacklisting, one for patch collection 2017-03-30 19:19:54 +00:00
Makefile.am Define TARGET_PREFIX to use with grub2 deployment 2017-03-27 15:49:50 +00:00
mkdocs.yml docs: Add a section on repository management 2016-03-29 14:10:24 +00:00
ostree.doap doap category infrastructure 2014-07-31 11:26:32 +02:00
README-historical.md README: Just link to wiki, move most of it to README-historical.md 2014-01-20 18:00:09 -05:00
README.md README.md: Add more/clean up links to consuming projects 2017-02-21 16:34:14 +00:00
TODO Fix repeated words. 2015-01-30 15:27:36 +01:00

README.md

libOSTree

New! See the docs online at Read The Docs (OSTree)

This project is now known as "libOSTree", renamed from "OSTree"; the focus is on the shared library. However, in most of the rest of the documentation, we will use the term "OSTree", since it's slightly shorter, and changing all documentation at once is impractical. We expect to transition to the new name over time.

libOSTree is a library and suite of command line tools that combines a "git-like" model for committing and downloading bootable filesystem trees, along with a layer for deploying them and managing the bootloader configuration.

The core OSTree model is like git in that it checksums individual files and has a content-addressed-object store. It's unlike git in that it "checks out" the files via hardlinks, and they should thus be immutable. Therefore, another way to think of OSTree is that it's just a more polished version of Linux VServer hardlinks.

Features:

  • Atomic upgrades and rollback for the system
  • Replicating content incrementally over HTTP via GPG signatures and "pinned TLS" support
  • Support for parallel installing more than just 2 bootable roots
  • Binary history on the server side (and client)
  • Introspectable shared library API for build and deployment systems

This last point is important - you should think of the OSTree command line as effectively a "demo" for the shared library. The intent is that package managers, system upgrade tools, container build tools and the like use OSTree as a "deduplicating hardlink store".

Projects using OSTree

meta-updater is a layer available for OpenEmbedded systems.

QtOTA is Qt's over-the-air update framework which uses libostree.

rpm-ostree is a next-generation hybrid package/image system for Fedora and CentOS, used by the Atomic Host project. By default it uses libostree to atomically replicate a base OS (all dependency resolution is done on the server), but it supports "package layering", where additional RPMs can be layered on top of the base. This brings a "best of both worlds"" model for image and package systems.

flatpak uses libostree for desktop application containers. Unlike most of the other systems here, flatpak does not use the "libostree host system" aspects (e.g. bootloader management), just the "git-like hardlink dedup". For example, flatpak supports a per-user OSTree repository.

Endless OS uses libostree for their host system as well as flatpak. See their eos-updater and deb-ostree-builder projects.

GNOME Continuous is where OSTree was born - as a high performance continuous delivery/testing system for GNOME.

Building

Releases are available as GPG signed git tags, and most recent versions support extended validation using git-evtag.

However, in order to build from a git clone, you must update the submodules. If you're packaging OSTree and want a tarball, I recommend using a "recursive git archive" script. There are several available online; this code in OSTree is an example.

Once you have a git clone or recursive archive, building is the same as almost every autotools project:

env NOCONFIGURE=1 ./autogen.sh
./configure --prefix=...
make
make install DESTDIR=/path/to/dest

More documentation

New! See the docs online at Read The Docs (OSTree)

Some more information is available on the old wiki page: https://wiki.gnome.org/Projects/OSTree

Contributing

See Contributing.