https://github.com/containerd/btrfs

Btrfs bindings for Go
https://github.com/containerd/btrfs

Last synced: 9 months ago
JSON representation

Btrfs bindings for Go

• Host: GitHub
• URL: https://github.com/containerd/btrfs
• Owner: containerd
• License: apache-2.0
• Created: 2016-12-09T21:32:55.000Z (over 9 years ago)
• Default Branch: main
• Last Pushed: 2023-12-29T00:33:58.000Z (over 2 years ago)
• Last Synced: 2024-08-20T04:27:44.736Z (over 1 year ago)
• Language: Go
• Size: 75.2 KB
• Stars: 68
• Watchers: 15
• Forks: 19
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-btrfs - Go

README

          
# go-btrfs

[![PkgGoDev](https://pkg.go.dev/badge/github.com/containerd/btrfs)](https://pkg.go.dev/github.com/containerd/btrfs)

[![Build Status](https://github.com/containerd/btrfs/workflows/CI/badge.svg)](https://github.com/containerd/btrfs/actions?query=workflow%3ACI)

[![Go Report Card](https://goreportcard.com/badge/github.com/containerd/btrfs)](https://goreportcard.com/report/github.com/containerd/btrfs)

Native Go bindings for btrfs.

# Status

These are in the early stages. We will try to maintain stability, but please

vendor if you are relying on these directly.

# Dependencies

## v2.x

Headers from kernel 4.12 or newer.

The package name is `linux-libc-dev` on Debian/Ubuntu, `kernel-headers` on Fedora and RHEL-like distros.

The headers are only required on compilation time, not on run time.

## v1.x

libbtrfs headers.

The package name is `libbtrfs-dev` on Debian/Ubuntu, `btrfs-progs-devel` on Fedora and CentOS 7.

The package is not available for Rocky Linux and AlmaLinux.

# Contribute

This package may not cover all the use cases for btrfs. If something you need

is missing, please don't hesitate to submit a PR.

Note that due to struct alignment issues, this isn't yet fully native.

Preferably, this could be resolved, so contributions in this direction are

greatly appreciated.

## Applying License Header to New Files

If you submit a contribution that adds a new file, please add the license

header. You can do so manually or use the `ltag` tool:

```console

$ go get github.com/kunalkushwaha/ltag

$ ltag -t ./license-templates

```

The above will add the appropriate licenses to Go files. New templates will

need to be added if other kinds of files are added. Please consult the

documentation at https://github.com/kunalkushwaha/ltag

## Project details

btrfs is a containerd sub-project, licensed under the [Apache 2.0 license](./LICENSE).

As a containerd sub-project, you will find the:

 * [Project governance](https://github.com/containerd/project/blob/main/GOVERNANCE.md),

 * [Maintainers](https://github.com/containerd/project/blob/main/MAINTAINERS),

 * and [Contributing guidelines](https://github.com/containerd/project/blob/main/CONTRIBUTING.md)

information in our [`containerd/project`](https://github.com/containerd/project) repository.