Logged-In As
ACCOUNT
Not Logged In
Write a section on WINE in the freebsd virtualization handbook chapter FreeBSD
Status: Closed Time to complete: 120 hrs Mentors: Ulrich Spörlein Tags: virtualisation, DocBook, documentation, SGML, virtualization, FreeBSD, wine

Description of task

There is a howto in the FreeBSD wiki on how to use WINE to run certain software on FreeBSD that are not natively available:

http://wiki.freebsd.org/Wine

We want to have this in a separate subsection in this FreeBSD handbook chapter: http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/virtualization-host.html
If possible, the howto needs to be tested whether it still works as described with the current version of WINE available in the FreeBSD Ports Collection.

Task requires:


A FreeBSD system (in a VirtualBox Virtual Machine) installed on your computer. 
Knowledge of the documentation guidelines for the FreeBSD project: http://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/ 
Check out a copy of the documentation tree from the documentation repository to get the source code for the chapter

Uploaded Work
File name/URL File size Date submitted
WINEFreeBSDandAMD64.sgml 3.2 KB January 09 2012 06:10 UTC
gcin-handbook.diff 3.8 KB January 10 2012 04:45 UTC
gcin-handbook.diff 3.6 KB January 13 2012 09:29 UTC
Comments
Bharath Mohan on January 5 2012 02:38 UTC Task Claimed

I would like to work on this task.

Bharath Mohan on January 5 2012 03:07 UTC Have I understood this correctly?

Would you like the whole article, or was it just the Wine on FreeBSD/amd64? I thought it was the former, but I wasn't sure, as the article itself doesn't include any setup instructions or anything of the sort, only listing Open Tasks, Known Problems, Bug reports, etc. Could I get some clarification on this?


Thanks in advance!

Wojciech A. Koszek on January 5 2012 07:24 UTC Task Assigned

This task has been assigned to Bharath Mohan. You have 120 hours to complete this task, good luck!

Wojciech A. Koszek on January 5 2012 07:56 UTC Answer

Bharath,


Assume 1 architecture is the minimum. It's enough to get this article tested on 1 architecture. If you can and it won't significantly increate the project time, and if it's possible, please try to see if 'i386' works in the same way. If it does, we can drop amd64/i386 and make it 'x86'


However including only 1 architecture is OK. The important thing is to actually check the article - try to see, if the description matches reality.


Wojciech 

Bharath Mohan on January 5 2012 08:24 UTC Re: Answer

So you would like me to test the FreeBSD/amd64 section, reformat that part of the wiki for the handbook, and then, if possible, check for i386 as well?

Ulrich Spörlein on January 5 2012 09:08 UTC Re: Answer

