Annotation of wikisrc/projects/code-in.mdwn, revision 1.59
1.43 jdf 1: **Contents**
1.1 asau 2:
1.45 jdf 3: [[!toc]]
1.42 jdf 4:
1.45 jdf 5: # Google Code-In (GCI)
1.43 jdf 6:
1.45 jdf 7: Google Code-In is a project like Google Summer Of Code. But this time, there are
8: not university students, but 13-18 years old people the targeted audience.
9: Previous Code-In organisations:
10: * [Code-In 2010](http://www.google-melange.com/gci/accepted_orgs/google/gci2010)
11: * [Code-In 2011](http://www.google-melange.com/gci/accepted_orgs/google/gci2011)
12: * [Code-In 2012](http://www.google-melange.com/gci/accepted_orgs/google/gci2011)
14: Code-In differs from Summer Of Code also in not having a single task for one
15: student, but creating a large number of tasks and then having the students pick
16: the ones they want to work on. Thus, it is not suited for large projects, but
17: for small tasks like writing howtos, fixing bugs.
19: All the tasks should be completable within hours or up to three days. To get an
20: idea of how much a single task should be and what kind of they could be, look
21: at [this page](http://code.google.com/p/google-code-in/wiki/GCIExampleTasks).
22: There is [information from Google]
23: (http://code.google.com/p/google-code-in/wiki/GCIMentorInformation2012) about
24: what is suitable as a task for Code-In.
26: **NetBSD participated in Code-In 2012.** You can find the results
27: [[here|code-in_2012]]. The status of integrating Code-In's work to NetBSD can
28: also be read there.
1.25 mbalmer 29:
1.45 jdf 30: ## Goals as stated by Google
31: 1. **Code**: Tasks related to writing or refactoring code
32: 1. **Documentation/Training**: Tasks related to creating/editing documents and
33: helping others learn more
34: 1. **Outreach/Research**: Tasks related to community management,
35: outreach/marketing, or studying problems and recommending solutions
36: 1. **Quality Assurance**: Tasks related to testing and ensuring code is of high
38: 1. **User Interface**: Tasks related to user experience research or user
39: interface design and interaction
1.41 jdf 40:
1.45 jdf 41: ## Tasks
1.41 jdf 42:
1.45 jdf 43: There were some tasks left, and there might be more ideas over the following
44: year to participate in Code-In 2013 again.
1.28 jdf 45:
1.33 jdf 46: ## Used tags
1.29 jdf 47: If you want to search for a tag, just search this site for "Tag: $TAGNAME".
48: Used tags are (categories are not tagged):
1.31 jdf 49:
1.45 jdf 50: * *man* - tasks related to writing on or working with manpages
51: * *network* - tasks related to networking (including firewalls)
52: * *system* - tasks related to the system itself, either kernel or system level
54: * *service* - tasks involving services running on the system (as compared to
56: * *overview* - tasks related to getting and documenting an overview
57: * *howto* - tasks involving the creation of a howto
58: * *comparison* - tasks involving the comparison of different solutions
59: * *research* - tasks involving active research by the student
60: * *ui* - tasks involving the user interface (mostly graphical)
61: * *graphics* - tasks related to creating graphics
1.29 jdf 62:
1.45 jdf 63: ## Tasks
1.29 jdf 64:
1.45 jdf 65: ### Code
1.34 jdf 66:
1.55 wiki 67: * **Task: Serve HTML man pages using NetBSD's "bozohttpd" server**
68: NetBSD installs man pages in different formats, one of them being html pages. The goal of this task is to write a Lua script for
69: the "bozohttpd" web server, i.e. NetBSD's integrated webserver, that displays a webform where a man page section and the
70: name of a man page can be entered (see [[!template id=man name="httpd" section="8"]]).
71: When the form is submitted, the Lua script will do a lookup if there is a corresponding
1.58 asau 72: man page in html form and deliver to the web-browser. Contact mbalmer@ if you have questions.
73: *Prerequisites*: Lua, HTML.
74: *Tag*: man
75: *Tag*: service
1.55 wiki 76: *Tag*: ui
1.45 jdf 78: * **Task: Create ATF tests**: [[atf]] is the automatic test framework for NetBSD. We strive to have automatic tests for all the important parts of our system: libraries, syscalls, binaries, etc.
79: Your task is to write such tests. You should read the [[tutorial|atf]] about how to write an atf test, and then you can start testing things.
80: As testing is an endless task, here are just a few ideas about which items could be tested:
81: * [[!template id=man name="atomic_ops" section="3"]]
82: * [[!template id=man name="cdbr" section="3"]] and [[!template id=man name="cdbw" section="3"]]
83: * [[!template id=man name="inet" section="3"]] and [[!template id=man name="inet_net" section="3"]]
84: * [[!template id=man name="ethers" section="3"]], [[!template id=man name="iso_addr" section="3"]] and [[!template id=man name="link_addr" section="3"]]
85: * [[!template id=man name="strtol" section="3"]], [[!template id=man name="strtoul" section="3"]] and [[!template id=man name="strtoull" section="3"]]
86: * [[!template id=man name="uuid" section="3"]]
1.28 jdf 87:
1.45 jdf 88: Though this task is originally rather considered quality assurance, the actual test writing is only coding work (whether the test succeeds or not, is up to the original author of the library or tool).
89: Every *single written test* is considered as **one task**. If you think there is another test that should be added, but is not listed here, feel free to contact us.
90: The tests should be written in either C or sh, depending on the test subject.
91: *Prerequisites*: sh or C
1.29 jdf 92: *Tag*: man
93: *Tag*: research
1.59 ! asau 95: * **Task: create a pkgsrc package**: choose one software package from the [categorized list](http://ftp.netbsd.org/pub/NetBSD/misc/asau/tasks), create pkgsrc package.
! 96: Your task is to create a package, check that it runs, and describe how to do a [smoke test](http://en.wikipedia.org/wiki/Smoke_testing).
! 97: For each software package there are three formal tasks of different complexity (unless noted):
! 98: * make draft package that passes configure phase (medium complexity);
! 99: * make draft package that passes build phase (medium complexity);
! 100: * complete package that passes packaging checks and creates binary package (easy).
1.29 jdf 102: ### Outreach/Research
1.28 jdf 103:
1.29 jdf 104: * **Task: Compare NetBSD with other operating systems of its kind**: NetBSD is an operating system which targets people who like the cleanness of a system, and mostly already have Unix or Linux experience.
105: As such, there are other operating systems which fall into the same audience as NetBSD does, which are at least Slackware, Arch Linux, Gentoo, OpenBSD, FreeBSD, DragonFly.
106: This task is about researching what other distros are out there which are close to NetBSD's principles and use cases (distrowatch.org might be a good starting point), and how they are different.
107: After having collected facts, maybe a simple overview of the community (what kind of people are there, what do they want?), you should create an article which lists all those and describes their differences to NetBSD.
1.28 jdf 108: You could also try interviewing some people what their view of the communities and the operating systems is and try to evolve your own opinion about them all.
1.29 jdf 109: *Tag*: comparison
110: *Tag*: research
111: *Tag*: system
112: *Tag*: overview
114: * **Task: Compare firewall solutions in NetBSD**: NetBSD has several firewall solutions on board: ipf, npf, pf, even more (you should research that).
115: For the beginner, it is not clear what they are capable of, how fast they are and what their syntaxes look like.
116: In this task you should research the differences of these firewalls, create some examples that do the same (so you can view them side-by-side) and provide links to further documentation.
117: *Tag*: comparison
1.30 jdf 118: *Tag*: network
1.29 jdf 119: *Tag*: research
1.2 asau 120:
1.46 wiki 121: * **Task: Survey documentation structure of other projects**: There are many open source projects which exist not only for years, but also for decades (which e.g. NetBSD also has with 20 years). For all of them, documentation is an important issue, and most, if not all projects have not mastered writing documentation.
122: In this task, you have to choose one of the projects listed below. If you want to research another project not listed, please ask a judge about it.
123: Then, you have to research the documentation of these projects (what sources are there, how are they used, which software do they use, which formatting language, etc. (what sources are there, how are they used, which software do they use, which formatting language, etc.), plus finding a way of determining the project's opinion of their documentation (a docs@ mailing list might be a good start, like e.g. NetBSD-docs@NetBSD.org is). All in all, you should do nearly the same as the task "Create an overview of NetBSD documentation", except that you don't have to be that much in depth, but you should also research the technical and administrative background.
1.36 jdf 124: In the end, you should write a paper with the results of the survey and a small text, at least one page at all.
125: This task can be fulfilled multiple times, once for each project.
1.45 jdf 126: *Projects*: FreeBSD, OpenBSD, DragonFly, Gentoo, Slackware, PostgreSQL
1.36 jdf 127: *Tag*: research
128: *Tag*: comparison
129: *Tag*: overview
131: * **Task: Analyze and document (pseudo-)random number generators**: For several purposes like key creation, initial vectors for some protocols, IP sequence numbers, an operating system is required to have a (pseudo) random number generator ((p)rng).
132: Though some are implemented in hardware and the OS gives you the chance to interface them, you most probably just call the function random(3) or open the device /dev/urandom or /dev/random, which is either in hardware or software, depending on what the operating system uses.
133: While the hardware rngs use some random noise as a source for entropy ("randomness"), software rngs use several sources like disk command execution times, network timing, mouse and keyboard usage, depending on the implementation.
134: Your task is to look at the prngs of the great Open Source operating systems, analyze how they work, what input they use, how large their pools are and what exactly is done when input or output occurs.
135: This task is once for each operating system which has a different rng (some operating systems share the same ones), but you should analyze the input sources for all OSes using that rng and do the analysis for NetBSD first.
136: You should write down your result in a paper at least two pages long.
137: While this task might take up more work than a usual task, it is a very interesting and demanding task especially if you are interested in mathematics or cryptography.
138: *Tag*: research
139: *Tag*: comparison
1.54 khorben 141: * **Task: Illustrate how to use the framebuffer**: NetBSD features a generic framebuffer framework, called wsfb(4). It is already supported by Xorg by the xf86-video-wsfb driver, but it would be nice to investigate other useful ways to use it from userland. This task should illustrate exactly this, explaining and demonstrating how to write pictures on the framebuffer for instance.
142: Note that there is a generic framebuffer implementation for the i386, amd64 and macppc architectures, through the genfb(4) driver; it is known to work on the first two cases with qemu. Some help about how to enable it can be found in boot(8) (see the "vesa" command). Also, some fixes and improvements to the relevant drivers may only be found in NetBSD-current at the moment.
143: *Prerequisites*: C (basic)
144: *Tag*: research
145: *Tag*: howto
146: *Tag*: system
1.45 jdf 148: ### Quality Assurance
1.21 asau 149:
1.46 wiki 150: * **Task: Research POSIX compliance**: POSIX is the (more or less) standard all Unixes orient on. It describes libraries to use as well as binaries every Unix should have (like cp, mv) and their behavior.
151: You can find the standard on the Internet. Your task is to look for any non-trivial man page (i.e., more than a few options) and research whether the NetBSD behavior of this tool or library conforms to POSIX or not.
1.45 jdf 152: You should then insert this part into a list and document whether it complies to POSIX and if not, which differences are there.
1.46 wiki 153: As it is hard to determine the difficulty of a single part of the standard, this will be measured in lines. For every 1000 lines of the NetBSD versions of the man pages, this is one task.
1.45 jdf 154: The prerequisite is only for looking at libraries.
155: *Prerequisite*: C (reading)
156: *Tag*: research
158: * **Task: Howto: Configure npf**: The new NetBSD packet filter npf is a nice and well-scaling way to configure a firewall. Despite being there and functional, it does not have much documentation.
1.46 wiki 159: The manpage of npf.conf(5) gives an introduction, but nothing that could be used as a howto: [npf.conf(5)](http://netbsd.gw.com/cgi-bin/man-cgi?npf.conf+5+NetBSD-current). Also refer to the examples in /usr/share/examples/npf.
160: The howto should contain a step-by-step introduction about how npf works, but also an introduction to the technical aspects of npf itself: What kind of rules and tables are there, how they are applied, etc.
1.45 jdf 161: There is already a [howto by rmind](http://www.netbsd.org/~rmind/pub/npf_manual_netbsd_6.pdf), this would have to be converted and checked against errors, and extended.
162: *Tag*: howto
163: *Tag*: network
1.21 asau 164:
1.29 jdf 165: * **Task: Document integrated tools in NetBSD**: Apart from the famous web server and ftp server choices, there are smaller ones already integrated to NetBSD, as well as other smaller tools a user should know.
166: The goal is to create a comprehensive (!) list of full software packages that are already included in the base distribution.
167: In the document src/doc/3RDPARTY there is already a list of imported software, but there are more tools which are NetBSD-inherent themselves or contained in a larger package that is just listed as a whole there.
168: *Tag*: overview
169: *Tag*: research
1.21 asau 170:
1.29 jdf 171: * **Task: Try out various desktop scenarios, report errors**: Modern desktop environments like Xfce, KDE, Gnome or LXDE are mostly written for Linux. As such, it is important to try them on NetBSD and report their errors. Plus, checking the ease of installation via pkgsrc - which packages have to be installed, how intuitive is their name, their installation? Everything should be as easy as possible.
172: This task also refers to the task of creating a tutorial - maybe doing this first, and then creating the tutorial would be nice. The tutorial could either be updated on the fly when the reported bugs are corrected, or will be held back until the process is as easy as it should be.
173: This also includes bug-checking for light-deskop, the preferred package for a NetBSD desktop.
174: *Tag*: ui
175: *Tag*: research
1.40 khorben 177: * **Task: Document the installation of the DeforaOS desktop environment**: The DeforaOS desktop is an alternative for a lightweight desktop environment, and is already packaged in NetBSD (via pkgsrc-wip, as the wip/deforaos-desktop meta package). It could use more documentation though, including how to configure it properly.
178: Bug reports will also be welcome of course, even more so with fixes.
179: *Tag*: ui
180: *Tag*: research
1.29 jdf 182: * **Task: Make NetBSD a music or video player**: NetBSD could as well serve as a music (mpd) or video player. You have to research which packages are needed for such a use case, and document it in a tutorial.
183: Ideally, create a pkgsrc meta package including all the dependencies.
184: Report bugs you find on the way.
1.30 jdf 185: *Tag*: ui
1.29 jdf 186: *Tag*: research
189: * **Task: Describe how NetBSD boots**: Build NetBSD on any system (especially non-NetBSD) and try to create a bootable medium without using makefs(8) or integrated wrappers.
190: Creating a bootable disk is possible, but difficult and there is no comprehensive information about this. You have to try much until you get the real results.
191: The affected tools are
192: * fdisk(8)
193: * installboot(8)
194: * disklabel(8)
195: * gpt(8)
1.31 jdf 196:
1.29 jdf 197: In the end of this task, a small howto and some corrections for the manpages of the affected tools should be there.
1.30 jdf 198: *Tag*: system
1.29 jdf 199: *Tag*: howto
201: * **Task: Describe how to boot NetBSD on a gpt disk**: Currently, NetBSD supports booting from a gpt partition, but you cannot know how.
202: This task is about creating documentation how to use the tool gpt(8) and maybe installboot(8) how to create GPT labels, how they interact with MBRs as created by fdisk(8), how wedges work on this, and how you would make it bootable.
1.35 jdf 203: You should also describe which problems you have and what people might edge on when trying to create a gpt-bootable disk.
1.29 jdf 204: *Tag*: howto
205: *Tag*: system
1.1 asau 206:
1.5 asau 207:
1.45 jdf 208: ### Documentation
1.35 jdf 209:
1.45 jdf 210: * **Task: Howto: Install additional software in NetBSD**: With NetBSD, you have three major ways to install additional software: pkgsrc, pkg_add and pkgin.
211: Which one is to use for which use case, what are their benefits, their merits? Document them, and give a small introduction of the needed tools and their usage (package installation, package deletion, package information).
212: *Tag*: howto
1.36 jdf 213: *Tag*: system
214: *Tag*: service
1.45 jdf 216: * **Task: Howto: Encrypt the hard disk with NetBSD**: NetBSD has its very nice cryptographic device driver cgd. Apart from being already described in the [guide](http://netbsd.org/docs/guide/en/chap-cgd.html).
217: An explicit howto how to do this (in short) and how to do this during the installation, is the issue of this task.
218: Though cgd will be in sysinst for the next version of NetBSD, the current ones are still without, so there should be a special emphasis of how to add cgd during system installation.
1.52 khorben 219: Note that support for full-disk encryption has been introduced in NetBSD-current, in the form of a ramdisk (cgdroot.kmod). It still lacks official documentation at the moment, but was detailed [on the mailing-lists](http://mail-index.netbsd.org/current-users/2013/03/thread2.html#022311).
1.45 jdf 220: *Tag*: howto
1.29 jdf 221: *Tag*: system
1.1 asau 222:
1.45 jdf 223: * **Task: Howto: Protecting your system with veriexec**: There already is [a chapter in the Guide](http://netbsd.org/docs/guide/en/chap-veriexec.html) about veriexec, but there is no comprehensive guide how to activate it and how to check in all files in the distribution (there is [veriexecgen(8)](http://netbsd.gw.com/cgi-bin/man-cgi?veriexecgen++NetBSD-current) for this.
1.46 wiki 224: Your task is to write a howto describing everything a user needs to know and needs to do to have a secure system with veriexec.
1.45 jdf 225: *Tag*: howto
1.35 jdf 226: *Tag*: system
1.45 jdf 228: * **Task: Convert articles from the website to wiki articles**: There are several articles on the website (like [this one](http://netbsd.org/docs/misc/index.html)) which should be converted to wiki articles.
229: On the way, you could separate obsolete articles from newer ones.
230: Though this work could also partially be done by a tool like pandoc, the articles on the website have different format: Sometimes docbook, sometimes html, sometimes a mix of them. And pandoc doesn't result in such good results as hand-conversion might do.
231: *Tag*: wiki
1.35 jdf 232:
1.45 jdf 233: * **Task: Describe how to use NetBSD as a bluetooth access point**: With bluetooth, you can easily connect your computer to a mobile phone and let the phone use the network connection of the computer.
234: Your task is to describe how to do this: Connecting NetBSD via bluetooth to your phone and then provide different services (especially file transfer and network connection).
235: *Tag*: howto
236: *Tag*: system
237: *Tag*: network
238: *Tag*: service
1.35 jdf 239:
1.45 jdf 240: * **Task: Describe how to backup NetBSD**: Though NetBSD is much like other Unixes in this respect, backup is still something you should consider specially for every operating system. Which tools are available in the base distribution for backupping, like dump(8) and restore(8)?
241: Which one suits better, pax(1), dump(8) or even just rsync or other special backup solutions? What are their use cases?
242: What is a full, a differential, an incremental backup? What is the estimated space usage of them, depending on the backups?
243: How would you restore your system after a crash, which steps have to be taken to get a working system again?
244: After reading the resulting article, the reader should be able to decide for a backup scheme and solution and implement it without further research.
245: *Tag*: howto
246: *Tag*: system
247: *Tag*: research
1.35 jdf 248:
1.45 jdf 249: * **Task: Describe usage of Multicast DNS in NetBSD**: We have the "Multicast and Unicast DNS daemon" (mdnsd(8)) in NetBSD, which can also be activated directly from the installer (which is one of a few chosen services).
250: To be really able to use it, you have to know what it is and what you can do with it.
251: So, your task is to research what Multicast DNS (or zeroconf) is, and document which of the features is already usable with NetBSD and which ones can be installed via pkgsrc, which ones are completely missing (but relevant).
252: The mdnsd(8) manpage and the Wikipedia page for zeroconf might be a good start for this.
253: *Tag*: howto
1.36 jdf 254: *Tag*: system
255: *Tag*: service
1.49 khorben 256: *Tag*: research
1.36 jdf 257:
1.45 jdf 258: * **Task: Describe how to use NetBSD as an appliance**: NetBSD is often used for appliances, i.e. a small server serving only one single purpose. Though, there are no howtos describing how to set up a single appliance serving only one cause.
259: Though these howtos are targeted at creating a single appliance, they can also be used for other purposes.
260: Possible appliances would be:
261: * **router** - NetBSD is very well suited for router appliances and often used for that. There is a special task which is about creating a howto how to configure npf and comparing the different firewall solutions NetBSD offers. This task would rather be about everything around, like the routing part, securing the machine, network management (e.g. for wireless access points), and maybe only one example configuration for the firewall (especially NATting). A good example for an existing appliance is pfSense
262: * **file server** - NetBSD is also excellent as a file server, may it be either with nfs, smb, http, ftp or ftp over ssh as the transfer protocol. Your task would be to describe the packages which exist in pkgsrc and in NetBSD's base, and choose one special scenario for each protocol and give example configurations of the services. You should also mention RAIDframe, lvm and cgd briefly and what their use cases are. A good example for an existing appliance is FreeNAS or Apple Time Capsule (already running NetBSD).
263: * **backup server** - though somewhat similar to a file server, a backup server has different requirements. On the one hand, you have to think about how to connect effectively for backups, e.g. with rsync or other special backup protocols. On the other hand, you have to take special care for data integrity and data security. You should also take file system snapshots into account.
1.53 khorben 264: * **media server** - also similar to a file server, a media server has extra requirements. Some specific protocols may have to be deployed (UPnP/DLNA) and configured to support some client implementations in particular. Additional features, such as video transcoding, will be worth investigating as well.
1.34 jdf 265:
1.45 jdf 266: Every howto for an appliance is considered a single task.
267: As a special task, you could also create a shell script that fulfills the steps you mentioned in your howto, such that the user only has to execute this script to get an appliance. The prerequisite is only for this task.
268: If you can think of more possible appliances, maybe you can also use this as a task. If you want to work on a larger project (i.e. providing a whole derivate with one of these tasks), just tell us.
269: *Prerequisites*: sh
270: *Tag*: howto
1.35 jdf 271: *Tag*: research
1.45 jdf 272: *Tag*: service
273: *Tag*: system
274: *Tag*: network
1.47 khorben 275:
1.51 khorben 276: * **Task: Write assembly examples for additional architectures**: there is currently a single assembly example in src/share/examples/asm/hello, for the PowerPC architecture. NetBSD works on many more though; these examples are about illustrating how, at the assembly layer. This task to write basic, functional assembly programs on more architectures; each program is one task. Some architectures may support multiple ABIs, and this should also be investigated and documented while writing each example.
277: Note that "hello", the classic "Hello, world!", is not the only possibility to demonstrate basic assembly on any given architecture; the implementation of other programs can be relevant, provided they illustrate more aspects of assembly coding for the target architecture.
1.50 khorben 278: *Prerequisites*: assembly
279: *Tag*: research
1.47 khorben 280: *Tag*: system
CVSweb for NetBSD wikisrc <wikimaster@NetBSD.org> software: FreeBSD-CVSweb