Added new file (BUILD) with intructions for getting dependencies, configuring

eudev, and building the code.

Added blurb to README with simplified build instructions.
This commit is contained in:
Jesse Smith 2021-09-30 11:20:31 -03:00
parent 8b4177dc60
commit 3c21322d12
2 changed files with 194 additions and 0 deletions

93
BUILD Normal file
View File

@ -0,0 +1,93 @@
Building eudev
===================
The following instructions provide the steps needed to acquire and build the eudev
software on the Debian, Devuan, and compatible Linux distributions.
Please note that command examples in this document use the following convention. Commands
prefixed by a "$" symbol are to be run as a regular, user. Commands with a "#" prefix
need to be run as the root user. If your user has sudo access then sudo may be
used instead of logging into the root account.
1. Installing dependencies
============================
The first thing we need to do is install the dependencies required to build eudev.
This can be accomplished by running the following two commands:
# apt-get update
# apt-get install build-essential pkg-config docbook-xsl\
docbook-xml m4 automake autoconf intltool gperf\
gnu-efi libcap-dev libselinux1-dev libacl1-dev\
libkmod-dev libblkid-dev gobject-introspection\
libglib-object-introspection-perl xsltproc
2. Downloading the source code
================================
There are two common approaches to downloading the project's source code. The first
is to visit the eudev GitHub releases page (https://github.com/eudev-project/eudev/releases)
and downloading the latest tar.gz archive file. Then unpack the downloaded archive. For
example, if we downloaded eudev version 3.2.10 we could unpack the archive using the
following command:
$ tar xf eudev-3.2.10.tar.gz
Alternatively, we can download the latest source code by using git. This is probably the
better option for developers. Here we install the git source control program and
use it to download the latest eudev source code:
# apt-get install git
$ git clone https://github.com/eudev-project/eudev.git
3. Configuring and building eudev
==================================
To build the eudev source code, run the following commands:
$ cd eudev
$ ./autogen.sh
$ ./configure
Please note that, by default, the configure script will assume we want to place
eudev under the /usr directory. If this is not accurate, we can supply an alternative
location using the "--prefix" flag. For instance, to place eudev under the /usr/local
directory tree, run the following:
$ ./configure --prefix /usr/local
Once eudev has been configured we can then perform the build.
$ make
4. Install eudev
=================
Please note that, in most situations, people will not wish to install eudev manually.
This work is typically performed by your distribution's package manager. Installing
eudev manually can break your operating system.
If you really wish to proceed and install eudev manually, you can do so by running:
# make install
5. Removing eudev
==================
Please note that removing eudev can damage your system.
If you wish to remove eudev from yoru system you can do so by running the
following command:
# make uninstall

101
README.md
View File

@ -26,6 +26,107 @@ the repo may contact me at blueness@gentoo.org.
==========
BUILD INSTRUCTIONS
To build eudev, first install any required dependencies. The dependencies for eudev's build process and how to install them are listed in the BUILD file. Then download the eudev source code and perform the following commands:
$ ./autogen.sh
$ ./configure
$ make
Optionally, eudev can be installed by running
$ sudo make install
And removed by running
$ sudo make uninstall
For further details on building and install eudev, please see the BUILD file.
==========
BACKGROUND INFORMATION
This git repo is a fork of git://anongit.freedesktop.org/systemd/systemd
with the aim of isolating udev from any particular flavor of system
initialization. In this case, the isolation is from systemd.
This is a project started by Gentoo developers and testing is currently being
done mostly on OpenRC. We welcome contribution from others using a variety of
system initializations to ensure eudev remains system initialization and
distribution neutral.
Homepage: https://wiki.gentoo.org/wiki/Project:Eudev
Tarballs of releases: http://dev.gentoo.org/~blueness/eudev/
Contact: You can email us as a group below.
IRC: Freenode/#gentoo-udev
Committers (alphabetical order by last name):
Luca Barbato (lu_zero) <lu_zero@gentoo.org>
Anthony G. Basile (blueness) <blueness@gentoo.org>
Francisco Izquierdo (klondike) <klondike@gentoo.org>
Ian Stakenvicius (axs) <axs@gentoo.org>
Matthew Thode (prometheanfire) <prometheanfire@gentoo.org>
Tony Vroon (chainsaw) <tony@linx.net>
Richard Yao (ryao) <ryao@gentoo.org>
## Build status
[![Build Status](https://travis-ci.org/gentoo/eudev.svg?branch=master)](https://travis-ci.org/gentoo/eudev)ADOPTION NOTICE (2021-09-14)
Currently eudev is in the process of being adopted by a newly formed project by Alpine, Devuan and Gentoo contributors (a-z order). Some of the below links and/or contacts may be outdated until the process is complete and all the infra set up.
As of now we are hanging on [Libera.Chat](https://libera.chat/):
ircs://irc.libera.chat:6697/#eudev
https://web.libera.chat/#eudev
Boian Bonev
==========
IMPORTANT DEPRECATION NOTICE (2021-08-20)
Currently eudev is no longer being supported. Eudev was started, in
part because systemd did not build on musl-libc systems and a fork
of the udev portion of systemd was required. Currently systemd can
be built on musl systems with patches from the openembedded team, and
the need to maintain a separate fork is no longer pressing.
Nonetheless, many distros have adopted eudev as their device manager
and so may want to continue using it. Anyone interested in inheriting
the repo may contact me at blueness@gentoo.org.
Anthony G. Basile
==========
BUILD INSTRUCTIONS
To build eudev, first install any required dependencies. The dependencies for eudev's build process and how to install them are listed in the BUILD file. Then download the eudev source code and perform the following commands:
$ ./autogen.sh
$ ./configure
$ make
Optionally, eudev can be installed by running
$ sudo make install
And removed by running
$ sudo make uninstall
For further details on building and install eudev, please see the BUILD file.
==========
BACKGROUND INFORMATION
This git repo is a fork of git://anongit.freedesktop.org/systemd/systemd
with the aim of isolating udev from any particular flavor of system