Update the developer tools section of the FreeBSD developers handbook with a list of tools on a wiki page FreeBSD
Status: Closed Time to complete: 96 hrs Mentors: Gavin Atkinson Tags: DocBook, documentation, SGML, FreeBSD, tools, developer

Description of task

The FreeBSD developers handbook has a chapter explaining various tools that come in handy when developing software for FreeBSD: http://www.freebsd.org/doc/en_US.ISO8859-1/books/developers-handbook/tools.html Another list of useful tools was created on the following wiki page: http://wiki.freebsd.org/DevTools We want to have the developers handbook updated with the tools listed on that wiki page so that developers find all the tools in one place (the handbook, not the wiki). When adding these tools to the developers handbook, the source code for the chapter needs to be correctly formatted and must conform to our documentation source code style guidelines.

Task Requirements

Students are encouraged to use a FreeBSD system like our VirtualBox image to test the procedure, but can also use the information available online.

Please read http://wiki.FreeBSD.org/GoogleCodeIn/GettingStarted before accepting this task, as it contains further details on what this task consists of, as well as providing useful information on how to obtain the page source and how to proceed with the task.  

Uploaded Work
File name/URL File size Date submitted
new chapter.sgml 87.3 KB January 06 2012 21:45 UTC
mpaloski on November 26 2011 12:53 UTC Task Claimed

I would like to work on this task.

mpaloski on November 26 2011 12:59 UTC Claim Removed

The claim on this task has been removed, someone else can claim it now.

Zacharias Mitzelos on January 1 2012 10:57 UTC Task Claimed

I would like to work on this task.

Zacharias Mitzelos on January 1 2012 10:59 UTC How to add tools to the handbook

Can you explain me how I am going to add the tools to the handbook?? Is there a specific format I will have to submit??


Thank you!

Gavin Atkinson on January 2 2012 00:08 UTC Handbook format


Yes - there is a specific format.

The FreeBSD Developer's Handbook is written in SGML. This is similar to HTML, and although it is different shoudn't be hard for you to pick up, especially if you already know HTML.  The actual source for the Developers Handbook can be seen at http://www.freebsd.org/cgi/cvsweb.cgi/~checkout~/doc/en_US.ISO8859-1/books/developers-handbook/tools/chapter.sgml?rev=1.52;content-type=text%2Fplain (allthough I'd really recommend you download and use the virtual image provided if possible, rather than downloading and using that file).

Hopefully from that it should be quite apparent just how SGML works, and how you would go about adding  and updating it with more tools and information.  If not, feel free to ask more information, either here or (ideally) on IRC, in #freebsd-soc on EFnet.



Gavin Atkinson on January 2 2012 00:08 UTC Task Assigned

This task has been assigned to Zacharias Mitzelos. You have 96 hours to complete this task, good luck!

Melange on January 6 2012 00:08 UTC Initial Deadline passed

Melange has detected that the initial deadline has passed and it has set the task status to ActionNeeded. The student has 24 hours to submit the work before the task is reopened and sent back to the pool for other students to claim.

Zacharias Mitzelos on January 6 2012 21:46 UTC Ready for review

The work on this task is ready to be reviewed.

Zacharias Mitzelos on January 6 2012 21:48 UTC Marking task as completed

I have just marked the task as complete. I hope everything is fine. If you have any questions or demands, don't be afraid to ask

Melange on January 7 2012 00:08 UTC No more Work can be submitted

Melange has detected that the deadline has passed and no more work can be submitted. The submitted work should be reviewed.

Zacharias Mitzelos on January 8 2012 00:22 UTC It would really help me if you could review the task

It would really help me if you could procced with reviewing the task ASAP, because I am planning to finish more tasks, and the time is against me at this point.



Zacharias Mitzelos

Gavin Atkinson on January 8 2012 16:43 UTC Task Closed

Congratulations, this task has been completed successfully.

Gavin Atkinson on January 8 2012 16:51 UTC Hi


Sorry for not being able to review this task sooner.

There are a few issues with it.

Firstly, a minor one: there is an extra "<sect1>" tag at the start.

Secondly: The indentation is very different from how it should be.  Although this won't take too long for me to fix, itsuggests that you didn't read the task description closely enough.

Thirdly, there are a few parts missing, such as the missing "l" from "ets you to see a".  I appreciate that you copied and pasted the text from one into another, but re-reading it and perhaps rewording parts of it to prodiuce better English would have been good.

Overall, however, I am prepared to accept this, primarily due to the fact that I was unable to review your task in time.  Ideally though, and for future tasks that you do, you should have not been afraid to ask earlier if there were aspects of this task you didn't understand, we don't bite :)



Zacharias Mitzelos on January 8 2012 21:19 UTC Thanks, Mentor!

First of all, I would like to thank you for accepting the task, although it had some serious mistakes as you mentioned.

I was very unfamiliar with SGML and that's why I had some mistakes on the code. Although I had some knowledge on HTML, it wasn't so helpful. I didn't copied-pasted the text from the wiki, most of it I had to re-compose it. I understand that I might did not read again some lines, of the new text, making the text difficult to be understanded. I was logged to the IRC channel to answer my questions for some hours, and finaly another (student maybe, not mentor) help me understand my difficulties on the task.

Despite all that, I really understand that you had not found the time to review or answer my questions. There is no reason to apologize, because I realized you have not enough mentors to surveil all the tasks. I appreciate you accepted the task although the problems.


Kind Regards,

Zacharias Mitzelos´╗┐