introduction to ftpteam-helper ------------------------------ The git repository at ships 2 tools: magicgrep.py, licgrep.py, and the newest version of this README. Both tools should ease the NEW checking process and might be integrated into either lintian or dak in the future. They cannot fully replace the manual checks. Both tools can either be run without arguments or with 1 argument which should point to an archive file (tarball, zip file, ...). They will either scan the current directory recursively or the temporary directory with the unpacked content of the archive. They won't recursively descent into any archive files it finds nor will they automatically uncompress any compressed files yet. But such files will be reported for manual inspection. TODO: recurse into archive files + uncompress compressed files Please send any bug and ideas to . magicgrep.py ------------ Magicgrep uses libmagic to search for generated or otherwise suspicious content. It will report compiled code, PDF files, true type fonts, and often false positives. Those files should be checked manually. It skips typical source files and other formats we accept as source formats e.g. image files. It won't report anything for a tarball that ships source code and image files only letting you concentrate on checking the license headers. licgrep.py ---------- Licgrep reads most files (skipping e.g. image files), decodes various encodings (utf-8, utf-16-le, utf-16-be, iso8859-1) automatically (mc can't do that!), and searches for copyright/license headers. It tries to be smart to strip source code that follows the license header and it won't report more than 4k characters if it fails to detect source code. It will report everything it finds and at the end it will report all filenames without a match for manual inspection. The handling of binary files is not optimal because they are detected as iso8859-1. Binary files either match if they contain the copyright sign or are reported as files without a match. TODO: detect binary files and report them separately Torsten Werner Mon Aug 31 22:12:33 CEST 2009