Open main menu

CDOT Wiki β

Changes

Winter 2011 SBR600 Weekly Schedule

3,937 bytes removed, 10:39, 12 April 2011
→‎Release Dates, Presentations, and Quizzes
{{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.}}
Previous semester: [[Fall 2010 SBR600 Weekly Schedule]]
= Week 1 (Jan 10) - Introduction , Building from Source, and Creating RPM Packages =
== Tuesday ==
=== Welcome ===* WelcomeAbout this course
* Introductions
* === 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]]
* Introduction to Free Software and Open Source
** The [http://fsf.org Free Software Foundation]
** Working with Open Source
** Working with the Fedora Project
* <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
=== To Do ===
 
'''By Wednesday, January 12:'''
# [[SBR600 Communication Lab|Communication Lab]]# [[SBR600 Fedora Installation|Fedora Installation]]# [[SBR600 Build-from-Source Lab|Build-from-Source Lab]]
== Thursday ==
* Make
* Makefile Basics
** Targets, Dependencies, and Commands
** Implied rules (e.g., .o files)
** Examples
* Building software from a source tarball using a makefile
 
== Readings/Resources''' ==
* Two simple [http://matrix.senecac.on.ca/~chris.tyler/osd600/makefile-examples.tgz makefile examples]
=== Using ''make'' ===
 #'''Communication Lab'''#* Set up your accounts (wiki, IRC, FAS2).'''#* Create a blog post which will appear on the OpenSource@Seneca Planet which introduces yourself. Include:#*# An introduction. Tell us a bit about yourself.#*# A portion of an IRC conversation you've had with someone on a Fedora or Seneca IRC channel.#*# A link to your User page on the Seneca wikis#*# A link to your User page on the Fedora wiki#** Note: don't just dump this stuff in a blog post, add some introductory text as well!#* Add an entry to the [[Fall 2010 SBR600 Participantsmake and Makefiles|make and Makefiles]] page#'''Fedora Set-Up'''#* Ensure you have a working, currently-supported (F12 or F13) Fedora system (on a laptop, on a SATA disk pack for use in the Seneca labs, or on a desktop machine at home) '''Lab 1: By Monday, September 13:'''# '''Lab 1'''#* Build 2 packages from Source#*# The NLED editor from [http://cdot.senecac.on.ca http://cdot.senecac.on.ca]#*# Any package that uses a configure script -- SourceForge might be a good place to look for such packages.#* Blog about the experience. = Week 2 (January 17) - RPM Packages I = == Tuesday ==* Discussion of issues related to building** Finding dependencies.** <code>-j''X''</code> flag to enable multiple jobs
=== RPM Packages ===
* Differences between managing RPMS and Installing from Source
** RPMS provide a database of installed software
*** Let you determine what's installed
*** Automatic management of dependencies
*** Identify the origin of files
*** Permit easy update or removal
*** Enable you to verify installation (useful for spotting file corruption and intrusions)
* [[RPM Package Contents|Contents of an RPM Package]]
* Purpose* What's in an === The 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*** TriggersDatabase ===
=== The * [[RPM Database ===Queries|Querying the RPM database]]
* Purpose === Layout of the database* Querying the RPM database** rpm -qa specfile ===
== Thursday ==* [[Contents of an RPM spec file]]
=== Creating Packages ===
* [[RPM 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 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 === * 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.Process]]
=== Layout of Demo: Creating a specfile Simple Package ===
* 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
 
=== Creating a Simple Package ===
 
* NLED
* Writing the specfile
* Testing the specfile
** Using rpmlint
=== Resources ===
* Two simple [http://matrix.senecac.on.ca/~chris.tyler/osd600/makefile-examples.tgz makefile examples]
* [[:fedora:PackageMaintainers|Fedora Package Maintainers page]]
** [[:fedora:PackageMaintainers/CreatingPackageHowTo|Packaging How-To]]
* ''Fedora Linux'' chapter 5 (see Seneca Library website > eBooks > View All > Safari > Fedora Linux).
* rpmlint
** [[:fedora:Common Rpmlint issues|Fedora Common Rpmlint issues]]
See also "Fedora Linux" chapter 5 (see Seneca Library website > eBooks > View All > Safari > Fedora Linux). == ToDo = To Do ===
* 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 (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 RPM) from your blog. Do ''not'' use the Fedora spec file. By '''Please complete this by Monday, January 20.17''' :# [[SBR600 RPM-Writing Lab|RPM->Writing Lab]]* Listen # Send your [[SSH]] public key to the [http[User://cdot.senecac.on.ca/audio/sbr600/ audio recordingChris Tyler|your professor]] of last Fall's conference call with Jesse Keating, Fedora Release Engineer* Start considering the projects so he can create accounts for you on the [[SBR600 Potential Projects|potential projectsCDOT Development Systems]] list.
= Week 3 2 (January 2417) - Using Mock and Koji =
== rpmlint: Checking for a clean spec file, SRPM, and RPM Tuesday ==
<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):=== Project Selection ===
rpmlint This is a project-based course. These projects involve participation in an open-source community.* Projects are listed on the [[SBR600 Potential Projects]] page.* Select two or three projects that are of interest to you.** Do some initial research into what the project involves.*** Find out who to talk to in the community (start with the initial contacts listed on the project description)*** See what work has already been done related to that project. Check the Seneca wiki for work by previous SBR600 semesters, the upstream project''foos 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).*** Join the mailing lists and IRC channels of the upstream community.** Update the [[Winter 2011 SBR600 Participants]] table with your project information, according to the instructions at the top of that page.* [[User:Chris Tyler|Your professor]] will approve your project selection via the [[Winter 2011 SBR600 Participants||participants page]].spec foo*Link your project title on the [[Winter 2011 SBR600 Participants|participants page]] to a page of the same name to create a project page. Copy the contents of the [[Sample Project]] page to your project page and fill in the details.rpm''
Notice that Over the checks performed vary based next 2 weeks, finalize your project plans and get started on the input fileyour project:* The project page must be filled in, including your 0.1, 0. For example2, some errors in the spec file and 0.3 targets.** Release 0.1: Proof of concept (such as the summary ending in e.g., a first draft of a package, a basic script, infrastructure set up on a period "."test system) could be determined from - Note that this must include the spec filerelease of ''something'', but only show up when not just research, and must be done in consultation with the SRPM/RPM is checkedcommunity.** Release 0. Each run will report the number of errors and warnings; errors 2: Initial working state - Whatever you are serious problems which working on -- package, script, infrastructure configuration -- should be working, although it may not be ignoredfeature-complete, fully deployed, or fully documented. Feedback from the community should be solicited. If there is a review process required to submit upstream, while warnings may it should be ignored depending 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 the context'''Thursday, February 3'''.
== mock: Testing BuildRequires = ToDo ===
It* Finish [[SBR600 RPM-Writing Lab|building your two RPMs]] before Thursday's often difficult to get the BuildRequires class (we'll use them 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 lab)* Send your [[SSH]] key to create a "cleanroom" environment [[User:Chris Tyler|your prof]] by Wednesday (will be needed for Thursday's lab)* Review the build, so that any missing BuildRequires cause [[SBR600 Potential Projects]] and start researching the build to failtop 2-3 possibilities.
{{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:== Thursday ==
=== mock -r ''fedora-13-x86_64'' --rebuild ''foo*.src.rpm'': Testing BuildRequires ===
The value It's often difficult to get the BuildRequires in a spec file exactly right, because it'fedora-13-x86_64s easy to overlook packages that are coincidentally installed on the machine. ''Mock'' may be changed to any of the config files found in <code>/etc/mock</code> in order is used to test building based on that the libraries and available packages BuildRequires for a specific architecture package are complete and Fedora releaseaccurate, by creating a bare-bones [http://en.wikipedia. If errors are reported, review org/wiki/Chroot chroot] environment containing only the log files (see the mock output to determine the directory containing [[:fedora:Packaging/Guidelines#Exceptions_2|basic build packages]] plus any packages indicated by BuildRequires lines in the log files)spec file.
=== 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 to the machines of that architecture.
{{Admon=== Resources ===* mock** [[:fedora:Projects/noteMock|Koji SetupMock Project page]]** [[:fedora:Using_Mock_to_test_package_builds|Note that Using Mock to test package builds]]* koji requires some setup, particularly for certificate-based authentication. See the ** [[:fedora:PackageMaintainers/UsingKoji|UsingKojiUsing Koji]] page on the Fedora wiki for setup instructions.}}
To queue a build for all four Fedora-supported architectures (currently i386, x86_64, ppc, and ppc64):=== ToDo ===
koji build ''dist-f12'' --scratch ''foo*.src.rpm''[[SBR600 Mock and Koji Lab|Mock and Koji Lab]]
In this example, ''dist-f12'' selects the package repository = Week 3 (similar to the <code>-r</code> option for mock, except that the build arch is not specifiedJanuary 24); <code>--scratch</code> specifies that this is a scratch build (the results are not kept or fed to Bodhi).Solving Build Issues =
To perform a build that will be passed to Bodhi for distribution, substitute <code>--rebuild</code> for <code>--scratch</code> = Week 4 (do not do this until you have passed the package review and sponsor proceduresJanuary 31).- Project Plan Presentations =
{{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>).}}== Tuesday ==
== Resources ==''Class is cancelled. Recover from FUDCon and work on your project plan.''
* 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]]== Thursday ==
== ToDo == * Test your RPM from last week with:Project pages are due.** rpmlint** mock** koji * Blog about Be prepared to give a detailed but brief (3- to 5-minute presentation) on your experienceproject plan. = Week 4 (January 31) - Using Mock and Koji II =
= Week 5 (February 7) - Repositories/Distributing =
# Create a GPG key: <code>gpg --gen-key</code>
# 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>
# Find (or make) some packages to put in your repository. Make sure that the epoch-version-release is higher than that of any package with the same name in the Fedora repositories.
# Sign those packages with: <code>rpm --addsign <i>packagefile</i></code>
== ToDo ==
 
Project
# Make sure your entry in the [[Fall 2010 SBR600 Project Table]] is complete, and that your project plan on your project page is filled in (including 0.1, 0.2, and 0.3 targets).
Lab
* Project work
= 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 =
* Git
** See http://git-scm.org for basic notes and tutorials
git pull origin $SomeoneElsesBranch
git checkout $SomeoneElsesBranch
-->
= Exam Week =
Retrieved from "https://wiki.cdot.senecapolytechnic.ca/wiki/Special:MobileDiff/54046...62401"