Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
doc [2009/10/17 03:27] stefanha |
doc [2010/06/09 14:08] kylek not sure if this is proper place for it but what the heck |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| + | ====== Documentation for gPXE ====== | ||
| + | ===== General Documentation ===== | ||
| + | |||
| + | * [[gpxe_imagetypes|gPXE Image types]]: explanation on types of images cranked out by make or r-o-m | ||
| + | |||
| + | ===== Source Code Documentation ===== | ||
| + | |||
| + | Many parts of the gPXE code-base include commenting for use with the Doxygen system. To build this documentation for browsing, go into gPXE src/ directory and do | ||
| + | make doc | ||
| + | You will then have the documentation available in your gpxe/src/bin/doc/ directory. | ||
| + | |||
| + | A sample build is available [[http://etherboot.org/api/modules.html|here]]. | ||
| + | |||
| ====== Documentation for Etherboot ====== | ====== Documentation for Etherboot ====== | ||
| Line 71: | Line 84: | ||
| ===== Developer Information ===== | ===== Developer Information ===== | ||
| - | + | === Driver APIs === | |
| - | * [[dev:devmanual|A somewhat dated Etherboot Developers' manual]] (does not cover recent versions of Etherboot, or gPXE) | + | |
| - | * [[dev:todo|A Developer To-Do List]] | + | |
| * [[dev:netdriverapi|gPXE Network Driver API]] | * [[dev:netdriverapi|gPXE Network Driver API]] | ||
| + | * [[:soc:2008:mdeck:notes:gpxe_driver_api|PCI, network driver, and non-volatile storage APIs]] | ||
| + | |||
| + | === Debugging === | ||
| * [[dev:gdbstub|GDB remote debugging]] | * [[dev:gdbstub|GDB remote debugging]] | ||
| * [[dev:prefixdebugging|Prefix debugging]] | * [[dev:prefixdebugging|Prefix debugging]] | ||
| + | * [[dev:fnrec|Function recorder for crash/hang debugging]] | ||
| + | |||
| + | === Old stuff === | ||
| + | * [[dev:devmanual|A somewhat dated Etherboot Developers' manual]] (does not cover recent versions of Etherboot, or gPXE) | ||
| + | * [[dev:todo|A Developer To-Do List]] | ||
