bug-gnulib
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

gnulib documentation structure


From: Bruno Haible
Subject: gnulib documentation structure
Date: Mon, 23 Oct 2006 14:16:31 +0200
User-agent: KMail/1.9.1

Hi,

I'm restructuring the gnulib documentation:
  1) to separate the random notes from the documentation of individual modules,
  2) to move the gnulib-tool invocation before all these detail descriptions,
     because how to use gnulib-tool is now important for every gnulib user.

2006-10-21  Bruno Haible  <address@hidden>

        * doc/gnulib.texi: Split the chapter "Gnulib" into 3 chapters
        "Introduction", "Miscellanous Notes", "Particular Modules".

diff -r -c3 --exclude=CVS gnulib-20061020/doc/gnulib.texi 
gnulib-20061020-modified/doc/gnulib.texi
*** gnulib-20061020/doc/gnulib.texi     2006-09-29 01:08:24.000000000 +0200
--- gnulib-20061020-modified/doc/gnulib.texi    2006-10-22 04:33:57.000000000 
+0200
***************
*** 55,73 ****
  @end ifnottex
  
  @menu
! * Gnulib::
  * Invoking gnulib-tool::
  * Copying This Manual::
  * Index::
  @end menu
  
  
! @node Gnulib
! @chapter Gnulib
! 
! This manual contains some bare-bones documentation, but not much more.
! It's mostly a place to store notes until someone (you?)@ gets around
! to writing a coherent manual.
  
  Getting started:
  
--- 55,71 ----
  @end ifnottex
  
  @menu
! * Introduction::
  * Invoking gnulib-tool::
+ * Miscellanous Notes::
+ * Particular Modules::          Documentation of Individual Modules
  * Copying This Manual::
  * Index::
  @end menu
  
  
! @node Introduction
! @chapter Introduction
  
  Getting started:
  
***************
*** 79,94 ****
        @url{http://www.gnu.org/software/gnulib/}.
  @end itemize
  
  @menu
  * Comments::
  * Header files::
- * Quoting::
- * ctime::
- * inet_ntoa::
- * gcd::
  * Out of memory handling::
  * Library version handling::
- * Regular expressions::
  * Windows sockets::
  * Libtool and Windows::
  * License Texinfo sources::
--- 77,94 ----
        @url{http://www.gnu.org/software/gnulib/}.
  @end itemize
  
+ 
+ @include gnulib-tool.texi
+ 
+ 
+ @node Miscellanous Notes
+ @chapter Miscellanous Notes
+ 
  @menu
  * Comments::
  * Header files::
  * Out of memory handling::
  * Library version handling::
  * Windows sockets::
  * Libtool and Windows::
  * License Texinfo sources::
***************
*** 181,195 ****
  @end itemize
  
  
- @include quote.texi
- 
- @include ctime.texi
- 
- @include gcd.texi
- 
- @include inet_ntoa.texi
- 
- 
  @node Out of memory handling
  @section Out of memory handling
  
--- 181,186 ----
***************
*** 286,302 ****
  @end example
  
  
- @node Regular expressions
- @section Regular expressions
- 
- Gnulib supports many different types of regular expressions; although
- the underlying features are the same or identical, the syntax used
- varies.  The descriptions given here for the different types are
- generated automatically.
- 
- @include regexprops-generic.texi
- 
- 
  @node Windows sockets
  @section Windows sockets
  
--- 277,282 ----
***************
*** 329,334 ****
--- 309,315 ----
  getaddrinfo symbol and use it if present, otherwise fall back to our
  own implementation.
  
+ 
  @node Libtool and Windows
  @section Libtool and Windows
  
***************
*** 365,371 ****
  Of course the license texts themselves should not be changed at all.
  
  
! @include gnulib-tool.texi
  
  
  @node Copying This Manual
--- 346,379 ----
  Of course the license texts themselves should not be changed at all.
  
  
! @node Particular Modules
! @chapter Particular Modules
! 
! @menu
! * Quoting::
! * ctime::
! * gcd::
! * inet_ntoa::
! * Regular expressions::
! @end menu
! 
! @include quote.texi
! 
! @include ctime.texi
! 
! @include gcd.texi
! 
! @include inet_ntoa.texi
! 
! @node Regular expressions
! @section Regular expressions
! 
! Gnulib supports many different types of regular expressions; although
! the underlying features are the same or identical, the syntax used
! varies.  The descriptions given here for the different types are
! generated automatically.
! 
! @include regexprops-generic.texi
  
  
  @node Copying This Manual




reply via email to

[Prev in Thread] Current Thread [Next in Thread]