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
doc [2008/07/09 12:41]
hawke Add link to the command-line reference
doc [2010/06/09 14:08] (current)
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 55: Line 68:
   * [[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 ====
  
-Network Bootable Image format (NBI) is a legacy format that wraps operating system images (such as Linux kernels) in a wrapper, which makes it possible for Etherboot to load the images directly. The "​mknbi"​ (make NBI) utility performs ​tje wrapping operation. ​+Network Bootable Image format (NBI) is a legacy format that wraps operating system images (such as Linux kernels) in a wrapper, which makes it possible for Etherboot to load the images directly. The "​mknbi"​ (make NBI) utility performs ​the wrapping operation
 + 
 +=== NBI, Etherboot and Linux 2.6 === 
 +Unfortunately,​ mknbi cannot be used to make a NBI of a Linux 2.6 (or newer) kernel image. If you are tied to Etherboot but need to boot a Linux 2.6 or newer kernel, wraplinux must be used to create a working NBI. Follow the link to [[http://​www.kernel.org/​pub/​linux/​utils/​boot/​wraplinux|wraplinux]] on kernel.org to download it.
  
 **Note:** This is not needed for PXE and PXELINUX booting, and is not recommended for new users. ​ For new users, we recommend using [[http://​syslinux.zytor.com|PXELINUX]] **Note:** This is not needed for PXE and PXELINUX booting, and is not recommended for new users. ​ For new users, we recommend using [[http://​syslinux.zytor.com|PXELINUX]]
Line 67: Line 84:
  
 ===== 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)