README 1.1 KB

123456789101112131415161718192021222324252627282930313233343536373839
  1. Documentation
  2. =============
  3. This is the directory that contains the BitBake documentation.
  4. Manual Organization
  5. ===================
  6. Folders exist for individual manuals as follows:
  7. * bitbake-user-manual - The BitBake User Manual
  8. Each folder is self-contained regarding content and figures.
  9. If you want to find HTML versions of the BitBake manuals on the web,
  10. go to http://www.openembedded.org/wiki/Documentation.
  11. Makefile
  12. ========
  13. The Makefile processes manual directories to create HTML, PDF,
  14. tarballs, etc. Details on how the Makefile work are documented
  15. inside the Makefile. See that file for more information.
  16. To build a manual, you run the make command and pass it the name
  17. of the folder containing the manual's contents.
  18. For example, the following command run from the documentation directory
  19. creates an HTML and a PDF version of the BitBake User Manual.
  20. The DOC variable specifies the manual you are making:
  21. $ make DOC=bitbake-user-manual
  22. template
  23. ========
  24. Contains various templates, fonts, and some old PNG files.
  25. tools
  26. =====
  27. Contains a tool to convert the DocBook files to PDF format.