gns-deb-diff

automate the documentation of the differences between gNewSense and Debian.
git clone git://git.ricketyspace.net/gns-deb-diff.git
Log | Files | Refs

commit 216e02eb99b64bc06fe55400185dd89a3feb2622
parent 5e040f9ac7600cdd377fea14365c517cec0c8065
Author: rsiddharth <rsiddharth@ninthfloor.org>
Date:   Sun, 15 Dec 2013 14:49:21 +0530

updated the README file.

Diffstat:
README.md | 58+++++++++++++++++++++++++++-------------------------------
1 file changed, 27 insertions(+), 31 deletions(-)

diff --git a/README.md b/README.md @@ -4,11 +4,11 @@ This script is an effort to automate the documentation of the differences between gNewSense and Debian. The present list of differences is documented at the -[gNewSense wiki][2]. Look at the [savannah task #12794][1] for more +[gNewSense wiki][1]. Look at the [savannah task #12794][2] for more info. -[1]: https://savannah.nongnu.org/task/?12794 -[2]: http://www.gnewsense.org/Documentation/3/DifferencesWithDebian +[1]: http://www.gnewsense.org/Documentation/3/DifferencesWithDebian +[2]: https://savannah.nongnu.org/task/?12794 ## Synopsis @@ -23,49 +23,45 @@ info. that differ from Debian. Look at `packages-parkes.list` file for a sample. -`output-table-file`, is the file to which the script should write the difference table. +`output-table-file`, is the file to which the script should write the +difference table. ## Description This is what the script does at present: -+ **S1** The script pulls the latest version of the packages, listed -in the `packages-list-file`, from their respective bzr repos. ++ **STEP1** The script pulls the latest version of the packages, listed + in the `packages-list-file`, from their respective bzr repos. -+ **S2** For packages which contain the `README.gNewSense` file, it -reads the content into a dict; the keys being the names of the -packages. ++ **STEP2** For packages which contain the `README.gNewSense` file, a + dict of the form `{'pkg': 'package_name', 'Change-Type': + 'Added/Removed/Modified', 'Changed-From-Debian': 'one line + description'}` is generated. -+ **S3** The script puts the names of packages, which doesn't contain -`README.gNewSense` file, into a seperate list. + The value for keys `Change-Type' & `Changed-Frome-Debian' is None, + if values for those are not present in the README.gNewSense. -+ **S4** The dict produced in **S2** is used to generate MoinMoin -marked up table, like [the one here][2]. ++ **STEP3** The script puts the names of packages, which doesn't contain + `README.gNewSense` file, into a seperate list. -+ **S5** The generated table is written to the `output-table-file`. ++ **STEP4** The dicts produced in **STEP2** is used to generate + MoinMoin marked up table, like + [the one found here][gns-deb-diff-notes]. -+ **S4** The list of packages which doesn't contain `README.gNewSense` -is barfed out to stdout. ++ **S5** The generated table is written to the `output-table-file`. -## Notes - -1. At present the script reads the whole `README.gNewSense` file and - puts it in the second column of the table. The file is typically - about 10 lines big & contains newlines. ++ **S4** The list of packages which doesn't contain `README.gNewSense` + is barfed out to stdout. - Unforunately, the MoinMoin markup for the table doesn't allow the - columns to have new lines. So, the table generated by the script, at - present, must be manually edited to remove newlines. +[gns-deb-diff-notes]: http://www.gnewsense.org/sddhrth/gns-deb-diff-notes - A possible solution would be to have a one line description, of - how the respective package differs from Debian, at the beginning of - the `README.gNewSense`. This line can then be used by the script to - generate the table. +## Notes -2. At present, not all packages contain a `README.gNewSense` - file. It'd nice, if all packages that were modified/removed/added - in gNewSense have this file. +At present, not all packages contain a `README.gNewSense` file. It'd +nice, if all packages that were modified/removed/added in gNewSense +have this file. +See [here for more][gns-deb-diff-notes]. ## License