Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
doc [2009/08/07 13:06] stefanha |
doc [2010/05/02 03:58] stefanha |
||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ====== Documentation for gPXE ====== | ||
+ | |||
+ | ===== 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 81: | ||
===== Developer Information ===== | ===== Developer Information ===== | ||
+ | === Driver APIs === | ||
+ | * [[dev:netdriverapi|gPXE Network Driver API]] | ||
+ | * [[http://etherboot.org/wiki/soc/2008/mdeck/notes/gpxe_driver_api|PCI, network driver, and non-volatile storage APIs]] | ||
+ | === Debugging === | ||
+ | * [[dev:gdbstub|GDB remote debugging]] | ||
+ | * [[dev:prefixdebugging|Prefix debugging]] | ||
+ | |||
+ | === Old stuff === | ||
* [[dev:devmanual|A somewhat dated Etherboot Developers' manual]] (does not cover recent versions of Etherboot, or gPXE) | * [[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:todo|A Developer To-Do List]] | ||
- | |||
- | * [[dev:netdriverapi|gPXE Network Driver API]] | ||
- | * [[dev:gdbstub|GDB remote debugging]] | ||
- | |||
- |