From: Simon Glass <sjg@chromium.org>
Date: Mon, 10 Jan 2022 03:13:48 +0000 (-0700)
Subject: binman: Add installation instructions
X-Git-Url: http://git.dujemihanovic.xyz/?a=commitdiff_plain;h=81d6e3f088f799b213b3a4be2b26619c5801e967;p=u-boot.git

binman: Add installation instructions

Explain how to install binman, since it is not obvious.

Signed-off-by: Simon Glass <sjg@chromium.org>
---

diff --git a/tools/binman/binman.rst b/tools/binman/binman.rst
index 3e063d1f86..9dbe582ade 100644
--- a/tools/binman/binman.rst
+++ b/tools/binman/binman.rst
@@ -185,14 +185,37 @@ Binman is intended to replace all of this, with ifdtool left to handle only
 the configuration of the Intel-format descriptor.
 
 
-Running binman
---------------
+Installing binman
+-----------------
 
 First install prerequisites, e.g::
 
     sudo apt-get install python-pyelftools python3-pyelftools lzma-alone \
         liblz4-tool
 
+You can run binman directly if you put it on your PATH. But if you want to
+install into your `~/.local` Python directory, use::
+
+    pip install tools/patman tools/dtoc tools/binman
+
+Note that binman makes use of libraries from patman and dtoc, which is why these
+need to be installed. Also you need `libfdt` and `pylibfdt` which can be
+installed like this::
+
+   git clone git://git.kernel.org/pub/scm/utils/dtc/dtc.git
+   cd dtc
+   pip install .
+   make NO_PYTHON=1 install
+
+This installs the `libfdt.so` library into `~/lib` so you can use
+`LD_LIBRARY_PATH=~/lib` when running binman. If you want to install it in the
+system-library directory, replace the last line with::
+
+   make NO_PYTHON=1 PREFIX=/ install
+
+Running binman
+--------------
+
 Type::
 
     binman build -b <board_name>