Move hack directory contents to top level
Docker-DCO-1.1-Signed-off-by: Glyn Normington <gnormington@gopivotal.com> (github: glyn)
This commit is contained in:
parent
5e3312f358
commit
3ce18ef0b3
|
@ -1,4 +1,4 @@
|
||||||
# Contributing to libcontainer
|
# The libcontainer Contributors' Guide
|
||||||
|
|
||||||
Want to hack on libcontainer? Awesome! Here are instructions to get you
|
Want to hack on libcontainer? Awesome! Here are instructions to get you
|
||||||
started. They are probably not perfect, please let us know if anything
|
started. They are probably not perfect, please let us know if anything
|
|
@ -1,4 +1,4 @@
|
||||||
# The libcontainer Maintainer manual
|
# The libcontainer Maintainers' Guide
|
||||||
|
|
||||||
## Introduction
|
## Introduction
|
||||||
|
|
14
README.md
14
README.md
|
@ -1,12 +1,12 @@
|
||||||
## libcontainer - reference implementation for containers
|
## libcontainer - reference implementation for containers
|
||||||
|
|
||||||
#### background
|
#### Background
|
||||||
|
|
||||||
libcontainer specifies configuration options for what a container is. It provides a native Go implementation
|
libcontainer specifies configuration options for what a container is. It provides a native Go implementation
|
||||||
for using Linux namespaces with no external dependencies. libcontainer provides many convenience functions for working with namespaces, networking, and management.
|
for using Linux namespaces with no external dependencies. libcontainer provides many convenience functions for working with namespaces, networking, and management.
|
||||||
|
|
||||||
|
|
||||||
#### container
|
#### Container
|
||||||
A container is a self contained directory that is able to run one or more processes without
|
A container is a self contained directory that is able to run one or more processes without
|
||||||
affecting the host system. The directory is usually a full system tree. Inside the directory
|
affecting the host system. The directory is usually a full system tree. Inside the directory
|
||||||
a `container.json` file is placed with the runtime configuration for how the processes
|
a `container.json` file is placed with the runtime configuration for how the processes
|
||||||
|
@ -35,8 +35,18 @@ If you wish to spawn another process inside the container while your current bas
|
||||||
running just run the exact same command again to get another bash shell or change the command. If the original process dies, PID 1, all other processes spawned inside the container will also be killed and the namespace will be removed.
|
running just run the exact same command again to get another bash shell or change the command. If the original process dies, PID 1, all other processes spawned inside the container will also be killed and the namespace will be removed.
|
||||||
|
|
||||||
You can identify if a process is running in a container by looking to see if `pid` is in the root of the directory.
|
You can identify if a process is running in a container by looking to see if `pid` is in the root of the directory.
|
||||||
|
#### Future
|
||||||
|
See the [roadmap](ROADMAP.md).
|
||||||
|
|
||||||
## Copyright and license
|
## Copyright and license
|
||||||
|
|
||||||
Code and documentation copyright 2014 Docker, inc. Code released under the Apache 2.0 license.
|
Code and documentation copyright 2014 Docker, inc. Code released under the Apache 2.0 license.
|
||||||
Docs released under Creative commons.
|
Docs released under Creative commons.
|
||||||
|
|
||||||
|
## Hacking on libcontainer
|
||||||
|
|
||||||
|
First of all, please familiarise yourself with the [libcontainer Principles](PRINCIPLES.md).
|
||||||
|
|
||||||
|
If you're a *contributor* or aspiring contributor, you should read the [Contributors' Guide](CONTRIBUTORS_GUIDE.md).
|
||||||
|
|
||||||
|
If you're a *maintainer* or aspiring maintainer, you should read the [Maintainers' Guide](MAINTAINERS_GUIDE.md).
|
||||||
|
|
|
@ -1,22 +0,0 @@
|
||||||
# Hacking on libcontainer
|
|
||||||
|
|
||||||
The hack/ directory holds information and tools for everyone involved in the process of creating and
|
|
||||||
distributing libcontainer, specifically:
|
|
||||||
|
|
||||||
## Guides
|
|
||||||
|
|
||||||
If you're a *contributor* or aspiring contributor, you should read CONTRIBUTORS.md.
|
|
||||||
|
|
||||||
If you're a *maintainer* or aspiring maintainer, you should read MAINTAINERS.md.
|
|
||||||
|
|
||||||
## Roadmap
|
|
||||||
|
|
||||||
A high-level roadmap is available at ROADMAP.md.
|
|
||||||
|
|
||||||
## Build tools
|
|
||||||
|
|
||||||
TBD
|
|
||||||
|
|
||||||
## Credits
|
|
||||||
|
|
||||||
The initial documentation in the hack/ directory came from the Docker repository, where libcontainer grew up.
|
|
Loading…
Reference in New Issue