|
Size: 10920
Comment:
|
Size: 8915
Comment: converted to 1.6 markup
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| = FOSS Outreach Program for Women (OPW) and Project Ascend Alumni = Please see the [https://wiki.gnome.org/OutreachProgramForWomen FOSS Outreach Program for Women homepage] for an introduction to the program. |
## 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 4: | Line 5: |
| We are looking for round 9 [:OPWSponsor:funding sponsors] and Linux kernel [:OPWMentor:mentors]. Please see the linked FAQ pages if you want to help out. | 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 6: | Line 7: |
| Welcome OPW applicants! Our [:OPWSponsor:round 9 sponsors] have generiously donated funds for internships for women, genderqueer, genderfluid, or genderfree people, and alumni from the [http://ascendproject.org/ Ascend Project] 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. | 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''' |
| Line 9: | Line 14: |
| The application period for OPW Round 9 is September 12 to October 31. Most OPW organizations have an application deadline of October 22, however, the Linux kernel application period will be put on temporary hold from October 10 to October 20. Most kernel mentors will be attending conferences (LinuxCon Europe, Linux Plumbers Conf, and Embedded Linux Conference Europe) during that time. During the hold period, no new kernel application patches will be accepted or reviewed, and mentors may not be available on the IRC channel. Therefore, it is important to start sending patches early in the application period. We suggest that you tackle a medium-sized advanced project during that week, rather than preparing to send many small clean up patches after the hold period is finished. Please fill our your [https://live.gnome.org/OutreachProgramForWomen#Application_Process initial application] by October 31, and complete your initial kernel patch by October 31. Applicants that do not complete the first patch will not be considered for an internship. Please take a look at our [:OPWApply:application FAQ] for more info on how to fill our your initial application. Applicants will be notified on November 12 if they have been accepted. |
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 15: | Line 18: |
| * Join the [https://groups.google.com/forum/#!forum/opw-kernel opw-kernel mailing list] * Join the #opw IRC channel on irc.gnome.org * Join the #kernel-opw IRC channel on irc.oftc.net * Read our [:OPWApply:instructions for applying], and apply by October 31. * Use our [:OPWfirstpatch:tutorial] to send in your first kernel patch by October 31. |
* 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 24: | Line 27: |
| 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 [:OPWfirstpatch: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 [:OPWTasks:OPW tasks page] for details before starting on a task! | 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 26: | Line 29: |
| = Round 9 projects = | = Round 15 projects = Previous projects, from round 14 projects are available [[OutreachyRound14|here]]. For each project, if you click on the proposer's name, you may find more information. |
| Line 28: | Line 32: |
| == Kernel tinification == | == dri-devel aka kernel GPU subsystem == |
| Line 30: | Line 34: |
| ''Mentor:'': [:JoshTriplett:Josh Triplett] | In laptops, tablets, phones and lots of other places GPU/display uses more silicon die space than everything else combined (humans are mostly visual people after all), dri-devel (and the wider set of projects under the X.org Foundation's umbrella) is the community that makes this all work and shine. |
| Line 32: | Line 36: |
| Over time, the Linux kernel has grown far more featureful, but it has also grown significantly larger, even with all the optional features turned off. I'd like to reverse that trend, making the kernel much smaller, to enable ridiculously small embedded applications and other fun uses. | We have a bunch of janitorial-type projects collected in [[https://dri.freedesktop.org/docs/drm/gpu/todo.html]], varying from fairly mechanical to really challenging. We're also taking the usual array of checkpatch and coccinelle driven cleanup patches (they're great newbie starter patches). For an internship this means there's a lot of "build your own internship program", and we're definitely open to other projects. Just chat with mentors to start scoping a good project and what might be interesting for you. |
| Line 34: | Line 38: |
| In this project, you'll start from "make allnoconfig", and then try to shrink the kernel even further. You'll learn how to work with the kernel configuration system, Kconfig, and use scripts/bloat-o-meter to measure the size impact of a change. | Bit more PR for dri-devel: We're the subsystem that implemented the new shiny kernel-doc tooling and pushed for the conversion [[https://dri.freedesktop.org/docs/drm/gpu/index.html]]. We're the first ever kernel subsystem with a real CoC (and yes it's enforced)[[https://dri.freedesktop.org/docs/drm/gpu/introduction.html#code-of-conduct]]. We're running our main trees with a much more participative model where all regular contributors have direct commit rights to relevant repos (instead of having to always jump through maintainers to get anything landed)[[http://blog.ffwll.ch/2016/09/commit-rights-in-the-linux-kernel.html]]. In short, we take newbie's and our contributor's needs in general very serious and try to care for them. |
| Line 36: | Line 40: |
| This is a highly incremental project: each feature you make optional or kernel component you shrink will mostly stand alone, and you can develop and submit each change independently. | Best place to say hi to the community is by joining #dri-devel on freenode. You need a registered nick: https://freenode.net/kb/answer/registration |
| Line 38: | Line 42: |
| Some of these tinification goals will work well during the application period; others will require a substantial time investment, and will primarily make sense during the full internship. | ''Mentors:'': [[Daniel_Vetter|Daniel Vetter]], [[SeanPaul|Sean Paul]] |
| Line 40: | Line 44: |
| Before working on any of these, especially during the application period, you should send a quick note to the OPW kernel mailing list to coordinate, and avoid duplicated effort. | == attribute documentation == ''Mentor:'': [[JuliaLawall|Julia Lawall]] |
| Line 42: | Line 47: |
| Please see https://tiny.wiki.kernel.org/ for more details on this effort. See https://tiny.wiki.kernel.org/projects for a list of possible projects. The projects listed as "small" can potentially be done during the application period, or by an intern accepted to work on this project. The projects listed as "large" should wait until the internship. | The Linux kernel has many configurable parameters, declared as eg DEVICE_ATTR_RO. These should be represented in the kernel documentation, but many are not. The goal of this project will be to develop tools, likely using [[http://coccinelle.lip6.fr/:Coccinelle]], to help collect information relevant to such documentation and to create an appropriate documentation skeleton, and then to work on filling in some such documentation, based on study of the code, comments, etc. Relevant tasks will appear on the page of the mentor. |
| Line 44: | Line 49: |
| (Note to mentors and prospective applicants: Josh plans to present the tinification effort and list of projects at Linux Kernel Summit, and may add, remove, or edit items on this list based on feedback obtained there.) | == nftables == ''Mentor:'': [[pablo|Pablo Neira Ayuso]] |
| Line 46: | Line 52: |
| == Coccinelle == | 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 48: | Line 54: |
| ''Mentor:'' [http://kernelnewbies.org/JuliaLawall Julia Lawall], [http://kernelnewbies.org/NicolasPalix Nicolas Palix] | If you are interested in this project then: |
| Line 50: | Line 56: |
| [http://coccinelle.lip6.fr Coccinelle] is a program matching and transformation tool for C code that has been used extensively in contributing to the Linux kernel, for both code evolutions and bug fixes. Coccinelle is driven by specifications, known as semantic patches, that use a notation based on C code, and are this fairly easy to develop. Around 40 semantic patches are included with the Linux kernel source code, in scripts/coccinelle, and are used in the continuous testing service provided by Intel. | * Install a fresh Linux kernel, from git sources, and latest git snapshots for libmnl, libnftnl and nftables. You can find more information on how to set up your enviroment at wiki.nftables.org. * Make sure you understand basic operational of nftables, read existing documentation. * Once you're fully set up, you got basic understanding of the tooling and everything is working on your side, then contact the mentor to request for an initial task. |
| Line 52: | Line 60: |
| Recently, we have used Coccinelle in an extensive study of [http://hal.archives-ouvertes.fr/docs/01/02/27/04/PDF/faults-in-linux-2.6-tocs.pdf faults in Linux 2.6]. The goal of this project is to extend the results to more recent versions of Linux, and to facilitate the extension of the work to subsequent versions. This will entail: | For more information on nftables, please check: http://wiki.nftables.org |
| Line 54: | Line 62: |
| 1. Running the Coccinelle scripts that have been developed to collect data. 1. Evaluating the resulting reports to identify real bugs and false positives. 1. Submitting patches to the Linux kernel to fix the identified real bugs that are still present in the kernel. 1. Updating a database with the results. 1. Creating graphs to summarize the results. |
== IIO driver == ''Mentors:'': [[DanielBaluta|Daniel Baluta]] & [[AlisonSchofield|Alison Schofield]] |
| Line 60: | Line 65: |
| == Surviving Year 2038 == | 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. |
| Line 62: | Line 67: |
| ''Mentor'': Arnd Bergmann | 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. |
| Line 64: | Line 69: |
| The concept of 'time' in Linux is encoded in many different ways, but the most common one is based on the 'time_t' type that counts the number of seconds that have passed since Jan 1, 1970. This type is currently defined as 'long', which on 32-bit systems is a signed 32-bit number that will overflow on Jan 19 2038 and likely cause existing systems to stop working, see [http://en.wikipedia.org/wiki/Year_2038_problem]. |
We will provide you the hardware setup necessary to test the driver. If you are interested in this project please solve [[IIO_tasks]]. |
| Line 71: | Line 71: |
| On 64-bit systems, the problem is solved for the most part because 'long' is a 64-bit number that will not overflow for billions of years, but there are some important missing pieces such as file systems that store time in 32-bit quantities on disk as well support for 32-bit user space binaries running on 64-bit kernels. |
'''For IIO patches, be sure to send them to linux-iio@vger.kernel.org''' |
| Line 77: | Line 73: |
| Solving this problem in general is a huge effort involving lots of changes in the kernel as well as in user space. This project focuses on the kernel side, can be nicely split up into many small subtasks and is a prerequisite for doing the user space changes. There are currently 2117 instances of 'time_t', 'struct timespec' and 'struct timeval' in the kernel, and we are going to replace all of them with other types. |
== Project == ''Mentor:'': [[WikiName|Mentor names]] |
| Line 84: | Line 76: |
| Any isolated in-kernel uses of these types can be replaced with 'ktime_t' or 'struct timespec64'. For any interface to user space (typically an ioctl command or a system call) that passes a data structure based on these types, we have to keep the existing interface working and introduce an alternative interface that can be used by newly built user space programs. ["y2038"] has a deeper introduction to the topic and will be updated with more detailed subtasks over time. == IIO staging drivers cleanup == ''Mentors:'' [http://kernelnewbies.org/OctavianPurdila Octavian Purdila], [http://kernelnewbies.org/DanielBaluta Daniel Baluta] The [http://free-electrons.com/pub/conferences/2012/fosdem/iio-a-new-subsystem/iio-a-new-subsystem.pdf Industrial I/O subsystem] is intended to provide support for devices that in some sense are analog to digital or digital to analog converters. Some devices that fall in this category are: accelerometers, gyroscopes, light sensors, etc. This project will involve cleaning and moving IIO drivers out from staging. Most of the work will change drivers to use proper IIO ABI and adapt the code to follow the Linux Kernel coding style. We plan to start the with driver for Intersil ISL29018 digital ambient light and proximity sensor. Follow ["IIO cleanup"] page for small tasks and updates. == Khugepaged swap readahead == ''Mentor:'' RikvanRiel Linux can transparently use huge pages (THP) for anonymous memory on x86 and several other architectures. These huge pages allow programs to run faster, due to reduced TLB pressure, and lower administrative overhead. The huge pages are formed either directly at allocation time, or by collapsing several (512 on x86) small pages together into one huge page. When the system is low on memory, huge pages are broken into small pages, which then get swapped out. However, after the memory pressure is over, and most of the small pages have been swapped back in, there usually are a few small pages left on swap, and the huge page cannot be reconstituted. In other words, a one-time swap event can cause permanent performance degradation. The project consists of teaching khugepaged to slowly fetch pages from swap, when most of the pages of a region that could form a huge page are resident in memory, a few pages are in swap, and there is plenty of memory to form huge pages. This project involves a lot of reading of memory management code, and a smaller amount of code writing. Part of the project will involve documenting how some of the existing code works. |
Brief project description. |
| Line 126: | Line 81: |
| * Join the [https://groups.google.com/forum/#!forum/opw-kernel opw-kernel mailing list] * Join the #opw IRC channel on irc.gnome.org * Join the #kernel-opw IRC channel on irc.oftc.net * Read our [:OPWApply:instructions for applying], and apply by October 31. * Use our [:OPWfirstpatch:tutorial] to send in your first kernel patch by October 31. * After you have sent several cleanup patches and at least one patchset, choose a [:OPWTasks:small task] to complete. |
* 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 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 funding sponsors and Linux kernel mentors. Please see the linked FAQ pages if you want to help out.
Welcome Outreachy applicants! Our 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 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 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 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 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 instructions for applying, and apply by October 23.
Use our 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 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 Outreachy tasks page for details before starting on a task!
Round 15 projects
Previous projects, from round 14 projects are available here. For each project, if you click on the proposer's name, you may find more information.
dri-devel aka kernel GPU subsystem
In laptops, tablets, phones and lots of other places GPU/display uses more silicon die space than everything else combined (humans are mostly visual people after all), dri-devel (and the wider set of projects under the X.org Foundation's umbrella) is the community that makes this all work and shine.
We have a bunch of janitorial-type projects collected in https://dri.freedesktop.org/docs/drm/gpu/todo.html, varying from fairly mechanical to really challenging. We're also taking the usual array of checkpatch and coccinelle driven cleanup patches (they're great newbie starter patches). For an internship this means there's a lot of "build your own internship program", and we're definitely open to other projects. Just chat with mentors to start scoping a good project and what might be interesting for you.
Bit more PR for dri-devel: We're the subsystem that implemented the new shiny kernel-doc tooling and pushed for the conversion https://dri.freedesktop.org/docs/drm/gpu/index.html. We're the first ever kernel subsystem with a real CoC (and yes it's enforced)https://dri.freedesktop.org/docs/drm/gpu/introduction.html#code-of-conduct. We're running our main trees with a much more participative model where all regular contributors have direct commit rights to relevant repos (instead of having to always jump through maintainers to get anything landed)http://blog.ffwll.ch/2016/09/commit-rights-in-the-linux-kernel.html. In short, we take newbie's and our contributor's needs in general very serious and try to care for them.
Best place to say hi to the community is by joining #dri-devel on freenode. You need a registered nick: https://freenode.net/kb/answer/registration
Mentors:: Daniel Vetter, Sean Paul
attribute documentation
Mentor:: Julia Lawall
The Linux kernel has many configurable parameters, declared as eg DEVICE_ATTR_RO. These should be represented in the kernel documentation, but many are not. The goal of this project will be to develop tools, likely using http://coccinelle.lip6.fr/:Coccinelle, to help collect information relevant to such documentation and to create an appropriate documentation skeleton, and then to work on filling in some such documentation, based on study of the code, comments, etc. Relevant tasks will appear on the page of the mentor.
nftables
Mentor:: 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 then:
- Install a fresh Linux kernel, from git sources, and latest git snapshots for libmnl, libnftnl and nftables. You can find more information on how to set up your enviroment at wiki.nftables.org.
- Make sure you understand basic operational of nftables, read existing documentation.
- Once you're fully set up, you got basic understanding of the tooling and everything is working on your side, then contact the mentor to request for an initial task.
For more information on nftables, please check: http://wiki.nftables.org
IIO driver
Mentors:: Daniel Baluta & 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
Project
Mentor:: Mentor names
Brief project description.
Yeah, that sounds cool!
If you are interested in being a Linux kernel intern, please:
Join the 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 instructions for applying, and apply by March 30.
Use our tutorial to send in your first kernel patch by March 30.
After you have 10 cleanup patches and at least two patchsets, choose some small tasks to complete.