gns-deb-diff-script Notes

Please, look at this page, to know how the script works.

README.gNewSense

Each package that is at http://bzr.savannah.gnu.org/lh/gnewsense/packages-parkes/ will have a README.gNewSense file under the debian/ directory.

The README.gNewSense file follows the following format:

Changed-From-Debian: A brief description of the change in a single line.
Change-Type: Modified

Longer description of the change is welcome. It can run into multiple lines. This long description can provide more comprehensive info about the details of the change or it might add notes that might be of interest to package wranglers or it might point to other places (like the changelog) where more information can be found.

The fields Changed-From-Debian & Change-Type can occur any part of the file. The values of these fields can be optionally be formatted in MoinMoin wiki syntax.

From a README.gNewSense file like the one illustrated above, is used to generate, a tuple, like the one below, by the script.

zlah

Modified

A brief description of the change in a single line.

more info

Tuples of all packages are used to generate the diff table:

Source Package

Change Type

Reason

More Info

alah

A short one line description about how this package differs from the corresponding Debian package.

more info

blah

more info

clah

Added

A short one line description about how this package differs from the corresponding Debian package.

more info

plah

Modified

more info

zlah

Modified

A brief description of the change in a single line.

more info

As can be seen, blank cells are inserted where the fields, Changed-From-Debian or Change-Type, is not present in the README.gNewSense file of the respective package.

The More Info link points to the README.gNewSense file in the bzr repo, this link is automatically generated from the package name.

more_info_link = "http://bzr.savannah.gnu.org/lh/gnewsense/packages-parkes/%s/annotate/head:/debian/README.gNewSense" % package_name

Semi-Automatic

The script writes the MoinMoin wiki formatted table to a file, which is then manually copied to the DifferencesWithDebian wiki page. Therefore, the whole process documenting the differences is not fully automatic yet.

sddhrth/gns-deb-diff-notes (last edited 2014-01-03 02:09:35 by sddhrth)