Re: Updating NVidia documentation

2003-10-17 Thread Mark Vojkovich
On Fri, 17 Oct 2003, Alexander Shopov wrote:

 Hi guys,
 I am tryng to update the docs about nvidia chips in XFree86.
 I've checked out the sgml docs (module sgml) and the nv driver files 
 (directory xc/programs/Xserver/hw/xfree86/drivers/nv) (HEAD branch)
 There is a man page in that directory. Is this the original or is there 
 a sgml original somewhere else?

   xc/programs/Xserver/hw/xfree86/drivers/nv/nv.man is the
NVIDIA driver documentation.  That's what I edit. 

 Also - I am wondering what is the connection between the 
 xc/programs/Xserver/hw/xfree86/drivers/nv/nv.man file and the 
 sgml/NVIDIA.sgml file.

  That file is 4 years old (XFree86 3.x days) and is not
applicable.  Alot of the files in that directory aren't
applicable.  I'm not sure why we keep this old documentation
around.  The MGA.sgml is 5 years old.


Mark.

___
Devel mailing list
[EMAIL PROTECTED]
http://XFree86.Org/mailman/listinfo/devel


Re: Updating NVidia documentation

2003-10-17 Thread Mark Vojkovich
On Fri, 17 Oct 2003, Alexander Shopov wrote:

 Mark Vojkovich wrote:
  On Fri, 17 Oct 2003, Alexander Shopov wrote:
 
  
 xc/programs/Xserver/hw/xfree86/drivers/nv/nv.man is the
  NVIDIA driver documentation.  That's what I edit. 
 man page directly? 

   Yes.

 It seems to me that this is standard ;-(
 Why is the other documentation in sgml and later translated to HTML, PS, 
 man etc?

   Beats me.  The nv.man gets translated into html and the installable
man page.

 
That file is 4 years old (XFree86 3.x days) and is not
  applicable.  Alot of the files in that directory aren't
  applicable.  I'm not sure why we keep this old documentation
  around.  The MGA.sgml is 5 years old.
 
 OK. For now I have found the following docs on nVidia:
 
 xc/programs/Xserver/hw/xfree86/doc/README.NV1
 Very out of date - NVidia NV1 / SGS-Thomson STG2000 Users, David McKay, 
 20th March 1997
 
 
 xc/programs/Xserver/hw/xfree86/doc/README.NVIDIA
 Very out of date - Information for NVidia NV1 / SGS-Thomson STG2000, 
 Riva 128 and Riva TNT and TNT2 Users, David McKay, Dirk Hohndel, June 25 
 1999
 It seems it is built on top of README.NV1
 
 
 xc/programs/Xserver/hw/xfree86/doc/sgml/NVIDIA.sgml
 This is the file that README.NVIDIA should be generated from. But the 
 command corresponding to its generation in 
 xc/programs/Xserver/hw/xfree86/doc/Imakefile is commented out.
 
 And of course: xc/programs/Xserver/hw/xfree86/drivers/nv/nv.man
 Mostly up to date. Only two options not documented.
 
 Any suggestions what I should do?
 

   Disregard everything but nv.man.  The other docs are all
circa XFree86 3.x.  I think all the old docs should get deleted.
Having wrong documentation lying around is confusing.


Mark.

___
Devel mailing list
[EMAIL PROTECTED]
http://XFree86.Org/mailman/listinfo/devel


Re: Updating NVidia documentation

2003-10-17 Thread David Dawes
On Fri, Oct 17, 2003 at 11:35:12PM +0300, Alexander Shopov wrote:
Mark Vojkovich wrote:
 On Fri, 17 Oct 2003, Alexander Shopov wrote:

 
xc/programs/Xserver/hw/xfree86/drivers/nv/nv.man is the
 NVIDIA driver documentation.  That's what I edit. 
man page directly? It seems to me that this is standard ;-(
Why is the other documentation in sgml and later translated to HTML, PS, 
man etc?

Historically we had readme files (that's what is in SGML) for various
drivers and other stuff.  With the move to modular drivers in 4.0 we
added man pages.  It doesn't make sense to have the same information in
both places.  My personal preference is for man pages for drivers, and
SGML/XML/whatever for other types of documents.  Both types of docs get
converted to HTML for our online documentation.  They both end up in PS
format (and PDF for 4.4), although in the case of the man pages it is
one large document with all man pages.

xc/programs/Xserver/hw/xfree86/doc/sgml/NVIDIA.sgml
This is the file that README.NVIDIA should be generated from. But the 
command corresponding to its generation in 
xc/programs/Xserver/hw/xfree86/doc/Imakefile is commented out.

Right.  Out of date docs are not formatted or installed.

David
-- 
David Dawes X-Oz Technologies
www.XFree86.org/~dawes  www.x-oz.com
___
Devel mailing list
[EMAIL PROTECTED]
http://XFree86.Org/mailman/listinfo/devel