Item14347: Prune the cruft from the tools dir and improve tools script documentation.

In Support.Question1862 it became clear that there are files in tools/pkg that are not used/useless, and the documentation of scripts in there is weak.

means it's been killed.

	File	Released?	What is it?	Status
	addpod.pl	N	tool to add Empire-style POD function doc headers. Originally used as a one-shot to add headers on undocumented code. Probably never used again, and a generally bad idea.	junk
	autoBuildFoswiki.pl	N	Used by the automated test/build scripts run by FlorianSchlichting	required
	benchmark.pl	N	uses a now-useless methodology	junk
	benchmark/*	N	Benchmark scripts	junk
	branches	N	print GIT branches	develop?
	build_all_extensions.pl	N	Build and upload all the extensions, zipping those that don't have proper build scripts. Sounds terrible.	?
	builddistros.pl	N	Hangover from the Empire?	?
	build.pl	N	This builds the Foswiki releases.	required
	bulk_copy.pl	Y	Copy data between two decoupled Foswiki installs. Used for converting between charsets. Also for converting between stores. CDot fixed doc.	released
	check_extensions.pl	N	Verifies change logs of all core extensions, and core release notes. Run prior to building a release	required
	check_manifest.pl	N	Checks the extensions and core manifest files for inconsistencies. Used by check_extensions.pl	required
	check_manifests.sh	N	Loops through all the extensions, running check_manifest.pl. Obsolete, replaced by check_extensions.pl.	Obsolete?
	checkout_extensions	N	Obsolete - uses git svn clone to check out extensknos.	junk
	check_requires.pl	N	Obsolete - hangover from the Empire.	junk
	check_translations	N	Obsolete - Formerly used to upload translation status.	obsolete
	configure	Y	Command-line configure	released
	convertTopicSettings.pl	Y	UpgradeGuide	released
	create_large_groups.pl	N	Test support, but not used AFAIK. (Used to debug a group performance issue)	Archive
	dependencies	Y	Shell access to dependencies	released
	dependencies_installer.pl	N	Dependencies installer, but not shipped. Is this useful? (Removed from release per Item13266
	extender.pl	Y	CDot fixed doc	released
	extension_installer	Y	CDot fixed doc	released
	fix_file_dates.pl	N	Align file dates to TOPICINFO dates Needs better doc
	fix_file_permissions.sh	Y	CDot fixed doc	released
	fix_local_links.pl	N	Used by build.pl to sanitize generated docs.	required
	fix_permissions.sh	N	Looks like a one-shot that got checked in. Junk?
	fixTopicInfo.pl	N	Looks like a version of the fix_topic_timestamps. Trash?
	fix_topic_timestamps.pl	N	useful for developers, probably should be in develop	develop
	foswiki-upgrade-check	N	used on foswiki.org to install new releases. Was Colas's script which he has deprecated.	required
	gendocs.pl	N	Static doc generator, use %POD instead	junk
	geturl.pl	Y	Standalone wget, curl. May be useful on hosted platforms that don't have it.	released
	git_excludes.pl	N	Used by pseudo_install and create_new_extension to build the git excludes files to prevent checkin of certain files.
	install_defaultweb_topics.pl	N	Never touched since fork	junk
	lighttpd.pl	Y	Starts a lighttpd server in the current installation. (Shoud this just be a developer tool?) No, CDot fixed doc	released
	MemoryCycleTests.pl	N	Detect memory leaks. Run before building each release. See BuildingARelease	required
	mergeDoc.pl	N	Old dev stuff	junk
	perlmod2www.pl	N	Not touched for years	junk
	plugins_conformance_analyser.pl	N	Very old, not used AFAIK	junk
	README	N	Talks about the Empire!	junk
	repair_rcs_lite.pl	N	Ancien regime	junk
	rewriteshebang.pl	Y		released
	save-pending-checkins	Y	This is not documented anywhere that I can find. MichaelDaum utility. CDot fixed doc.	released
	showSlowPerl.pl	N	Prob used to illustrate upstream bug report	junk
	tick_foswiki.pl	Y		released
	twiki2foswiki	N	Convert imperial extensions to Foswiki, way out of date	junk
	twiki2foswiki_mac	N	Convert imperial extensions to Foswiki, way out of date	junk
	twiki2Foswiki.sh	N	One shot conversion to Foswiki, way out of date	junk
	upgradeformat	N	very old one-shot from the heyday of the Empire	junk
	xgettext	N	Extract strings from source code	required
	admin/PiwikPlugin.pm	N	Looks like a partial plugin? Presumably for Piwiki analytics. Not touched since 2009. Sven's work?	junk
	admin/mrtg/twiki.cfg	N	something to do with analytics?	junk
	admin/mrtg/twiki.pl	N	Logfile analysis	junk
	benchmark/*	N	Old, disreputable benchmarks used by the Empire	junk
	develop/analyse.pl	N	Analyse top contributors
	develop/cron.pl	N	Auto-update for the Imperial Death Star	junk
	develop/cron.sh	N	Auto-update for the Imperial Death Star	junk
	develop/foswiki-github-hooks.pl	N	Runs on f.o with cron job. Maintains/inserts hooks into the github repositories.
	develop/foswiki-github-mirror.pl	N	Runs on f.o with cron job. Mirrors modified repositories onto the f.o server.
	develop/foswiki-git-upgrade.pl	N	obsolete - uses "git svn"	junk
	develop/foswiki-trunk-update.sh	N	Runs every 15 minutes on cron job - updates trunk.foswiki.org.
	develop/genwebnotify.pl	N	Runs on f.o with cron job - rebuilds the WebNotify topic.
	develop/git-fix-meta.pl	N	Yet another duplicate of: tools/fix_topic_timestamps.pl and tools/fixTopicInfo.pl
	develop/git-svn-show.pl	N	Used for the old svn git repository.	junk
	develop/git-svn-split.pl	N	Used for the old git-svn repository	junk
	develop/plague.pl	N	Run on f.o cron job - Sends emails about tasks waiting for feedback.
	develop/post-commit.pl	N	Subversion post commit	junk
	develop/pre-commit.pl	N	Subversion pre commit	junk
	develop/twitter.pl	N	Subversion updates to Twitter
	develop/githooks/commit-msg	N	hooks installed by pseudo_install.pl
	develop/githooks/pre-commit	N	hooks installed by pseudo_install.pl
	develop/hooks/commit-email.pl	N	Subversion	junk
	develop/hooks/git-svn-split.pl	N	Subversion	junk
	develop/hooks/post-commit	N	Subversion	junk
	develop/hooks/post-commit.tmpl	N	Subversion	junk
	develop/hooks/post-revprop-change.tmpl	N	Subversion	junk
	develop/hooks/pre-commit	N	Subversion	junk
	develop/hooks/pre-commit.tmpl	N	Subversion	junk
	develop/hooks/pre-receive	N	Subversion	junk
	develop/hooks/pre-revprop-change.tmpl	N	Subversion	junk
	develop/hooks/rssfeed.sh	N	Subversion	junk
	develop/hooks/start-commit.tmpl	N	Subversion	junk
	develop/hooks/svnlog.xslt	N	Subversion	junk
	distro/*	N	Looks like building using EPM, presumably targeting RPM, apt, etc. Not been touched in ages. Probably junk.	junk
	pkg/*	N	Build debian packages, unsupported and attempts to reverse-engineer have failed	junk

-- CrawfordCurrie - 22 Mar 2017

Crawford. The hooks directory is gone, and I deleted anything that used svn or git-svn commands. Any left either mention svn in the email address of our mailing list, or have an svn option that can be removed. Also removed a bunch more stuff. Marking them with

-- GeorgeClark - 25 Mar 2017

May be a few more to clean up but I left anything that was at all questionable. It would probably be a nice idea to reorganize a bit, but that will need to be cautious. foswiki.org runs a bunch of these scripts, and it will need careful coordination.

-- GeorgeClark - 25 Mar 2017

For reorganizing this, I'm thinking that we could do the following:

• Build related tools:
  • Move all the build specific tools into a tools/build directory
  • build.pl fix_local_links.pl autoBuildFoswiki.pl
  • Need to coordinate autobuild changes with Florian
  • Move that directory into the BuildContrib.
• Developer specific tools - Move into tools/develop
  • check_extensions.pl check_manifest.pl branches xgettext git_excludes.pl
• Foswiki.org utilities and site specific tools - move into foswiki.org directory
  • Make them part of the the FoswikiOrgPlugin (This will loose the revision history)
  • analyse.pl foswiki-github-hooks.pl foswiki-github-mirror.pl foswiki-trunk-update.sh genwebnotify.pl plague.pl
• move systemd/foswiki.service up to the tools directory. or consider moving the init-script, defaults and service file into a fastcgi directory

-- GeorgeClark - 25 Mar 2017

Yup, that all makes sense. It would be sensible to do a pass through all the scripts and make sure they have usage or, at worst, internal doc. Also READMEs in each subdir would be a good idea.

-- Main.CrawfordCurrie - 26 Mar 2017 - 09:44

Commenting is disabled while not logged in