PackagingDrafts/HtmlDocs

From FedoraProject

< PackagingDrafts(Difference between revisions)
Jump to: navigation, search
(init)
 
(title)
Line 1: Line 1:
== Current State ==
+
== HTML preferred over INFO ==
  
 
GNU packages have documentation provided as texinfo files.  These can be translated into (the most popular ones) '''info''', '''html''' (in single-page or multi-page format), '''pdf''' or '''plain text'''.  Currently only '''info''' documents are generated.
 
GNU packages have documentation provided as texinfo files.  These can be translated into (the most popular ones) '''info''', '''html''' (in single-page or multi-page format), '''pdf''' or '''plain text'''.  Currently only '''info''' documents are generated.

Revision as of 14:42, 15 February 2011

HTML preferred over INFO

GNU packages have documentation provided as texinfo files. These can be translated into (the most popular ones) info, html (in single-page or multi-page format), pdf or plain text. Currently only info documents are generated.

There was a suggestion users nowadays prefer more for example html than the info documents (an idea of Jan Pazdziora).

Proposal

While info documents should remain available proposing to also generate single-page html format. As info is normally stored compressed (.info.gz, 411KB) it is much smaller than .html (2280KB).

Therefore proposing to move both the info and html documentation into separate -doc subpackages. Man pages are generally available still in the main packages for the basic information.

Example

Package gdb-7.2.50.20110213-22.fc15 is now using the proposed format.