Features/DebugInfoRevamp

From FedoraProject

< Features(Difference between revisions)
Jump to: navigation, search
(Release Notes)
Line 1: Line 1:
 
= DebugInfo Revamp =
 
= DebugInfo Revamp =
<!-- The name of your feature -->
 
  
 
== Summary ==
 
== Summary ==
A revamp of the debuginfo rpm generation scheme exploiting new tools for
+
A revamp of the debuginfo rpm generation scheme exploiting new tools for DWARF compression.
DWARF compression.
+
  
 
== Owner ==
 
== Owner ==
Line 11: Line 9:
  
 
== Current status ==
 
== Current status ==
* Targeted release: [[Releases/11 | 11 ]]
+
* Targeted release: [[Releases/11 | Fedora 11 ]]
* Last updated: 2009-1-7
+
* Last updated: 2009-01-07
 
* Percentage of completion: 1%
 
* Percentage of completion: 1%
  
Line 45: Line 43:
  
 
== How To Test ==
 
== How To Test ==
<!-- This does not need to be a full-fledged document.  Describe the dimensions of tests that this feature is expected to pass when it is done.  If it needs to be tested with different hardware or software configurations, indicate them.  The QA team will turn this information into a more complete test plan.  The more specific you can be, the better the final test plan will be.
 
 
Remember that you are writing this test plan for interested testers to use to check out your feature - documenting what you do for testing is OK, but it's much better to document what *I* can do to test your feature.
 
 
A good Test Plan should answer these four questions:
 
 
0. What special hardware / data / etc. is needed (if any)?
 
1. How do I prepare my system to test this feature? What packages
 
need to be installed, config files edited, etc.?
 
2. What specific actions do I perform to check that the feature is
 
working like it's supposed to?
 
3. What are the expected results of those actions?
 
 
-->
 
 
 
The elfutils team is set up for mass-testing against all the existing
 
The elfutils team is set up for mass-testing against all the existing
 
debuginfo rpm ELF files and will use that to test the DWARF transformation
 
debuginfo rpm ELF files and will use that to test the DWARF transformation
Line 73: Line 56:
  
 
== User Experience ==
 
== User Experience ==
Quicker to download and install debuginfo rpms.
+
* Quicker to download and install debuginfo rpms.
  
 
== Dependencies ==
 
== Dependencies ==
  
elfutils work.
+
* elfutils work.
 
+
* Might like a mass rebuild to get all new debuginfo rpms for the release.
Might like a mass rebuild to get all new debuginfo rpms for the release.
+
  
 
== Contingency Plan ==
 
== Contingency Plan ==
  
We can punt the whole thing.
+
Possibilities:
 
+
* We can punt the whole thing.
We can do it but skip the mass rebuild.
+
* We can do it but skip the mass rebuild.
 
+
* We can punt adapting gdb et al if we do a deployment scheme that explodes to compatible old data in %post.
We can punt adapting gdb et al if we do a deployment scheme that explodes
+
to compatible old data in %post.
+
  
 
== Documentation ==
 
== Documentation ==
  
https://fedorahosted.org/elfutils/wiki/RpmDebugInfo
+
* https://fedorahosted.org/elfutils/wiki/RpmDebugInfo
  
 
== Release Notes ==
 
== Release Notes ==
 
<!-- The Fedora Release Notes inform end-users about what is new in the release.  Examples of past release notes are here: http://docs.fedoraproject.org/release-notes/ -->
 
<!-- The release notes also help users know how to deal with platform changes such as ABIs/APIs, configuration or data file formats, or upgrade concerns.  If there are any such changes involved in this feature, indicate them here.  You can also link to upstream documentation if it satisfies this need.  This information forms the basis of the release notes edited by the documentation team and shipped with the release. -->
 
  
 
* '''FIXME''': Should have some notes about conventions and tools when decided.
 
* '''FIXME''': Should have some notes about conventions and tools when decided.
Line 104: Line 81:
  
 
* See [[Talk:Features/DebugInfoRevamp]]
 
* See [[Talk:Features/DebugInfoRevamp]]
 
  
 
----
 
----
  
[[Category:FeatureReadyForWrangler]]
+
[[Category:FeatureReadyForFesco]]
 
<!-- When your feature page is completed and ready for review -->
 
<!-- When your feature page is completed and ready for review -->
 
<!-- remove Category:FeaturePageIncomplete and change it to Category:FeatureReadyForWrangler -->
 
<!-- remove Category:FeaturePageIncomplete and change it to Category:FeatureReadyForWrangler -->
 
<!-- After review, the feature wrangler will move your page to Category:FeatureReadyForFesco... if it still needs more work it will move back to Category:FeaturePageIncomplete-->
 
<!-- After review, the feature wrangler will move your page to Category:FeatureReadyForFesco... if it still needs more work it will move back to Category:FeaturePageIncomplete-->
 
<!-- A pretty picture of the page category usage is at: https://fedoraproject.org/wiki/Features/Policy/Process -->
 
<!-- A pretty picture of the page category usage is at: https://fedoraproject.org/wiki/Features/Policy/Process -->

Revision as of 16:57, 15 January 2009

Contents

DebugInfo Revamp

Summary

A revamp of the debuginfo rpm generation scheme exploiting new tools for DWARF compression.

Owner

Current status

  • Targeted release: Fedora 11
  • Last updated: 2009-01-07
  • Percentage of completion: 1%

Detailed Description

New work in elfutils will provide facilities for DWARF compression. The conventions for finding separate debuginfo files might be enhanced or rejiggered in tools like gdb and systemtap. The rpmbuild macros and scripts for generating debuginfo packages will be rewritten. These are expected to make the debuginfo rpms much smaller.

Possibly the standard will change to split debuginfo packages into debuginfo proper (/usr/lib/debug files) and sources (/usr/src/debug files) as separate subpackages.

Benefit to Fedora

Much smaller debuginfo rpms, quicker to download, smaller to host/mirror, etc.

Scope

elfutils team has to write the DWARF compression tools (will also replace rpm's debugedit), come up with debuginfo convention changes.

elfutils team + rpm/redhat-rpm-config maintainers have to decide about subpackage conventions and implement new macros/script to replace rpmbuild find-debuginfo.sh magic.

Either gdb team has to adapt it to new conventions, or DWARF tool + rpm deployment plan could include exploding in %post to current layout.

If rpm subpackage convention changes, possibly rel-eng needs to adjust mash for new naming convention and multiple debuginfo-related rpms per package.

How To Test

The elfutils team is set up for mass-testing against all the existing debuginfo rpm ELF files and will use that to test the DWARF transformation tools. https://fedorahosted.org/elfutils/wiki/DebugInfoTesting

When https://fedorahosted.org/elfutils/wiki/RpmDebugInfo work is complete, we should do mass rebuild tests outside the buildsystem to rebuild all of rawhide with the new toolset. We can then unpack all that data and run format tests against it.

Maybe do this twice, once first with the new rpmbuild helpers hacked to do dwarflint+pack+unpack+dwarflint+pack.

User Experience

  • Quicker to download and install debuginfo rpms.

Dependencies

  • elfutils work.
  • Might like a mass rebuild to get all new debuginfo rpms for the release.

Contingency Plan

Possibilities:

  • We can punt the whole thing.
  • We can do it but skip the mass rebuild.
  • We can punt adapting gdb et al if we do a deployment scheme that explodes to compatible old data in %post.

Documentation

Release Notes

  • FIXME: Should have some notes about conventions and tools when decided.

Comments and Discussion