Make debian/README files more markdown-like

Travis Cross 9 years ago
parent 62a28980a1
commit b202d35094
  1. 12
      debian/README.Debian
  2. 98
      debian/README.source

@ -1,5 +1,5 @@
FreeSWITCH for Debian
---------------------
=====================
This debian packaging breaks out every module of freeswitch into a
separate package, so be sure to verify that you are actually
@ -18,9 +18,9 @@ to /etc/freeswitch.
If you just want to get a working demo system up quickly, I'd
recommend doing the following:
aptitude install -y -r -o APT::Install-Suggests=true freeswitch-meta-vanilla
cp -a /usr/share/freeswitch/conf/vanilla /etc/freeswitch
/etc/init.d/freeswitch start
fs_cli
aptitude install -y -r -o APT::Install-Suggests=true freeswitch-meta-vanilla
cp -a /usr/share/freeswitch/conf/vanilla /etc/freeswitch
/etc/init.d/freeswitch start
fs_cli
-- Travis Cross <tc@traviscross.com>, Wed, 3 Oct 2012 02:15:32 +0000
-- Travis Cross <tc@traviscross.com>, Sun, 23 Feb 2014 17:10:49 +0000

@ -1,5 +1,5 @@
FreeSWITCH for Debian
---------------------
=====================
You may be reading this because you're wondering where all the files
are in debian/, such as control. You may also be here looking for the
@ -19,17 +19,17 @@ bit more restricted.
debian/control-modules currently supports the following fields:
# lines that begin with the hash character are comments
#
# every block must start with a Module field
Module: <category>/<module_name>
Description: <short description>
<long description> # empty lines with "."s are not yet supported
Build-Depends: <build deps for this module>
Depends: <runtime deps for this module>
Recommends: <recommended packages>
Suggests: <suggested packages>
Distro-Conflicts: <distributions on which this module should not be built> # not yet implemented
# lines that begin with the hash character are comments
#
# every block must start with a Module field
Module: <category>/<module_name>
Description: <short description>
<long description> # empty lines with "."s are not yet supported
Build-Depends: <build deps for this module>
Depends: <runtime deps for this module>
Recommends: <recommended packages>
Suggests: <suggested packages>
Distro-Conflicts: <distributions on which this module should not be built> # not yet implemented
During bootstrap we build a file control-modules.gen. If the
control-modules file is properly formatted, this generated file should
@ -43,57 +43,57 @@ which we don't yet have good packaging.
The format of debian/modules.conf is:
## comments should start with two hash characters
<category>/<module_name>
## comments should start with two hash characters
<category>/<module_name>
To build this package, I recommend running the following from the root
directory of your FS git working tree:
distro=sid
ver="$(cat build/next-release.txt | sed -e 's/-/~/g')~n$(date +%Y%m%dT%H%M%SZ)-1~${distro}+1"
git clean -fdx && git reset --hard HEAD
./build/set-fs-version.sh "$ver"
git add configure.in && git commit -m "bump to custom v$ver"
(cd debian && ./bootstrap.sh -c $distro)
dch -b -m -v "$ver" --force-distribution -D "unstable" "Custom build."
dpkg-buildpackage -b -us -uc -Zxz -z9
git reset --hard HEAD^
distro=sid
ver="$(cat build/next-release.txt | sed -e 's/-/~/g')~n$(date +%Y%m%dT%H%M%SZ)-1~${distro}+1"
git clean -fdx && git reset --hard HEAD
./build/set-fs-version.sh "$ver"
git add configure.in && git commit -m "bump to custom v$ver"
(cd debian && ./bootstrap.sh -c $distro)
dch -b -m -v "$ver" --force-distribution -D "unstable" "Custom build."
dpkg-buildpackage -b -us -uc -Zxz -z9
git reset --hard HEAD^
To build for a stable branch, do this:
distro=sid # update as needed
stable_ver="1.2.1" # update as needed
# if you only want to build some modules, put them one per line here, e.g.:
#echo "applications/mod_commands" >> debian/modules.conf
ver="$(echo "$stable_ver" | sed -e 's/-/~/g')~n$(date +%Y%m%dT%H%M%SZ)-1~${distro}+1"
git clean -fdx && git reset --hard refs/tags/v${stable_ver}
./build/set-fs-version.sh "$ver"
git add configure.in && git commit -m "bump to custom v$ver"
(cd debian && ./bootstrap.sh -c $distro)
dch -b -m -v "$ver" --force-distribution -D "unstable" "Custom build."
dpkg-buildpackage -b -us -uc -Zxz -z9
git reset --hard origin/master
distro=sid # update as needed
stable_ver="1.2.1" # update as needed
# if you only want to build some modules, put them one per line here, e.g.:
#echo "applications/mod_commands" >> debian/modules.conf
ver="$(echo "$stable_ver" | sed -e 's/-/~/g')~n$(date +%Y%m%dT%H%M%SZ)-1~${distro}+1"
git clean -fdx && git reset --hard refs/tags/v${stable_ver}
./build/set-fs-version.sh "$ver"
git add configure.in && git commit -m "bump to custom v$ver"
(cd debian && ./bootstrap.sh -c $distro)
dch -b -m -v "$ver" --force-distribution -D "unstable" "Custom build."
dpkg-buildpackage -b -us -uc -Zxz -z9
git reset --hard origin/master
Alternatively, you can build using our automated tools. To build the
source packages and all supported binary packages for sid, wheezy,
squeeze on i386 and amd64, run the following as root from a clean
Debian sid 'buildd' image:
aptitude update && aptitude upgrade
aptitude install -y git
mkdir /usr/src/freeswitch
git clone git://git.freeswitch.org/freeswitch /usr/src/freeswitch/src
cd /usr/src/freeswitch/src
# if you only want to build some modules, create a modules.conf
# outside the source tree and add -f ../path/to/modules.conf to the
# command below. See ./debian/util.sh -h for further usage
# information.
./debian/util.sh build-all -ibn -z9
aptitude update && aptitude upgrade
aptitude install -y git
mkdir /usr/src/freeswitch
git clone git://git.freeswitch.org/freeswitch /usr/src/freeswitch/src
cd /usr/src/freeswitch/src
# if you only want to build some modules, create a modules.conf
# outside the source tree and add -f ../path/to/modules.conf to the
# command below. See ./debian/util.sh -h for further usage
# information.
./debian/util.sh build-all -ibn -z9
If you need to build a small set of modules for compile testing in the
pbuilder environment, run something like:
./debian/util.sh build-all -dni -z1 -a amd64 -c sid -l "applications/mod_commands"
./debian/util.sh build-all -dni -z1 -a amd64 -c sid -l "applications/mod_commands"
The source packages for sounds and music on hold are maintained in a
separate repository. Each set of sounds has a separate version number
@ -104,7 +104,7 @@ and the sounds and music would be a mess.
To build the Debian packages for freeswitch-sounds-* and
freeswitch-music-*:
git clone https://github.com/traviscross/freeswitch-sounds.git
cd freeswitch-sounds && cat debian/README.source
git clone https://github.com/traviscross/freeswitch-sounds.git
cd freeswitch-sounds && cat debian/README.source
-- Travis Cross <tc@traviscross.com>, Fri, 17 Jan 2014 20:05:52 +0000
-- Travis Cross <tc@traviscross.com>, Sun, 23 Feb 2014 17:08:30 +0000

Loading…
Cancel
Save