readme: update, add RHEL 7 as supported distro, break up long lines and beautify using GitHub flavored markdown

This commit is contained in:
Terry Wang 2014-07-25 22:59:01 +10:00
parent cde33f13ed
commit d5bb38d42d

View File

@ -35,17 +35,21 @@ Installation
Install the dependencies for compiling kpatch:
sudo yum install gcc kernel-devel elfutils elfutils-devel
```bash
sudo yum install gcc kernel-devel elfutils elfutils-devel
```
Install the dependencies for the "kpatch-build" command:
sudo yum install rpmdevtools pesign yum-utils
sudo yum-builddep kernel
sudo debuginfo-install kernel
```bash
sudo yum install rpmdevtools pesign yum-utils
sudo yum-builddep kernel
sudo debuginfo-install kernel
# optional, but highly recommended
sudo yum install ccache
ccache --max-size=5G
# optional, but highly recommended
sudo yum install ccache
ccache --max-size=5G
```
####RHEL 7
@ -54,35 +58,45 @@ Install the dependencies for the "kpatch-build" command:
Install the dependencies for compiling kpatch:
sudo yum install gcc kernel-devel elfutils elfutils-devel
```bash
sudo yum install gcc kernel-devel elfutils elfutils-devel
```
Install the dependencies for the "kpatch-build" command:
sudo yum install rpmdevtools pesign yum-utils zlib-devel binutils-devel newt-devel python-devel perl-ExtUtils-Embed audit-libs-devel numactl-devel pciutils-devel bison
sudo yum-builddep kernel
sudo debuginfo-install kernel
```bash
sudo yum install rpmdevtools pesign yum-utils zlib-devel \
binutils-devel newt-devel python-devel perl-ExtUtils-Embed \
audit-libs devel numactl-devel pciutils-devel bison
# optional, but highly recommended
sudo yum install ccache
ccache --max-size=5G
sudo yum-builddep kernel
sudo debuginfo-install kernel
# optional, but highly recommended
sudo yum install ccache
ccache --max-size=5G
```
####Ubuntu 14.04
*NOTE: You'll need about 15GB of free disk space for the kpatch-build cache in
`~/.kpatch` and for ccache.*
*NOTE: You'll need about 15GB of free disk space for the kpatch-build cache in `~/.kpatch` and for ccache.*
Install the dependencies for compiling kpatch:
apt-get install make gcc libelf-dev
```bash
apt-get install make gcc libelf-dev
```
Install the dependencies for the "kpatch-build" command:
apt-get install dpkg-dev
apt-get build-dep linux
```bash
apt-get install dpkg-dev
apt-get build-dep linux
# optional, but highly recommended
apt-get install ccache
ccache --max-size=5G
# optional, but highly recommended
apt-get install ccache
ccache --max-size=5G
```
Install kernel debug symbols:
@ -178,20 +192,17 @@ Compile kpatch:
###Install
OPTIONAL: Install kpatch to /usr/local:
OPTIONAL: Install kpatch to `/usr/local`:
sudo make install
Alternatively, the kpatch and kpatch-build scripts can be run directly from the
git tree.
Alternatively, the kpatch and kpatch-build scripts can be run directly from the git tree.
Quick start
-----------
*NOTE: While kpatch is designed to work with any recent Linux
kernel on any distribution, the "kpatch-build" command currently only works on
Fedora 20 and Ubuntu 14.04.*
> NOTE: While kpatch is designed to work with any recent Linux kernel on any distribution, the `kpatch-build` command has **ONLY** been tested to work on Fedora 20, RHEL 7 and Ubuntu 14.04.
First, make a source code patch against the kernel tree using diff, git, or
quilt.