Skip to content
Snippets Groups Projects
Commit 7c4b6452 authored by nimrod's avatar nimrod
Browse files

- Added some more documentation and license information.

parent cd561aa7
Branches master
No related tags found
No related merge requests found
The MIT License (MIT)
Copyright (c) 2016 Adar Nimrod
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
......@@ -2,7 +2,23 @@ python-unshare
##############
This is a pure-Python module with no external dependencies for accessing libc
functions and macros needed for dealing with Linux namespaces.
functions and macros needed for dealing with Linux namespaces. The point is to
be easily installed without needing anything more than Python and Pip.
API
---
This module exposes some of the libc calls that are needed for dealing with
namespaces and thus containers in Linux. These are plain calls to the libc
functions and their behaviour is the same. The functions are:
- `unshare <http://man7.org/linux/man-pages/man2/unshare.2.html>`_
- `unmount <http://man7.org/linux/man-pages/man2/unmount.2.html>`_
- `unmount2 <http://man7.org/linux/man-pages/man2/unmount2.2.html>`_
- `mount <http://man7.org/linux/man-pages/man2/mount.2.html>`_
- `pivot_root <http://man7.org/linux/man-pages/man2/pivot_root.2.html>`_
- `setns <http://man7.org/linux/man-pages/man2/setns.2.html>`_
- `sethostname <http://man7.org/linux/man-pages/man2/sethostname.2.html>`_
- `clone <http://man7.org/linux/man-pages/man2/clone.2.html>`_
Development
-----------
......@@ -18,12 +34,23 @@ developers there's a Vagrant box defined (it optionally uses
`vagrant-gatling-rsync <https://github.com/smerrill/vagrant-gatling-rsync>`_).
Finally, releasing a version is done by running :code:`tox -e release`.
License
-------
This software is licnesed under the MIT licese (see the :code:`LICENSE.txt`
file).
Author
------
Nimrod Adar, `contact me <nimrod@shore.co.il>`_ or visit my `website
<https://www.shore.co.il/>`_. Patches are welcome via `git send-email
<http://git-scm.com/book/en/v2/Git-Commands-Email>`_. The repository is located
at: https://www.shore.co.il/git/.
TODO
----
- License.
- Changelog.
- Documentation.
- Replace the GCC preprocessor for generating :code:`unshare/constants.py`
with a Python one (`CPIP <http://cpip.sourceforge.net/>`_ or `pycparser
<https://github.com/eliben/pycparser>`_).
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment