{{Chris Tyler Draft}}[[Category:Winter 2011 SBR600]]{{Admon/important|Tentative Schedule - Winter 2011|Please note that the schedule here is tentative. Week-by-week details will be filled in as the course progresses. This content is also being refactored for easier navigation.}}

= Week 1 (Jan 10) - Introduction , Building from Source, and Creating RPM Packages =

=== Welcome ===* WelcomeAbout this course

* === Intro to SBR600 - Software Build & Release===** [[SBR600 Overview of the Build and Release Process|Brief overview of the process*** Versioning Build & repository systems*** Compilation*** Testing*** Packaging*** Compositing*** Release*** Distribution*** Mirroring** These steps vary according to the particular project/product. For example, when distributing software physically, "Release" means performing a release-to-manufacturing (RTM), where the final "gold disk" is sent to the duplicating house to be mass-produced; but when distributing software electronically, "Release" means sending the software to the online distribution system. The sequence of steps also varies between projects/products.process]]

* <span style="background: #ffff00">* [[SBR600 Communication Tools|Communication Tools]]</span> - '''Resource page for setting up wiki, IRC, and FAS2 accounts'''** [[SBR600|Course Outline]]* How this Course Works** [[SBR600 Communication Tools]]** How coursework is submitted in SBR600* [[FUDCon Tempe 2011]] trip** Selection of attendees* Visit to the [[CDOTArea]] Area

# [[SBR600 Communication Lab|Communication Lab]]# [[SBR600 Fedora Installation|Fedora Installation]]# [[SBR600 Build-from-Source Lab|Build-from-Source Lab]]

* Purpose* What=== Using 's in an RPM package file** Metadata*** What the package provides*** Dependencies*** Packager, date, license, summary, description, ...** Digital signature** Software** Data*** Fonts*** Icons*** Sample data** Documentation** Configuration files** Setup scripts*** Pre-install*** Post-install*** Pre-uninstall*** Post-uninstall*** Triggers'make'' ===

=== RPM Packages ===* Differences between managing RPMS and Installing from Source** RPMS provide a database of installed software*** Let you determine what's installed*** Purpose Automatic management of dependencies*** Identify the databaseorigin of files* Querying the RPM database** Permit easy update or removal** rpm -q* Enable you to verify installation (useful for spotting file corruption and intrusions)* [[RPM Package Contents|Contents of an RPM Package]]

== Friday = The RPM Database ===

* Packaging scenarios* Setting up a Packaging Environment** Needed packages*** rpm-build*** rpmdevtools*** rpmlint*** yum-utils** Setting up the RPM tree*** run <code>rpmdev-setuptree</code>* Taking a look at existing source RPMS (useful as examples)** Installing *** <code>yumdownloader --source <i>nameofpackage</i></code>*** <code>rpm -i <i>nameofpackage</i>.src.rpm</code>*** Source will be in ~/rpmbuild/SOURCES and specfile will be in ~/rpmbuild/SPECS** Examine the specfile** Rebuild on the local machine -- takes a source RPM (SRPM) as input, produces binary and source RPMs as output*** <code>rpmbuild --rebuild <i>nameofpackage</i>.src.rpm</code>** Building from the spec file -- takes === Layout of a specfile and source code as input, produces binary and source RPMs as output*** <code>cd ~/rpmbuild/SPECS; rpmbuild -ba <i>nameofpackage</i>.spec</code>===

* Run <code>rpmdev-newspec ''packagename''</code> in ~/rpmbuild/SPECS* Edit the skeleton specfile.* Test it: <code>rpmbuild -ba ''packagename''.spec</code>** If successful, output will be binary RPM(s) in ~/rpmbuild/RPMS and source RPM in ~/rpmbuild/SRPMS*** Can install binary RPM with: <code>rpm -i ''rpmname''</code>** If unsuccessful, read the error messages carefully.* Check it with rpmlint: <code>rpmlint ''packagename''*</code>** Remember to check the spec file as well as the binary and source RPMs.** Correct any errors found. === Layout of a specfile Creating Packages ===

* Basic Sections# preamble - basic metadata# %prep - commands to prepare the package for building# %build - commands to build the package# %install - commands to install the built files# %check - commands to check/test the built files (optional, often not included)# %clean - commands to clean up the disk space# %files - list of files to be included in the pacakge# %changelog - record of the package's change-history* Scriptlets** %pre -- run before installation** %post -- run after installation** %preun -- run before uninstallation** %postun -- run after uninstallation*** Note that during upgrade, the installation of the new package is considered to happen before the removal of the old package.* Macros** %{_tmppath}** %{buildroot}** %{_bindir}** %{_datadir}** %{_mandir}** %{_smp_flags}** %setup** %configure** %makeinstall[[RPM Packaging Process]]

** Using rpmlint

== Readings/Resources ==By '''Monday, January 17''':* Two simple # [[httpSBR600 RPM-Writing Lab|RPM-Writing Lab]]# Send your [[SSH]] public key to [[User://matrix.senecac.Chris Tyler|your professor]] so he can create accounts for you onthe [[CDOT Development Systems]].ca/~chris.tyler/osd600/makefile-examples.tgz makefile examples]

'''Lab 1: By Monday, September 13:'''This is a project-based course. These projects involve participation in an open-source community.# '''Lab 1'''* Projects are listed on the [[SBR600 Potential Projects]] page.#* Build 2 packages from SourceSelect two or three projects that are of interest to you.#*# The NLED editor from [http://cdot.senecac* Do some initial research into what the project involves.*** Find out who to talk to in the community (start with the initial contacts listed onthe project description)*** See what work has already been done related to that project.ca http://cdotCheck the Seneca wiki for work by previous SBR600 semesters, the upstream project's wiki and mailing list archives for information about the current state of the project, and the web for related information (similar projects being done by other groups).senecac*** Join the mailing lists and IRC channels of the upstream community.on** Update the [[Winter 2011 SBR600 Participants]] table with your project information, according to the instructions at the top of that page.ca* [[User:Chris Tyler|Your professor]] will approve your project selection via the [[Winter 2011 SBR600 Participants||participants page]].#*# Any package that uses Link your project title on the [[Winter 2011 SBR600 Participants|participants page]] to a configure script -- SourceForge might be page of the same name to create a good place project page. Copy the contents of the [[Sample Project]] page to look for such packages.#* Blog about your project page and fill in the experiencedetails.

= Week Over the next 2 weeks, finalize your project plans and get started on your project:* The project page must be filled in, including your 0.1, 0.2, and 0.3 targets.** Release 0.1: Proof of concept (January 17e.g., a first draft of a package, a basic script, infrastructure set up on a test system) - RPM Packages I =Note that this must include the release of ''something'', not just research, and must be done in consultation with the community.** Release 0.2: Initial working state - Whatever you are working on -- package, script, infrastructure configuration -- should be working, although it may not be feature-complete, fully deployed, or fully documented. Feedback from the community should be solicited. If there is a review process required to submit upstream, it should be started.** Release 0.3: Completed working state - The work is complete and documented. Any upstream review, whether formal or informal, has been completed, feedback has been incorporated into the project, and the work has been committed been* You must have a strategy in place for reaching your targets.You will make a brief (3-5 minute) presentation of your project plans on '''Thursday, February 3'''.

== Tuesday = ToDo ===* Discussion of issues related to building** Finding dependencies.** <code>-j''X''</code> flag to enable multiple jobs

