b2963c06c7e9a61e3c86082443bffeb4fa9d1921
[gpxe.git] / contrib / errcode / README
1 Error Code Lookup for gPXE
2 ==========================
3 This program looks up gPXE error codes so you can locate the line of source
4 code which produced the error.
5
6 Setup
7 -----
8 You must run:
9 ./build_errcodedb.py >errcodedb.py
10
11 This extracts error code definitions from the gPXE source code and produces a
12 "database" which is used by the main program.
13
14 Once you have done this errcode.py and errcodedb.py are the only files you
15 need.  They are now independent of the gPXE source code and can be moved
16 anywhere.
17
18 [OPTIONAL]
19 A PHP script is provided as a web interface.  First edit errcode.php to point
20 $ERRCODE_PATH to the errcode.py script.  Then move errcode.php to a location
21 visible from your web server.
22
23 [OPTIONAL]
24 A simple IRC bot is provided.  Edit gpxebot.py to fill in the IRC details.
25
26 Usage
27 -----
28 Looking up error codes on the command-line:
29 ./errcode.py 0x12345678
30
31 Further information
32 -------------------
33 See http://etherboot.org/.
34
35 Released under the GPL and written by Stefan Hajnoczi <stefanha@gmail.com>.