| Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 1 | Documentation |
| 2 | ============= |
| 3 | |
| 4 | This is the directory that contains the BitBake documentation. |
| 5 | |
| 6 | Manual Organization |
| 7 | =================== |
| 8 | |
| 9 | Folders exist for individual manuals as follows: |
| 10 | |
| 11 | * bitbake-user-manual - The BitBake User Manual |
| 12 | |
| 13 | Each folder is self-contained regarding content and figures. |
| 14 | |
| 15 | If you want to find HTML versions of the BitBake manuals on the web, |
| 16 | go to http://www.openembedded.org/wiki/Documentation. |
| 17 | |
| Andrew Geissler | 4873add | 2020-11-02 18:44:49 -0600 | [diff] [blame^] | 18 | Makefile |
| 19 | ======== |
| Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 20 | |
| Andrew Geissler | 4873add | 2020-11-02 18:44:49 -0600 | [diff] [blame^] | 21 | The Makefile processes manual directories to create HTML, PDF, |
| 22 | tarballs, etc. Details on how the Makefile work are documented |
| 23 | inside the Makefile. See that file for more information. |
| Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 24 | |
| Andrew Geissler | 4873add | 2020-11-02 18:44:49 -0600 | [diff] [blame^] | 25 | To build a manual, you run the make command and pass it the name |
| 26 | of the folder containing the manual's contents. |
| 27 | For example, the following command run from the documentation directory |
| 28 | creates an HTML and a PDF version of the BitBake User Manual. |
| 29 | The DOC variable specifies the manual you are making: |
| Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 30 | |
| Andrew Geissler | 4873add | 2020-11-02 18:44:49 -0600 | [diff] [blame^] | 31 | $ make DOC=bitbake-user-manual |
| Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 32 | |
| Andrew Geissler | 4873add | 2020-11-02 18:44:49 -0600 | [diff] [blame^] | 33 | template |
| 34 | ======== |
| 35 | Contains various templates, fonts, and some old PNG files. |
| Patrick Williams | c124f4f | 2015-09-15 14:41:29 -0500 | [diff] [blame] | 36 | |
| Andrew Geissler | 4873add | 2020-11-02 18:44:49 -0600 | [diff] [blame^] | 37 | tools |
| 38 | ===== |
| 39 | Contains a tool to convert the DocBook files to PDF format. |