=== * Finish [[SBR600 RPM Packages === * Purpose* What-Writing Lab|building your two RPMs]] before Thursday's class (we'll use them in an RPM package file** Metadata*** What the package provideslab)*** Dependencies*** Packager, date, license, summary, description, ...** Digital signature** Software** Data*** Fonts*** Icons*** Sample data** Documentation** Configuration files** Setup scripts*** Pre-install*** Post-install*** Pre-uninstall*** Post-uninstallSend your [[SSH]] key to [[User:Chris Tyler|your prof]] by Wednesday (will be needed for Thursday's lab)*** Triggers === The RPM Database === * Purpose of Review the database* Querying [[SBR600 Potential Projects]] and start researching the RPM database** rpm top 2-q3 possibilities.

=== Creating Packages mock: Testing BuildRequires ===

* Packaging scenarios* Setting up It's often difficult to get the BuildRequires in a Packaging Environment** Needed spec file exactly right, because it's easy to overlook packages*** rpm-build*** rpmdevtools*** rpmlint*** yum-utils** Setting up that are coincidentally installed on the machine. ''Mock'' is used to test that the RPM tree*** run <code>rpmdev-setuptree</code>* Taking BuildRequires for a package are complete and accurate, by creating a look at existing source RPMS (useful as examples)** Installing *** <code>yumdownloader bare--source <i>nameofpackage<bones [http:/i></code>*** <code>rpm -i <i>nameofpackage</i>en.srcwikipedia.rpm<org/code>*** Source will be in ~wiki/rpmbuildChroot chroot] environment containing only the [[:fedora:Packaging/SOURCES and specfile will be Guidelines#Exceptions_2|basic build packages]] plus any packages indicated by BuildRequires lines in ~/rpmbuild/SPECS** Examine the specfile** Rebuild on the local machine -- takes a source RPM (SRPM) as input, produces binary and source RPMs as output*** <code>rpmbuild --rebuild <i>nameofpackage</i>.src.rpm</code>** Building from the spec file -- takes a specfile and source code as input, produces binary and source RPMs as output*** <code>cd ~/rpmbuild/SPECS; rpmbuild -ba <i>nameofpackage</i>.spec</code>

=== Writing a specfile koji: Testing multiple architectures ===

* Run <code>rpmdev-newspec ''packagename''koji</code> in ~/rpmbuild/SPECS* Edit the skeleton specfile.* Test it: <code>rpmbuild -ba ''packagename''.spec</code>** If successful, output will be binary RPM(s) in ~/rpmbuild/RPMS and source RPM in ~/rpmbuild/SRPMS*** Can install binary RPM with: <code>rpm -i ''rpmname''</code>** If unsuccessful, read the error messages carefully.* Check it with rpmlint: <code>rpmlint ''packagename''*</code>** Remember to check the spec file as well as the binary and source RPMs.** Correct any errors found. === Layout of is a specfile === * Basic Sections# preamble - basic metadata# %prep client- commands server system which allows you to prepare queue builds within the package for building# %Fedora build - commands farm. This permits you to build the package# %install - commands to install the built files# %check - commands to check/test the built files (optional, often not included)# %clean - commands to clean up the disk space# %files - list of files to be included in the pacakge# %changelog - record of the whether your package's change-history* Scriptlets** %pre -- run before installation** %post -- run after installation** %preun -- run before uninstallation** %postun -- run after uninstallation*** Note that during upgradebuilds on several different architectures, the installation of the new package which is considered especially useful when you don't otherwise have access to happen before the removal machines of the old packagethat architecture.* Macros** %{_tmppath}** %{buildroot}** %{_bindir}** %{_datadir}** %{_mandir}** %{_smp_flags}** %setup** %configure** %makeinstall === Creating a Simple Package === * NLED* Writing the specfile* Testing the specfile* Using rpmlint

== ToDo =Week 3 (January 24) - Solving Build Issues =

* Finish tasks from week 1 if not already completed.** Remember, marking in this course is done on the basis of blog posts which appear on the planet.** You should have two blog posts on the planet by now: One with a link to your Seneca and Fedora user pages plus a snippet of IRC conversation, and one with a reflection on your experience compiling software from source code.* Rebuild an existing Fedora SRPM. The <code>-j</code> value in your ~/.rpmbuild config file controls how many simultaneous jobs <code>make</code> starts. Experiment to see which value results in the fastest build time for the software you have chosen on your particular hardware. Blog about your experience -- don't bog down your blog with technical output, but instead focus on the process and results, and your reflections = Week 4 (for example: did you get the value you expected? was it a fast or slow process? did you automate it with a script or do it manually? what seems to affect the results?).<!-- * Take the software you compiled last week and package it (not Nled!). Blog about the experience. Include a link to your source RPM (and optionally your binary RPMJanuary 31) from your blog. Do ''not'' use the Fedora spec file. '''Please complete this by Monday, January 20.''' -->* Listen to the [http://cdot.senecac.on.ca/audio/sbr600/ audio recording] of last Fall's conference call with Jesse Keating, Fedora Release Engineer* Start considering the projects on the [[SBR600 Potential Projects|potential projects]] list.Project Plan Presentations =

= Week 3 (January 24) - Using Mock and Koji = Tuesday ==

== rpmlint: Checking for a clean spec file, SRPM, ''Class is cancelled. Recover from FUDCon and RPM ==work on your project plan.''

<code>rpmlint</code> is a spec file, SRPM (.src.rpm), and RPM (.rpm) checker. To use it, supply the names of the file(s) to be checked as argument(s):  rpmlint ''foo.spec foo*.rpm'' Notice that the checks performed vary based on the input file. For example, some errors in the spec file (such as the summary ending in a period ".") could be determined from the spec file, but only show up when the SRPM/RPM is checked. Each run will report the number of errors and warnings; errors are serious problems which should not be ignored, while warnings may be ignored depending on the context. == mock: Testing BuildRequires Thursday == It's often difficult to get the BuildRequires in a spec file exactly right, because it's easy to overlook packages that are coincidentally installed on the machine. <code>mock</code> is a tool that uses the chroot system call to create a "cleanroom" environment for the build, so that any missing BuildRequires cause the build to fail. {{Admon/note|The '''mock''' Group|To use mock, you will need to add yourself to the '''mock''' group: <code>usermod -G mock ''yourUserName''</code>}}

To build with mock:  mock -r ''fedora-13-x86_64'' --rebuild ''foo*.src.rpm'' The value ''fedora-13-x86_64'' may be changed to any of the config files found in <code>/etc/mock</code> in order to test building based on the libraries and available packages for a specific architecture and Fedora release. If errors Project pages are reported, review the log files (see the mock output to determine the directory containing the log files)due. == koji: Testing multiple architectures == <code>koji</code> is a client-server system which allows you to queue builds within the Fedora build farm. This permits you to test whether your package builds on several different architectures, which is especially useful when you don't otherwise have access * Be prepared to the machines of that architecture. {{Admon/note|Koji Setup|Note that koji requires some setup, particularly for certificate-based authentication. See the [[:fedora:PackageMaintainers/UsingKoji|UsingKoji]] page on the Fedora wiki for setup instructions.}} To queue give a build for all four Fedora-supported architectures (currently i386, x86_64, ppc, and ppc64):  koji build ''dist-f12'' --scratch ''foo*.src.rpm'' In this example, ''dist-f12'' selects the package repository detailed but brief (similar to the <code>-r</code> option for mock, except that the build arch is not specified); <code>-3-scratch</code> specifies that this is a scratch build (the results are not kept or fed to Bodhi). To perform a build that will be passed to Bodhi for distribution, substitute <code>--rebuild</code> for <code>-5-scratch</code> (do not do this until you have passed the package review and sponsor proceduresminute presentation). {{Admon/note|ARM Build|You can queue an ARM build by specifying the server "arm.koji.fedoraproject.org" on the Koji command line (or in <code>/etc/koji.conf</code>).}} == Resources == * rpmlint** [[:fedora:Common Rpmlint issues]]* mock** [[:fedora:Projects/Mock|Mock Project page]]** [[:fedora:Using_Mock_to_test_package_builds]]* koji** [[:fedora:PackageMaintainers/UsingKoji|Using Koji]] == ToDo == * Test your RPM from last week with:** rpmlint** mock** koji * Blog about your experienceproject plan. = Week 4 (January 31) - Using Mock and Koji II =

# Add the e-mail address associated with your gpg key to the <code>%_gpg_name</code> macro in <code>~/.rpmmacros</code> -- the line will look like this: <code>%_gpg_name "<i>e-mail-address</i>"</code>

= Release Dates, Presentations, and Quizzes =* March 7 - '''Release 0.1'''* March 15/17 - Pre-0.2 presentations* March 24 - Written Quiz* April 4 - '''Release 0.2'''* April 5/7 - Pre-0.3 presentations* April 11/13 (To Be Confirmed) - OCE Presentations* April 14 - Practical Quiz* April 22 - '''Release 0.3''' - DO NOT BE LATE! <!-- = Week 8 =