summaryrefslogtreecommitdiffstats
path: root/contrib/errcode/README
blob: eb66d06912544c89ada0dc5d719901f41342386c (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
Error Code Lookup for iPXE
==========================
This program looks up iPXE error codes so you can locate the line of source
code which produced the error.

Setup
-----
You must run:
./build_errcodedb.py >errcodedb.py

This extracts error code definitions from the iPXE source code and produces a
"database" which is used by the main program.

Once you have done this errcode.py and errcodedb.py are the only files you
need.  They are now independent of the iPXE source code and can be moved
anywhere.

[OPTIONAL]
A PHP script is provided as a web interface.  First edit errcode.php to point
$ERRCODE_PATH to the errcode.py script.  Then move errcode.php to a location
visible from your web server.

[OPTIONAL]
A simple IRC bot is provided.  Edit ipxebot.py to fill in the IRC details.

Usage
-----
Looking up error codes on the command-line:
./errcode.py 0x12345678

Further information
-------------------
See http://etherboot.org/.

Released under the GPL and written by Stefan Hajnoczi <stefanha@gmail.com>.