]> git.puffer.fish Git - matthieu/frr.git/commitdiff
doc: cleanup alpine build doc
authorQuentin Young <qlyoung@cumulusnetworks.com>
Tue, 20 Mar 2018 14:43:21 +0000 (10:43 -0400)
committerQuentin Young <qlyoung@cumulusnetworks.com>
Tue, 20 Mar 2018 19:20:35 +0000 (15:20 -0400)
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
doc/developer/building-frr-on-alpine.rst

index 27718bdc8019030775edf3967236bea5f40f34dc..68031b3b617dcb9c718ba528a6b67f56fa096991 100644 (file)
@@ -6,42 +6,54 @@ For building Alpine Linux dev packages, we use docker.
 Install docker 17.05 or later
 -----------------------------
 
-Depending on your host, there are different ways of installing
-docker.  Refer to the documentation here for instructions on how
-to install a free version of docker: https://www.docker.com/community-edition
+Depending on your host, there are different ways of installing docker.  Refer
+to the documentation here for instructions on how to install a free version of
+docker: https://www.docker.com/community-edition
 
 Work with sources
 -----------------
 
-    git clone https://github.com/frrouting/frr.git frr
-    cd frr
+::
+
+   git clone https://github.com/frrouting/frr.git frr
+   cd frr
 
 Build apk packages
 ------------------
 
-    ./docker/alpine/build.sh
+::
+
+   ./docker/alpine/build.sh
 
 This will put the apk packages in:
 
-    ./docker/pkgs/apk/x86_64/
+::
+
+   ./docker/pkgs/apk/x86_64/
 
 Usage
 -----
 
 To add the packages to a docker image, create a Dockerfile in ./docker/pkgs:
 
-    FROM alpine:3.7
-    RUN mkdir -p /pkgs
-    ADD apk/ /pkgs/
-    RUN apk add --no-cache --allow-untrusted /pkgs/x86_64/*.apk
+::
+
+   FROM alpine:3.7
+   RUN mkdir -p /pkgs
+   ADD apk/ /pkgs/
+   RUN apk add --no-cache --allow-untrusted /pkgs/x86_64/*.apk
 
 And build a docker image:
 
-    docker build --rm --force-rm -t alpine-dev-pkgs:latest docker/pkgs
+::
+
+   docker build --rm --force-rm -t alpine-dev-pkgs:latest docker/pkgs
 
 And run the image:
 
-    docker run -it --rm alpine-dev-pkgs:latest /bin/sh
+::
+
+   docker run -it --rm alpine-dev-pkgs:latest /bin/sh
 
 Currently, we only package the raw daemons and example files, so, you'll
 need to run the daemons by hand (or, better, orchestrate in the Dockerfile).