[PATCH input-mouse 13/14] README: keep the text version of README, discard the sgml version

[Gaetan Nadon]

On Sat, 2010-05-15 at 22:39 +0200, Rémi Cardona wrote:

> Le 14/05/2010 22:50, Gaetan Nadon a écrit :
> > The linuxdoc doc tool is deprecated.
> > README files are exclusively text files.
> > The file had not been updated for 5 years.
> 
> Is that file worth keeping and maybe converting to docbook like Alan did
> for the internal server doc?
> 

I have been asking my self that question and counting on this review for
opinions. What tipped the balance (for me):

- The drivers appear not to be under development, so the file gets
rarely changed
- The file is almost all plain text (little or no formatting) except for
the generated toc.
- Plain text is acceptable for a README file
- docbook sgml is also a deprecated format. Conversion to Docbook xml is
not straightforward.

If we want to retain the marked-up source, I would put it (renamed) in
a /doc and have it installed. I don't like the current manual
half-generated half-git solution.

                              From: 
Alan Coopersmith
<Alan.Coopersmith at Sun.COM>
                                To: 
X.Org Developers
<xorg-devel at lists.x.org>
                           Subject: 
X.Org documentation formats, plans,
conversions, etc.
                              Date: 
Tue, 10 Nov 2009 21:40:32 -0800
(Wed, 00:40 EST)

        At this point, these are the documentation input and output formats I know of:
        
        Preferred output formats:
          - man pages for commands and public API in client-side libraries,
                to be installed in $(mandir)
          - plain text, html & pdf for specifications and other documents,
                to be installed in $(docdir) & published on the website
        
        Preferred input formats:
          - DocBook/XML (can generate man, text, html & pdf)
        
        Acceptable input formats:
          - AsciiDoc (can generate DocBook, thus all DocBook supports)
          - Plain text
          - man pages in troff -man format
          - doxygen comments in source code
        
        Deprecated input formats (no new docs should be added in these):
          - troff -ms/-mm
          - FrameMaker
          - LinuxDoc
          - DocBook/SGML
          - TeX



> Cheers,
> 
> Rémi
> _______________________________________________
> xorg-devel at lists.x.org: X.Org development
> Archives: http://lists.x.org/archives/xorg-devel
> Info: http://lists.x.org/mailman/listinfo/xorg-devel
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.x.org/archives/xorg-devel/attachments/20100516/5b7dc17a/attachment.html>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 197 bytes
Desc: This is a digitally signed message part
URL: <http://lists.x.org/archives/xorg-devel/attachments/20100516/5b7dc17a/attachment.pgp>