RFC: Packager's Guide - Content Specification
pkovar at redhat.com
Thu Mar 13 17:42:41 UTC 2014
On Thu, 13 Mar 2014 07:51:48 -0400 (EDT)
Bohuslav Kabrda <bkabrda at redhat.com> wrote:
> ----- Original Message -----
> > Hi all,
> > This is not really related to the current conversations about playground
> > repos etc., but I wanted to bring this up anyway.
> Thanks for this, Petr. See my comments below.
Thanks for your feedback. :-)
> > Table of Contents
> > * Introduction to the RPM Package Manager:
> > This chapter introduces the RPM Package Manager, describes the
> > RPM package design, defines the basic content of every RPM
> > package, and shows how to explore the RPM package structure
> > What Are Packages, and Why Manage Them?
> > RPM Design Goals
> > What Is in a Package?
> > Using rpm2cpio
> <nitpicking>I'd say rpm2cpio should be a subchapter of What is in a package? I don't consider it to be equally important as e.g. RPM design goals and other top-level chapters.</nitpicking>
Yes, that totally makes sense. Good point.
> > Source Package Files and How to Use Them
> > * Creating and Building RPM Packages:
> This section would deserve a chapter about mock, IMO.
Will include it in the specification.
> > The Basics of Building RPM Packages
> > Creating a Basic spec File
> > spec Templates and Examples
> > Templates
> > Examples
> > Building a Package
> > Testing a Package
> > Testing a spec File
> > Testing a spec File
> > Testing a Binary Package
> > Testing a Source Package
> Are you planning to mention tools like rpmlint and fedora-review in Testing a Package?
Yes, I will talk about these tools in that section.
> > * Appendix - Eclipse RPM Building:
> > This appendix contains information on how to build RPM
> > packages in Eclipse Development Environment.
> > Eclipse Built-in Specfile Editor
> > * Appendix - Java Packaging:
> Why Java and why not other languages? Is this section going to contain parts of Java packaging guidelines?
Others already answered this one (thanks, Stano & Mikolaj!). I will just
add that the purpose of the Packager's Guide is to supplement the official
Packaging Guidelines rather than replace them. The Guidelines will stay on
the wiki in the Packaging: namespace (if the Packaging Committee doesn't
decide otherwise, of course). The Guide is, however, intended to provide
content that wouldn't fit in the Guidelines.
> I'd advise introducing a section that'd link current Fedora guidelines, so that people could use this documentation as a central place; but I'd also advise not including parts of the actual guidelines, so that we don't duplicate the information.
Sure, I will refer to the Guidelines where possible/needed.
More information about the env-and-stacks