| Summary: | Remove mentions of oprofile | ||
|---|---|---|---|
| Product: | [Documentation] General Docs | Reporter: | Ross Burton <ross.burton> |
| Component: | docs-general | Assignee: | Scott Rifenbark <srifenbark> |
| Status: | RESOLVED FIXED | QA Contact: | |
| Severity: | normal | ||
| Priority: | Medium | CC: | richard.purdie, srifenbark |
| Version: | 2.1 | ||
| Target Milestone: | 2.1 M4 | ||
| Hardware: | All | ||
| OS: | Multiple | ||
| Whiteboard: | 15 April 2016: IN PROGRESS REVIEW | ||
| OS type for building Yocto: | --- | Type of Regression: | --- |
| Verified: | Documentation change: | Yes (doc changes required) | |
Hi, I sent Ross Burton an email with the "tools-profile" hits throughout the YP doc set. I need some clarification on each of them. Thanks, Scott Ross, Here are the spots I need some help on: DEV-MANUAL * http://www.yoctoproject.org/docs/2.1/dev-manual/dev-manual.html#structure-your-layers - Can we just dump the example? Or, do we want to replace with a new code example? If so, I need an example. * http://www.yoctoproject.org/docs/2.1/dev-manual/dev-manual.html#usingpoky-extend-customimage-customtasks - I need something else here to fill in the package-group-custom-tools. Right now it is heavy with "oprofile." * http://www.yoctoproject.org/docs/2.1/dev-manual/dev-manual.html#platdev-appdev-srcrev - this section makes reference to the poky/meta-poky/conf/distro/include/poky-floating-revisions.inc file. The section shows some lines from that actual file, which is http://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta-poky/conf/distro/include/poky-floating-revisions.inc. I can just remove that line but the bigger question would be all the occurrences of "oprofile" in that actual file. PROFILE-MANUAL * http://www.yoctoproject.org/docs/2.1/profile-manual/profile-manual.html#profile-manual-oprofile - This is a major section in the manual. Do we just delete it? The section contains 4 subsections (3.4.1 through 3.4.4) and has figures I would need to get out of the manual's build scripts. * http://www.yoctoproject.org/docs/2.1/profile-manual/profile-manual.html#profile-manual-general-setup - This is a reference to adding "tools-profile". What do we do with it? * http://www.yoctoproject.org/docs/2.1/profile-manual/profile-manual.html#using-perf-to-do-basic-profiling - Way down in this section is another reference to "tools-profile". I don't know the relationship between "oprofile" and "tools-profile". Not sure what to do with this occurrence. * http://www.yoctoproject.org/docs/2.1/profile-manual/profile-manual.html#systemtap-setup - Other references in the example output to "tools-profile" and in some of the explanations. I don't know what to do with these. REF-MANUAL * http://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#ref-features-image - There is a "tools-profile" entry in the list. What do we do about this? SDK-MANUAL * http://www.yoctoproject.org/docs/2.1/sdk-manual/sdk-manual.html#user-space-tools - I am just removing oprofile as one of the listed user-space tools. * http://www.yoctoproject.org/docs/2.1/sdk-manual/sdk-manual.html#running-user-space-tools - Again, here I am just removing the bulleted item for oprofile. Inserting my own comments inline on the easy points: DEV-MANUAL * http://www.yoctoproject.org/docs/2.1/dev-manual/dev-manual.html#structure-your-layers - Can we just dump the example? Or, do we want to replace with a new code example? If so, I need an example. Replace with gnutls: DEPENDS_append_libc-musl = " argp-standalone" (adds dependencies on argp-standalone when building with the musl C library) * http://www.yoctoproject.org/docs/2.1/dev-manual/dev-manual.html#usingpoky-extend-customimage-customtasks - I need something else here to fill in the package-group-custom-tools. Right now it is heavy with "oprofile." As this is a contrived example, I'd say we can keep this. * http://www.yoctoproject.org/docs/2.1/dev-manual/dev-manual.html#platdev-appdev-srcrev - this section makes reference to the poky/meta-poky/conf/distro/include/poky-floating-revisions.inc file. The section shows some lines from that actual file, which is http://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta-poky/conf/distro/include/poky-floating-revisions.inc. I can just remove that line but the bigger question would be all the occurrences of "oprofile" in that actual file. Agreed, remove the line. I'll send a patch to update that file, it's very out of date now. REF-MANUAL * http://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#ref-features-image - There is a "tools-profile" entry in the list. What do we do about this? Replace oprofile with "perf", and exmap with SystemTap (exmap was removed some time ago). SDK-MANUAL Removals are all good. The profiling manual will need more work, I'll do that next. PROFILE-MANUAL * http://www.yoctoproject.org/docs/2.1/profile-manual/profile-manual.html#profile-manual-oprofile - This is a major section in the manual. Do we just delete it? The section contains 4 subsections (3.4.1 through 3.4.4) and has figures I would need to get out of the manual's build scripts. Just delete it, perf replaces oprofile and we have a section on perf. * http://www.yoctoproject.org/docs/2.1/profile-manual/profile-manual.html#profile-manual-general-setup - This is a reference to adding "tools-profile". What do we do with it? tools-profile is a group of packages that used to include oprofile but still includes perf and other packages, so keep this. * http://www.yoctoproject.org/docs/2.1/profile-manual/profile-manual.html#using-perf-to-do-basic-profiling - Way down in this section is another reference to "tools-profile". I don't know the relationship between "oprofile" and "tools-profile". Not sure what to do with this occurrence. As above, keep. * http://www.yoctoproject.org/docs/2.1/profile-manual/profile-manual.html#systemtap-setup - Other references in the example output to "tools-profile" and in some of the explanations. I don't know what to do with these. As above, keep. Ross, Addressed the ones I needed to. If you want to check them do so quickly as my deadline for changes on the docs is today. Thanks, Scott |
In 2.0 we removed oprofile and oprofileui from the tools-profile packagegroup but there are still plenty of references to it. Quoting from another bug report: ---- I just saw what you said mentioned as well in the manual[1], but there is still the oprofile example here[2] and various references to tools-profile, which claim the oprofile is still part of it like: "tools-profile: Installs profiling tools such as oprofile, exmap, and LTTng. For general information on user-space tools, see the "User-Space Tools" section in the Yocto Project Application Developer's Guide." and "To use OProfile, you need an image that has OProfile installed. The easiest way to do this is with "tools-profile" in the IMAGE_FEATURES variable." ""tools-profile" - Adds profiling tools such as oprofile, exmap, lttng and valgrind (x86 only)." just search for tools-profile in the latest mega-manual [1] http://www.yoctoproject.org/docs/latest/mega-manual/mega-manual.html#migration-2.0-miscellaneous [2] http://www.yoctoproject.org/docs/latest/mega-manual/mega-manual.html#profile-manual-oprofile ----- Some of the sections will be harder to rewrite (eg how to profile using oprofile) but we can at least remove oprofile from the tools-profile summaries for example.