From 6714a6c59a4aea772b256048b778d0c30159b421 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Wed, 18 Jun 2014 10:29:12 +0300 Subject: dev-manual, kernel-dev, profile-manual: Fixed title and link issues. Following fixes: dev-manual - Discovered a tag that was not a single line. These types of links need to not have hard returns. If they do, mega-manual.sed will not process the link. Changed the reference to a single line. kernel-dev - Discovered that I had the old poky.ent variable (i.e. YOCTO_DOCS_KERNEL_URL) as part of the link in the opening note on the title page. I changed it to the proper variable, which is YOCTO_DOCS_KERNEL_DEV_URL. The old link was not being processed by mega-manual.sed. profile-manual - First problem was the wrong manual title in a tag, which caused the mega-manual.sed file to skip processing the link into a non-link. Second problem was on the title page. Incredulously, I had the title of the manual reversed for Chapter 1. Fixed it. (From yocto-docs rev: 71dedd610dce9fdc6472a5cf2b18ec8729d77e55) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/dev-manual/dev-manual-model.xml | 91 +++++++++++----------- documentation/kernel-dev/kernel-dev.xml | 2 +- .../profile-manual/profile-manual-intro.xml | 2 +- documentation/profile-manual/profile-manual.xml | 2 +- 4 files changed, 48 insertions(+), 49 deletions(-) diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml index a59a447ce8..d2f6e938ed 100644 --- a/documentation/dev-manual/dev-manual-model.xml +++ b/documentation/dev-manual/dev-manual-model.xml @@ -18,8 +18,7 @@ "Creating a New BSP Layer Using the yocto-bsp Script" section in the Yocto Project Board Support Package (BSP) Developer's Guide. For more complete information on how to work with the kernel, see the - Yocto Project Linux Kernel - Development Manual. + Yocto Project Linux Kernel Development Manual. User Application Development: User Application Development covers development of applications that you intend @@ -131,7 +130,7 @@ yocto-bsp script: Layers are ideal for isolating and storing work for a given piece of hardware. - A layer is really just a location or area in which you place + A layer is really just a location or area in which you place the recipes and configurations for your BSP. In fact, a BSP is, in itself, a special type of layer. The simplest way to create a new BSP layer that is compliant with the @@ -165,7 +164,7 @@ Romley, sys940x, Sugar Bay, and tlk exist in their own separate layers within the larger meta-intel layer. When you set up a layer for a new BSP, you should follow a standard layout. - This layout is described in the + This layout is described in the "Example Filesystem Layout" section of the Board Support Package (BSP) Development Guide. In the standard layout, you will notice a suggested structure for recipes and @@ -343,10 +342,10 @@ If you are working in the kernel all the time, you probably would want to set up your own local Git repository of the kernel tree. If you just need to make some patches to the kernel, you can access - temporary kernel source files that were extracted and used + temporary kernel source files that were extracted and used during a build. We will just talk about working with the temporary source code. - For more information on how to get kernel source code onto your + For more information on how to get kernel source code onto your host system, see the "Yocto Project Kernel" bulleted item earlier in the manual. @@ -411,7 +410,7 @@ "Yocto Project Release" earlier in this manual. Establish the temporary kernel source files: - Temporary kernel source files are kept in the + Temporary kernel source files are kept in the Build Directory created by the OpenEmbedded build system when you run BitBake. @@ -474,7 +473,7 @@ Application development involves creating an application that you want to run on your target hardware, which is running a kernel image created using the OpenEmbedded build system. - The Yocto Project provides an + The Yocto Project provides an Application Development Toolkit (ADT) and stand-alone cross-development toolchains @@ -950,7 +949,7 @@ and then click "Next". Select the root directory and browse to ~/yocto-eclipse/plugins. - Three plug-ins exist: + Three plug-ins exist: org.yocto.bc.ui, org.yocto.sdk.ide, and org.yocto.sdk.remotetools. @@ -980,7 +979,7 @@ To start, you need to do the following from within the Eclipse IDE: - Choose "Preferences" from the + Choose "Preferences" from the "Windows" menu to display the Preferences Dialog Click "Yocto Project ADT" @@ -1010,7 +1009,7 @@ Build System Derived Toolchain: Select this mode if the cross-toolchain has been installed and built - as part of the + as part of the Build Directory. When you select Build system derived toolchain, you are using the toolchain bundled @@ -1022,7 +1021,7 @@ If you are using a stand-alone pre-built toolchain, you should be pointing to the where it is installed. If you used the ADT Installer script and accepted the default - installation directory, the toolchain will be installed in + installation directory, the toolchain will be installed in the &YOCTO_ADTPATH_DIR; directory. Sections "Configuring and Running the ADT Installer Script" and @@ -1034,17 +1033,17 @@ field is the Build Directory. See the "Using BitBake and the Build Directory" section in the Yocto Project Application - Developer's Guide for information on how to install + Developer's Guide for information on how to install the toolchain into the Build Directory. Specify the Sysroot Location: This location is where the root filesystem for the target hardware resides. - If you used the ADT Installer script and accepted the + If you used the ADT Installer script and accepted the default installation directory, then the location is /opt/poky/<release>. Additionally, when you use the ADT Installer script, the same location is used for the QEMU user-space tools and the NFS boot process. - If you used either of the other two methods to + If you used either of the other two methods to install the toolchain or did not accept the ADT Installer script's default installation directory, then the location of the sysroot filesystem depends on where you separately @@ -1160,7 +1159,7 @@ configurations. You can override these settings for a given project by following these steps: - Select "Change Yocto Project Settings" from the + Select "Change Yocto Project Settings" from the "Project" menu. This selection brings up the Yocto Project Settings Dialog and allows you to make changes specific to an individual project. @@ -1170,14 +1169,14 @@ Dialog as described earlier in the "Configuring the Eclipse Yocto Plug-in" section. - The Yocto Project Settings Dialog allows you to override + The Yocto Project Settings Dialog allows you to override those default settings for a given project. Make your configurations for the project and click "OK". If you are running the Juno version of Eclipse, you can skip down to the next section where you build the project. If you are not working with Juno, you need to reconfigure the project as described in the next step. - Select "Reconfigure Project" from the + Select "Reconfigure Project" from the "Project" menu. This selection reconfigures the project by running autogen.sh in the workspace for your project. @@ -1197,7 +1196,7 @@ To build the project in Juno, right click on the project in the navigator pane and select "Build Project". - If you are not running Juno, select "Build Project" from the + If you are not running Juno, select "Build Project" from the "Project" menu. The console should update and you can note the cross-compiler you are using. @@ -1209,7 +1208,7 @@ To start the QEMU emulator from within Eclipse, follow these steps: - Expose and select "External Tools" from + Expose and select "External Tools" from the "Run" menu. Your image should appear as a selectable menu item. @@ -1232,12 +1231,12 @@ Deploying and Debugging the Application - Once the QEMU emulator is running the image, you can deploy - your application using the Eclipse IDE and use then use + Once the QEMU emulator is running the image, you can deploy + your application using the Eclipse IDE and use then use the emulator to perform debugging. Follow these steps to deploy the application. - Select "Debug Configurations..." from the + Select "Debug Configurations..." from the "Run" menu. In the left area, expand C/C++Remote Application. Locate your project and select it to bring up a new @@ -1258,7 +1257,7 @@ determined earlier. Click "Finish" to close the New Connections Dialog. - Use the drop-down menu now in the + Use the drop-down menu now in the "Connection" field and pick the IP Address you entered. Click "Run" to bring up a login screen @@ -1315,8 +1314,8 @@ display the output. For information on how to use Lttng to trace an application, see - and the - "LTTng (Linux Trace Toolkit, next generation)" + and the + "LTTng (Linux Trace Toolkit, next generation)" section, which is in the Yocto Project Profiling and Tracing Manual. Do not use Lttng-user space (legacy) tool. This tool no longer has any upstream support. @@ -1326,18 +1325,18 @@ Tracing project. Do the following: - Select "Open Perspective" from the + Select "Open Perspective" from the "Window" menu and then select "Tracing". Click "OK" to change the Eclipse perspective into the Tracing perspective. Create a new Tracing project by selecting "Project" from the "File -> New" menu. - Choose "Tracing Project" from the + Choose "Tracing Project" from the "Tracing" menu. Generate your tracing data on the remote target. - Select "Lttng2.0 ust trace import" from + Select "Lttng2.0 ust trace import" from the "Yocto Project Tools" menu to start the data import process. Specify your remote connection name. @@ -1348,8 +1347,8 @@ Click "OK" to complete the import process. The data is now in the local tracing project you created. Right click on the data and then use the menu to - Select "Generic CTF Trace" from the - "Trace Type... -> Common Trace Format" menu to map + Select "Generic CTF Trace" from the + "Trace Type... -> Common Trace Format" menu to map the tracing type. Right click the mouse and select "Open" to bring up the Eclipse Lttng Trace Viewer so you @@ -1386,7 +1385,7 @@ Within the Eclipse IDE, you can create a Yocto BitBake Commander project, - edit the Metadata, and then use + edit the Metadata, and then use Hob to build a customized image all within one IDE. @@ -1397,16 +1396,16 @@ To create a Yocto BitBake Commander project, follow these steps: - Select "Other" from the - "Window -> Open Perspective" menu + Select "Other" from the + "Window -> Open Perspective" menu and then choose "Bitbake Commander". Click "OK" to change the perspective to Bitbake Commander. Select "Project" from the "File -> New" menu to create a new Yocto Bitbake Commander project. - Choose "New Yocto Project" from the - "Yocto Project Bitbake Commander" menu and click + Choose "New Yocto Project" from the + "Yocto Project Bitbake Commander" menu and click "Next". Enter the Project Name and choose the Project Location. The Yocto project's Metadata files will be put under the directory @@ -1424,7 +1423,7 @@ Editing the Metadata - After you create the Yocto Bitbake Commander project, you can modify the + After you create the Yocto Bitbake Commander project, you can modify the Metadata files by opening them in the project. When editing recipe files (.bb files), you can view BitBake @@ -1436,8 +1435,8 @@ To edit the Metadata, follow these steps: Select your Yocto Bitbake Commander project. - Select "BitBake Recipe" from the - "File -> New -> Yocto BitBake Commander" menu + Select "BitBake Recipe" from the + "File -> New -> Yocto BitBake Commander" menu to open a new recipe wizard. Point to your source by filling in the "SRC_URL" field. For example, you can add a recipe to your @@ -1459,13 +1458,13 @@ Building and Customizing the Image Using Hob - To build and customize the image using Hob from within the + To build and customize the image using Hob from within the Eclipse IDE, follow these steps: Select your Yocto Bitbake Commander project. Select "Launch Hob" from the "Project" menu. - Enter the + Enter the Build Directory where you want to put your final images. Click "OK" to launch Hob. @@ -1508,7 +1507,7 @@ support development using actual hardware. For example, the area might contain .hddimg files that combine the - kernel image with the filesystem, boot loaders, and + kernel image with the filesystem, boot loaders, and so forth. Be sure to get the files you need for your particular development process. @@ -1879,9 +1878,9 @@ For a better understanding of Hob, see the project page at - + on the Yocto Project website. - If you follow the "Documentation" link from the Hob page, you will + If you follow the "Documentation" link from the Hob page, you will find a short introductory training video on Hob. The following lists some features of Hob: @@ -1893,9 +1892,9 @@ You can set the MACHINE for which you are building the image. - You can modify various policy settings such as the + You can modify various policy settings such as the package format with which to build, - the parallelism BitBake uses, whether or not to build an + the parallelism BitBake uses, whether or not to build an external toolchain, and which host to build against. You can manage diff --git a/documentation/kernel-dev/kernel-dev.xml b/documentation/kernel-dev/kernel-dev.xml index c1c4660e07..702dda937d 100644 --- a/documentation/kernel-dev/kernel-dev.xml +++ b/documentation/kernel-dev/kernel-dev.xml @@ -71,7 +71,7 @@ Due to production processes, there could be differences between the Yocto Project documentation bundled in the release tarball and the - Yocto Project Linux Kernel Development Manual on + Yocto Project Linux Kernel Development Manual on the Yocto Project website. For the latest version of this manual, see the manual on the website. diff --git a/documentation/profile-manual/profile-manual-intro.xml b/documentation/profile-manual/profile-manual-intro.xml index 9ed807f356..e8e0908733 100644 --- a/documentation/profile-manual/profile-manual-intro.xml +++ b/documentation/profile-manual/profile-manual-intro.xml @@ -4,7 +4,7 @@ -Yocto Project Tracing and Profiling Manual +Yocto Project Profiling and Tracing Manual
Introduction diff --git a/documentation/profile-manual/profile-manual.xml b/documentation/profile-manual/profile-manual.xml index 4c7a4f453b..ca00d84484 100644 --- a/documentation/profile-manual/profile-manual.xml +++ b/documentation/profile-manual/profile-manual.xml @@ -74,7 +74,7 @@ Due to production processes, there could be differences between the Yocto Project documentation bundled in the release tarball and the - Yocto Project Tracing and Profiling Manual on + Yocto Project Profiling and Tracing Manual on the Yocto Project website. For the latest version of this manual, see the manual on the website. -- cgit v1.2.3-54-g00ecf