3640
Comment:
|
7894
|
Deletions are marked like this. | Additions are marked like this. |
Line 1: | Line 1: |
= Outreach Program for Women (OPW) = | ## page was renamed from OPWIntro = Outreachy (formerly FOSS Outreach Program for Women (OPW) and Project Ascend Alumni) = Please see the [https://www.gnome.org/outreachy/ Outreachy homepage] for an introduction to the program. |
Line 3: | Line 5: |
Welcome OPW applicants! The Linux Foundation is sponsoring internships for women to work on the Linux kernel. The kernel is the most basic layer of the Linux operating system. The kernel encompasses many things: hardware drivers, filesystems, security, task scheduling, and much more. | The application period for '''Round 15''' will start on September 7, 2017. It's too early to send patches to the outreachy kernel mailing list, but please consider working through the other parts of the tutorial if you are interested in applying. |
Line 5: | Line 7: |
The official deadline for applying to OPW is May 1st. However, the kernel project joined late, so that deadline is flexible. Please fill our your [https://live.gnome.org/OutreachProgramForWomen#Application_Process initial application], and then update by May 17th with your initial patch. Applicants will be notified by May 27th if they have been accepted. | We are looking for round 15 [:OutreachySponsor:funding sponsors] and Linux kernel [:OutreachyMentor:mentors]. Please see the linked FAQ pages if you want to help out. |
Line 7: | Line 9: |
== Participating kernel projects == | Welcome Outreachy applicants! Our [:OutreachySponsor:round 15 sponsors] have generiously donated funds for internships for women, genderqueer, genderfluid, or genderfree people, and residents and nationals of the United States of any gender who are Black/African American, Hispanic/Latino, American Indian, Alaska Native, Native Hawaiian, or Pacific Islander to work on the Linux kernel. The kernel is the most basic layer of the Linux operating system. It encompasses many things: hardware drivers, filesystems, security, task scheduling, and much more. |
Line 9: | Line 11: |
Currently, we have three participating projects. | '''News''' This year, we ask that you send all patches to the appropriate staging driver maintainers, as well as to the outreachy mailing list. See [:FirstKernelPatch#submit+a+patch:Submit a patch] for more information. '''For IIO patches, be sure to send them to linux-iio@vger.kernel.org''' |
Line 11: | Line 13: |
=== USB === | = How to apply = The application period for Outreachy Round 15 is September 7 to October 23. Please fill your [https://live.gnome.org/OutreachProgramForWomen#Application_Process application] by '''October 23''', and complete your kernel patch by '''October 23''' also (7pm UTC in both cases). Applicants that do not complete the first patch will not be considered for an internship. Please take a look at our [:OutreachyApply:application FAQ] for more info on how to fill out your application. |
Line 13: | Line 16: |
The Linux kernel includes a USB stack that communicates with the hardware behind your USB ports (USB host controller drivers), and includes USB device drivers that talk to your USB devices (USB device drivers). | If you are interested in being a Linux kernel intern, please: |
Line 15: | Line 18: |
Interns would work on the USB 3.0 host controller driver. The Linux kernel USB 3.0 host driver was introduced in 2009, and works 10 times faster than USB 2.0 host driver. The USB 3.0 driver still needs a lot of work, so there are plenty of small bug fixes that interns can tackle. If time permits, interns could also work on small to medium features. USB 3.0 hardware will be provided to accepted interns if you don't have access to it. | * Join the [https://groups.google.com/forum/#!forum/outreachy-kernel outreachy-kernel mailing list] * Join the #outreachy IRC channel on irc.gnome.org * Join the #kernel-outreachy IRC channel on irc.oftc.net * Read our [:OutreachyApply:instructions for applying], and apply by October 23. * Use our [:Outreachyfirstpatch:tutorial] to send in your first kernel patch by October 23. |
Line 17: | Line 24: |
Necessary skills: Experience in C or C++ | = Participating Linux kernel projects = Applicants for all projects should have basic experience with C or C++ and boolean algebra. Optionally, we would love it if you have basic operating system knowledge, know your way around a Linux/UNIX command line, and/or know the revision system called git. ''Please note that these three skills can be learned during the internship.'' |
Line 19: | Line 27: |
Optional but learnable skills: Knowledge of operating systems, USB | Some projects may have small tasks you can complete as part of the application process. '''Do not''' start on these tasks until after you complete the [:Outreachyfirstpatch:first patch tutorial] and Greg Kroah-Hartman has accepted at least ten of your cleanup patches and two of your patchsets. In order to ensure applicants aren't working on the same task, we need your help in coordinating who is working on what task. Please see the [:OutreachyTasks:Outreachy tasks page] for details before starting on a task! |
Line 21: | Line 29: |
Mentor: Sarah Sharp, email sarah.a.sharp at intel.com, #opw IRC handle: sarahsharp, twitter @sarahsharp, google plus: https://plus.google.com/116960357493251979546/posts | = Round 15 projects = Previous projects, from round 14 projects are available [:OutreachyRound13:here]. For each project, if you click on the proposer's name, you may find more information. |
Line 23: | Line 32: |
Suggested reading for accepted interns: * [http://lwn.net/Kernel/LDD3/ Linux Device Drivers] * [http://www.beyondlogic.org/usbnutshell/usb1.shtml USB in a Nutshell] |
== Coccinelle == ''Mentor:'': [:JuliaLawall:Julia Lawall] |
Line 27: | Line 35: |
== Ethernet == | There will be no Coccinelle project in this round. Please feel free nevertheless to use Coccinelle in making cleanup patches. |
Line 29: | Line 37: |
The Linux kernel ethernet drivers communicate with network hardware, to give you access to the Internet. Ethernet devices can be as simple as the 1 gigabit ethernet controllers in your laptop, to much faster ethernet controllers in servers. | == Using an IDR to replace the process ID allocator == ''Mentor:'': [:MatthewWilcox:Matthew Wilcox] |
Line 31: | Line 40: |
Interns would work on the Intel 1 gigabit ethernet driver, igb. These devices are found in most Intel laptops, but hardware will be provided if you don't have access to it. | Process IDs are currently allocated using a custom allocator. This project would try to replace that allocator with the IDR. |
Line 33: | Line 42: |
Mentors: Carolyn Wyborny and Anjali Jain | == nftables == ''Mentor:'': [:pablo:Pablo Neira Ayuso] |
Line 35: | Line 45: |
== x86 core == | nftables provides a replacement for the very popular {ip,ip6,arp,eb}tables tools. nftables reuses most of the Netfilter components such as the existing hooks, connection tracking system, NAT, userspace queueing, logging among many other features. So we have only replaced the packet classification framework. nftables comes with a new userspace utility ''nft'' and the low-level userspace library ''libnftnl''. The goal will be to help finish the translation layer software that converts from the iptables syntax to nftables, complete some simple missing features and fixing bugs whenever possible. |
Line 37: | Line 47: |
In the heart of the Linux kernel is code that runs directly on x86 processors. This includes early boot code, etc. | If you are interested in this project please consider solving any of the following tasks: |
Line 39: | Line 49: |
Mentors: Peter Waskiewicz Jr (PJ) | * Request an account for the wiki.nftables.org page and help us improve the content. * Provide an iptables to nft translation via the iptables-translate utility. You can give a try to the following extensions: icmp, icmp6, rt. * Try to fix any of the existing nft bugs in bugzilla.netfilter.org. |
Line 41: | Line 53: |
For more information on nftables, please check: http://wiki.nftables.org | |
Line 42: | Line 55: |
= Getting Started = | == IIO driver == ''Mentors:'': [:DanielBaluta:Daniel Baluta] & [:AlisonSchofield:Alison Schofield] |
Line 44: | Line 58: |
TODO: * Intro, what the goals are, why they should be excited about developing for the kernel. :) * What skills are good to have (e.g. having taken an OS class is good), or how they can get those skills later on, like by reading Linux Device Drivers * Outline of what this tutorial covers * If you run into any issues, ask on the opw irc channel, or email sarah.a.sharp at linux.intel.com * Step 0: install Linux on a home computer (alternative instructions for installing in a VM would be good, but I have no background in that). * Build a custom kernel * Find out which drivers you have installed (maybe plug in any USB devices on hand) * Make small change in one of the drivers (e.g. run checkpatch over them, or fix some grammer in the printks) * Or maybe pick a driver in staging and run checkpatch on it * Test your patch (may need to enable debugging) * Make a patch (link to art of patch description creation) * Send patch to kernel newbies mailing list as RFC (perhaps we need a separate mailing list?) |
A driver allows applications to communicate and control hardware devices. Each development cycle, driver changes account for more than a half of the total Linux kernel code changes. The goal of this project is to write a driver for a sensor using the Industrial I/O interface. In the first part of the project you will get familiar with the hardware and the IIO subsystem then implement raw readings from the device. After upstreaming the code you will enhance the driver with advanced features such as support for buffered readings, power management and interrupts. The exact device will be decided when the internship starts. We will provide you the hardware setup necessary to test the driver. If you are interested in this project please solve ["IIO tasks"]. '''For IIO patches, be sure to send them to linux-iio@vger.kernel.org''' == Documentation == ''Mentor:'': [:JonathanCorbet:Jonathan Corbet] After many years of relative neglect, we are working to improve the kernel's documentation; this includes [https://lwn.net/Articles/692704/ a transition to the Sphinx formatting system.] There are a number of potential projects associated with this transition, ranging from the conversion of existing documents into the ReStructured Text format and integrating them into the manual through to improving the Python/Perl-based document build system, adding kerneldoc comments to the source, and writing entirely new documents. If you want to work in this area, there are a number of things that can be done for the application process, starting with simple typo fixes in the documentation tree. Converting simple text documents to RST is a relatively straightforward task, but contacting the mentor first is recommended, since some parts of the documentation tree are more amenable to this work in the short term than others. We would also love to see fixes for the large number of warnings that are currently emitted as part of the build process. == Project == ''Mentor:'': [:WikiName:Mentor names] Brief project description. = Yeah, that sounds cool! = If you are interested in being a Linux kernel intern, please: * Join the [https://groups.google.com/forum/#!forum/outreachy-kernel outreachy-kernel mailing list] * Join the #outreachy IRC channel on irc.gnome.org * Join the #kernel-outreachy IRC channel on irc.oftc.net * Read our [:OutreachyApply:instructions for applying], and apply by March 30. * Use our [:Outreachyfirstpatch:tutorial] to send in your first kernel patch by March 30. * After you have 10 cleanup patches and at least two patchsets, choose some [:OutreachyTasks:small tasks] to complete. |
Outreachy (formerly FOSS Outreach Program for Women (OPW) and Project Ascend Alumni)
Please see the [https://www.gnome.org/outreachy/ Outreachy homepage] for an introduction to the program.
The application period for Round 15 will start on September 7, 2017. It's too early to send patches to the outreachy kernel mailing list, but please consider working through the other parts of the tutorial if you are interested in applying.
We are looking for round 15 [:OutreachySponsor:funding sponsors] and Linux kernel [:OutreachyMentor:mentors]. Please see the linked FAQ pages if you want to help out.
Welcome Outreachy applicants! Our [:OutreachySponsor:round 15 sponsors] have generiously donated funds for internships for women, genderqueer, genderfluid, or genderfree people, and residents and nationals of the United States of any gender who are Black/African American, Hispanic/Latino, American Indian, Alaska Native, Native Hawaiian, or Pacific Islander to work on the Linux kernel. The kernel is the most basic layer of the Linux operating system. It encompasses many things: hardware drivers, filesystems, security, task scheduling, and much more.
News This year, we ask that you send all patches to the appropriate staging driver maintainers, as well as to the outreachy mailing list. See [:FirstKernelPatch#submit+a+patch:Submit a patch] for more information. For IIO patches, be sure to send them to linux-iio@vger.kernel.org
How to apply
The application period for Outreachy Round 15 is September 7 to October 23. Please fill your [https://live.gnome.org/OutreachProgramForWomen#Application_Process application] by October 23, and complete your kernel patch by October 23 also (7pm UTC in both cases). Applicants that do not complete the first patch will not be considered for an internship. Please take a look at our [:OutreachyApply:application FAQ] for more info on how to fill out your application.
If you are interested in being a Linux kernel intern, please:
Join the [https://groups.google.com/forum/#!forum/outreachy-kernel outreachy-kernel mailing list]
- Join the #outreachy IRC channel on irc.gnome.org
- Join the #kernel-outreachy IRC channel on irc.oftc.net
Read our [:OutreachyApply:instructions for applying], and apply by October 23.
Use our [:Outreachyfirstpatch:tutorial] to send in your first kernel patch by October 23.
Participating Linux kernel projects
Applicants for all projects should have basic experience with C or C++ and boolean algebra. Optionally, we would love it if you have basic operating system knowledge, know your way around a Linux/UNIX command line, and/or know the revision system called git. Please note that these three skills can be learned during the internship.
Some projects may have small tasks you can complete as part of the application process. Do not start on these tasks until after you complete the [:Outreachyfirstpatch:first patch tutorial] and Greg Kroah-Hartman has accepted at least ten of your cleanup patches and two of your patchsets. In order to ensure applicants aren't working on the same task, we need your help in coordinating who is working on what task. Please see the [:OutreachyTasks:Outreachy tasks page] for details before starting on a task!
Round 15 projects
Previous projects, from round 14 projects are available [:OutreachyRound13:here]. For each project, if you click on the proposer's name, you may find more information.
Coccinelle
Mentor:: [:JuliaLawall:Julia Lawall]
There will be no Coccinelle project in this round. Please feel free nevertheless to use Coccinelle in making cleanup patches.
Using an IDR to replace the process ID allocator
Mentor:: [:MatthewWilcox:Matthew Wilcox]
Process IDs are currently allocated using a custom allocator. This project would try to replace that allocator with the IDR.
nftables
Mentor:: [:pablo:Pablo Neira Ayuso]
nftables provides a replacement for the very popular {ip,ip6,arp,eb}tables tools. nftables reuses most of the Netfilter components such as the existing hooks, connection tracking system, NAT, userspace queueing, logging among many other features. So we have only replaced the packet classification framework. nftables comes with a new userspace utility nft and the low-level userspace library libnftnl. The goal will be to help finish the translation layer software that converts from the iptables syntax to nftables, complete some simple missing features and fixing bugs whenever possible.
If you are interested in this project please consider solving any of the following tasks:
- Request an account for the wiki.nftables.org page and help us improve the content.
- Provide an iptables to nft translation via the iptables-translate utility. You can give a try to the following extensions: icmp, icmp6, rt.
- Try to fix any of the existing nft bugs in bugzilla.netfilter.org.
For more information on nftables, please check: http://wiki.nftables.org
IIO driver
Mentors:: [:DanielBaluta:Daniel Baluta] & [:AlisonSchofield:Alison Schofield]
A driver allows applications to communicate and control hardware devices. Each development cycle, driver changes account for more than a half of the total Linux kernel code changes.
The goal of this project is to write a driver for a sensor using the Industrial I/O interface. In the first part of the project you will get familiar with the hardware and the IIO subsystem then implement raw readings from the device. After upstreaming the code you will enhance the driver with advanced features such as support for buffered readings, power management and interrupts. The exact device will be decided when the internship starts.
We will provide you the hardware setup necessary to test the driver. If you are interested in this project please solve ["IIO tasks"].
For IIO patches, be sure to send them to linux-iio@vger.kernel.org
Documentation
Mentor:: [:JonathanCorbet:Jonathan Corbet]
After many years of relative neglect, we are working to improve the kernel's documentation; this includes [https://lwn.net/Articles/692704/ a transition to the Sphinx formatting system.] There are a number of potential projects associated with this transition, ranging from the conversion of existing documents into the ReStructured Text format and integrating them into the manual through to improving the Python/Perl-based document build system, adding kerneldoc comments to the source, and writing entirely new documents.
If you want to work in this area, there are a number of things that can be done for the application process, starting with simple typo fixes in the documentation tree. Converting simple text documents to RST is a relatively straightforward task, but contacting the mentor first is recommended, since some parts of the documentation tree are more amenable to this work in the short term than others. We would also love to see fixes for the large number of warnings that are currently emitted as part of the build process.
Project
Mentor:: [:WikiName:Mentor names]
Brief project description.
Yeah, that sounds cool!
If you are interested in being a Linux kernel intern, please:
Join the [https://groups.google.com/forum/#!forum/outreachy-kernel outreachy-kernel mailing list]
- Join the #outreachy IRC channel on irc.gnome.org
- Join the #kernel-outreachy IRC channel on irc.oftc.net
Read our [:OutreachyApply:instructions for applying], and apply by March 30.
Use our [:Outreachyfirstpatch:tutorial] to send in your first kernel patch by March 30.
After you have 10 cleanup patches and at least two patchsets, choose some [:OutreachyTasks:small tasks] to complete.