That sounds about right. Please also think about where exactly to put that information in the handbook. IMHO the Virtualization chapter is the wrong place, as this has nothing to do with virtualization (WINE isn't even an emulator!). Somewhere close to Chapter 11 about Linux Binary Compatibilty would make most sense. Except that explaining WINE isn't even specific to FreeBSD, so a whole chapter seems unwarranted.


 


But first, let's vet the contents of the Wiki article and SGMLify it, then we can decided where to actually put it.


 


Thanks 

Bharath Mohan on January 9 2012 05:32 UTC Status Update

Just gving a quick status update, I have compeleted the testing of it, and it works just fine as is. I was unable to test the section regarding Diablo 2, but I think it is safe to assume that that part works as well as the rest of it does. I am working on the transition to SGML, and once it has been properly formatted, I will upload.

Bharath Mohan on January 9 2012 05:58 UTC Done with SGML-ification

I have completed turning the article into SGML. Would you like me to insert it into the Virtualization chapter? Or is there a better, more appropriate place you'd like me to put it all into? Or would you just like for me to upload the file so that you may decide where to put it?

Bharath Mohan on January 9 2012 06:10 UTC Also, have uploaded the SGML for a quick look-over

Hi, I just wanted to let you know that I have now uploaded the SGML file so that you can look over it and let me know if everything is OK. I think I have put everything down right, it was a fairly short section and I don't think there was anything to complicated. However, I just wanted to be careful.

Bharath Mohan on January 10 2012 04:44 UTC Completed .diff

I guess you've been a little busy the past day, and I can understand that. Unfortunately, as the deadline has drawn close, I had to modify the handbook and upload a diff. As a result, I chose to stick with the given link, as on the WINE website it does describe itself as a Windows Emulator for UNIX systems, and the port for WINE is under emulators, so I chose to put it under Virtualization. I hope this is alright, and I hope that the SGML of the article is alright when you take a look at it!

Bharath Mohan on January 10 2012 04:45 UTC Ready for review

The work on this task is ready to be reviewed.

Melange on January 10 2012 07:24 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.

Ulrich Spörlein on January 10 2012 19:39 UTC Deadline extended

The deadline of the task has been extended with 6 days and 0 hours.

Ulrich Spörlein on January 10 2012 19:39 UTC Task Needs More Work

One of the mentors has sent this task back for more work. Talk to the mentor(s) assigned to this task to satisfy the requirements needed to complete this task, submit your work again and mark the task as complete once you re-submit your work.

Ulrich Spörlein on January 10 2012 20:14 UTC First review pass

Hello Mohan,


thanks for the quick work and I'm sorry for replying so late. Rather busy at the moment. I've extended the deadline a couple of more days so we can do one or two more revisions of this. I always assumed it was a sort of estimate on how many man hours are involved, and not the timespan within this issue must be finished. I hope you're still interested.


Thanks for providing a diff and a standalone article, that helps a lot with reviewing!


The SGML chapter is lacking some fundamental information on what WINE is and how to get it running on FreeBSD for i386 (the amd64 part is the special case, there should be a general case also). It should be about "WINE on FreeBSD" (for both i386 and amd64).


Drop the line about r190620 and simply state that it's only known to work on 8.2 and 9.0 (the latest two releases).


Drop the DirectSound link, there's no such link. It's just an artifact from the Wiki markup.


Make that part a special sub-section about sound, as this seems to be a general problem due to OSS and ALSA differences. (Diablo2 should still be left as an example application that's affected)


FreeBSD should be spelled &os;


Drop the inlined image link.


Drop the reference to gmane, this should IMHO not be put into the Handbook. It should be rather self-contained. We should especially *not* put links to unmaintained stuff into the Handbook.


Same goes for the daemonforums link.


 


I'm also not conviced that this belongs into the chapter about virtualization, as it is closer to our Linux binary compatibility than anything else. Therefore, I'd encourage you to send an email to the docs list (docs@FreeBSD.org) and pointing them to the Wiki article and the handbook and ask for guidance as to where to put it so it makes the most sense.

Bharath Mohan on January 13 2012 09:28 UTC Update

I found the instances that you mentioned. I suppose it's my fault; I should've checked those links for consistency and maintenance. I apologize for that.


I've completed another diff of the changes I made. I will upload it. I have also sent the e-mail you asked me to send. In fact, I sent it the moment I recieved the notification about the comment and I had read through it. I haven't recieved a response yet, so I'll update my current diff for now and mark as complete, just for checking for any formatting issues and the like. As soon as I recieve a reply of some kind, I'll let you know what they say. Hopefully, they'll agree that it belongs in Chapter 11 and not bring up something completely different!

Bharath Mohan on January 13 2012 09:29 UTC Ready for review

The work on this task is ready to be reviewed.

Bharath Mohan on January 15 2012 16:44 UTC No response

I haven't yet recieved a response from the freebsd-doc info team. When I first sent it to docs@freebsd.org, it bounced back, so i found another mailing list which I think is what you meant, at freebsd-doc@freebsd.org. However, I haven't recieved any sort of response from them. I'll let you know if anything comes in, but I'm not sure...

Bharath Mohan on January 15 2012 18:04 UTC Also, interesting coincidence

I just realized that the two other tasks that I wanted to complete after this (I've already prepared the work for them) are being mentored by you! They're the articles on GIT and Mercurial use in local FreeBSD development. So, since I'm already here, I thought I might as well ask: Did you want those as a seperate article, or something else? If it's a seperate article, then I've already weapped up the work for them. At least, I've done somework, but I'm not sure if you'll find them both OK; it's possible I missed something. But if it's something else, then I hope you'll let me know, as today is the last day to claim tasks. At least, it is over here in California.


And unfortunately, I still have not recieved a reply. I'm going to send a quick follow-up e-mail, in case somehow they missed my original, or if some glitch happened on their end and it got lost somehow. I'll keep you up to date on what happens...

Bharath Mohan on January 16 2012 00:33 UTC URGENT: Awaiting response

As we get closer to the deadline, I'm getting a little nervous. I'd like to at least finish one more task by the end of the Code-In, and I'd rather not abandon this task after all the work I've put into it. I can understand if there's urgent business you have to attend to, but if otherwise, would you please let me know if the work on this task is done or not? And if not, would you please specify what you need fixed so that I may fix it quickly? I have not yet recieved a response from the FreeBSD doc team or the mailing list, despite sending a follow-up e-mail. Could you please respond ASAP?


Thanks in advance!

Wojciech A. Koszek on January 16 2012 08:44 UTC Task Closed

Congratulations, this task has been completed successfully.

Bharath Mohan on January 16 2012 08:56 UTC Thanks!

Thanks so much! If there's anything that was actually wrong, don't hesitate to let me know, I'll send it wherever necessary!

Ulrich Spörlein on January 16 2012 08:59 UTC Reply from freebsd-doc mailinglist

There actually were two replies on the freebsd-doc mailinglist, but the answers are somewhat inconclusive.


See http://lists.freebsd.org/pipermail/freebsd-doc/2012-January/thread.html


I'd also consider work on this task done and will prepare a patch for review by some fellow docs committer soon.


Feel free to also claim the other tasks (if that's still possbible), although I think the git article would make more sense, but there's also work being done in the background that might obsolete alot of that information.


 


Sorry for replying so late, I really hate these stupid deadlines :(

Bharath Mohan on January 16 2012 17:52 UTC Perhaps renaming is the right thing to do?

Don't worry too much. I hate deadlines too... I'm not sure if anyone really likes deadlines at all.


That's strange, as I didn;t actually recieve either of those responses... I guess something was wrong in my end. I'll check my spam and trash.


What Benedict suggested seemed like a pretty good idea. We could rename them... but then, which one do we rename? Hooray, we're back where we started.