On February 14, 2004 05:17 pm, Michael Stefaniuc wrote:
this man page incorporates a big chunk out of the README file. The rest of the README file should be probably merged into the Winelib User Guide or into the Wine Developers Guide; it would fit in both.
I'm thinking maybe your patch should remove the README sections that were transfered to the man page. This way, it's simple to see what needs to be done for the rest of the stuff.
On Sat, Feb 14, 2004 at 06:29:13PM -0500, Dimitrie O. Paun wrote:
On February 14, 2004 05:17 pm, Michael Stefaniuc wrote:
this man page incorporates a big chunk out of the README file. The rest of the README file should be probably merged into the Winelib User Guide or into the Wine Developers Guide; it would fit in both.
I'm thinking maybe your patch should remove the README sections that were transfered to the man page. This way, it's simple to see what needs to be done for the rest of the stuff.
I've thought about doing that but the README file is written in the style of a man page. And ripping one part out would make the rest hard to read. A better approach would be to move/rewrite the rest to the Winelib or Wine deveolopers guide and than remove the README.
bye michael
On February 15, 2004 07:07 am, Michael Stefaniuc wrote:
I've thought about doing that but the README file is written in the style of a man page. And ripping one part out would make the rest hard to read. A better approach would be to move/rewrite the rest to the Winelib or Wine deveolopers guide and than remove the README.
I'd say let's have most of it in the man page. The rest I think can go to the Devel Guide, so that people are aware of the tool. We shouldn't add too much in the Guide, just as a small note, the rest should be in the man page. Now, since you've done the man page, can you finish the other bit as well? :))) Thing is that you now _know_ what parts of the README have been converted to the man page, and I wouldn't want to lose that info. So we either (1) delete it from the README as a temporary solution, or (2) do the right thing and move it to the Guide.
On Sun, Feb 15, 2004 at 10:12:19AM -0500, Dimitrie O. Paun wrote:
On February 15, 2004 07:07 am, Michael Stefaniuc wrote:
I've thought about doing that but the README file is written in the style of a man page. And ripping one part out would make the rest hard to read. A better approach would be to move/rewrite the rest to the Winelib or Wine deveolopers guide and than remove the README.
I'd say let's have most of it in the man page. The rest I think can go to the Devel Guide, so that people are aware of the tool. We shouldn't add too much in the Guide, just as a small note, the rest should be in the man page. Now, since you've done the
Did you have a look at the README? It's more than the man page (or what would make sense in a man page). Only to put a small note into the guides would mean to dump a lot of info from the man page.
man page, can you finish the other bit as well? :))) Thing is that you now _know_ what parts of the README have been converted to the man page, and I wouldn't want to lose that info. So we either (1) delete it from the README as a temporary solution, or (2) do the right thing and move it to the Guide.
I think i will go for (1) cause i'm busted in work this week (and no, i don't consider documentation work as recreation), than 1 week of skiing, than again a week busted in work.
bye michael
-
Dimitrie O. Paun -
Michael Stefaniuc