Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Last revision Both sides next revision
doc [2008/08/08 05:26]
verkout Added reference to using wraplinux iso mknbi in certain circumstances
doc [2010/05/02 04:03]
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 55: Line 65:
   * [[multicast|Multicast protocol support (slam/​tftp-multicast)]]   * [[multicast|Multicast protocol support (slam/​tftp-multicast)]]
   * [[safebootmode|Experimental SafeBootMode cryptographic boot image check]]   * [[safebootmode|Experimental SafeBootMode cryptographic boot image check]]
 +  * [[romdumping|Dumping PCI expansion ROMs]]
  
 ==== Using the "​mknbi"​ Utility with Etherboot ==== ==== Using the "​mknbi"​ Utility with Etherboot ====
Line 70: Line 81:
  
 ===== Developer Information ===== ===== Developer Information =====
 +=== Driver APIs ===
 +  * [[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:​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:​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]] 
- 
- 

QR Code
QR Code doc (generated for current page)