Diff for generic readme and generic-build script to automatically generate pkg data and file listings

Alan Miles miles0201@cox.net
Sun Dec 21 18:05:00 GMT 2003


Based on the 1.8 version of the generic build script I would like to submit
this patch, which would allow package maintainers
to automatically update the distribution READMEs when they do a build.

1/ The option "all" does not call "list". The fix in the patch does.
2/ The patches to both file let the PKG, VER, and REL variables in the
README be automatically be filled in by the script -
   then maintainers won't have to manually do this.
3/ This patch fulfills the wish to have the file names be automatically be
placed in the README prior to binary/src build
   releases. The 1.8 version heads in that direction, but the functionality
isn't there.
4/ I have defined a NEWVER variable to handle the <newer REL> part of the
original README
5/ Defined a new export variable: 'ThePackageReadMeFile' which defines the
Package README file name
   (saves defining it twice) - both 'list' and 'install' use it
6/ I haven't renamed the routine "list", which it should be since it is a
"package" readme editor
7/ Note: the e sed command (quoting the man page for sed):

   Extended sed command:

   `e [COMMAND]'
     This command allows one to pipe input from a shell command into
     pattern space.  Without parameters, the `e' command executes the
     command that is found in pattern space and replaces the pattern
     space with the output; a trailing new-line is suppressed.

     If a parameter is specified, instead, the `e' command interprets
     it as a command and sends it to the output stream (like `r' does).
     The command can run across multiple lines, all but the last
     ending with a back-slash.

     In both cases, the results are undefined if the command to be
     executed contains a NUL character.

8/ To prevent using sed's -i option (see the message from Igor
http://cygwin.com/ml/cygwin/2003-11/msg01067.html -
   this should mitigate Igor's concerns). I store the /usr/bin/basename of
the Readme file into a variable which allows the script to
   generate a temporary readme file (/tmp/%PKG%.README)

   Then I do an [effective]:
   "mv -f /tmp/%PKG%.README /usr/share/doc/Cygwin/%PKG%.README"

   operation. I do NOT write the temp file in the /usr/share/doc/Cygwin/
directory since this will lead to a very subtle problem:
   The files listed would show two entries instead of one for the README,

    which is not what we want.

For further [past] postings see items
http://cygwin.com/ml/cygwin/2003-11/msg01067.html and

for details.

Alan Miles
ICQ#: 171006836
More ways to contact me: http://wwp.icq.com/171006836
-------------- next part --------------
A non-text attachment was scrubbed...
Name: packaging_templates.diff
Type: application/octet-stream
Size: 4504 bytes
Desc: not available
URL: <http://cygwin.com/pipermail/cygwin-apps/attachments/20031221/0671bc94/attachment.obj>

More information about the Cygwin-apps mailing list