bug-gnupod
[Top][All Lists]
Advanced

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

[Bug-gnupod] The docs are dead! Long live the docs! ;-)


From: H. Langos
Subject: [Bug-gnupod] The docs are dead! Long live the docs! ;-)
Date: Fri, 3 Jul 2009 00:28:27 +0200
User-agent: Mutt/1.5.18 (2008-05-17)

Hi there,

Some minutes ago the doc branch was merged. Man pages are gone.
Now there's the pod style documentation within the perl files.
Not all of them but if somebody writes up an "undocument" mock 
up, there's an include mechanism that will allow to add it with
a single line to the script files that don't have their own 
documentation yet.
Hopefully this will be easier to maintain.

Apart from that, there is the info documentation that I don't
really know how to maintain. Volunteers welcome :-)


While working on the documentation, I took a look at the build
system and decided that it should be more modular than just
"make install". Currently you can't really test your changes
unless you install the whole thing. Now there is a rudimentary
"build" step where scripts, modules and documentation are
rendered into a separate directory where you can run them before
you decide to call "make install" as root.

It is rudimentary in many regards but it's a start. 
I want to get the functions of tools/gnupod_install.pl step 
by step out of there and into the Makefile/configure script.
"gnupod_install.pl" should only prepare the files, do some 
substitutions and leave the real installation to standard 
posix tools like "cp" and "chmod" or maybe "install". 
(BTW: Is "install" a posix tool?)

Along the way I want to
a) make it configurable if you keep the .pl extension on 
   the installed perl scripts (and their man pages) or 
   if you'd rather strip them.
   (I'd rather strip the .pl but that's a 
   matter of taste and I will not fight about it.)
b) make the target directory for the gnupod modules 
   configurable via ./configure
   (I don't like the way gnupod messes around in /etc 
   to install its modules.)
c) Insert your wish here ;-)

cheers
-henrik





reply via email to

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