go/zodb/fs1: Start fs1tools - tools for managing and maintaining ZODB FileStorage v1 databases

go/zodb/storage/fs1/cmd/fs1/.gitignore

+/fs1

go/zodb/storage/fs1/cmd/fs1/fs1.go

+// Copyright (C) 2017  Nexedi SA and Contributors.
+//                     Kirill Smelkov <kirr@nexedi.com>
+//
+// This program is free software: you can Use, Study, Modify and Redistribute
+// it under the terms of the GNU General Public License version 3, or (at your
+// option) any later version, as published by the Free Software Foundation.
+//
+// You can also Link and Combine this program with other software covered by
+// the terms of any of the Free Software licenses or any of the Open Source
+// Initiative approved licenses and Convey the resulting work. Corresponding
+// source of such a combination shall include the source code for all other
+// software used.
+//
+// This program is distributed WITHOUT ANY WARRANTY; without even the implied
+// warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+//
+// See COPYING file for full licensing terms.
+// See https://www.nexedi.com/licensing for rationale and options.
+
+// fs1 is a driver program for running and invoking fs1 subcommands.
+package main
+
+import (
+	"lab.nexedi.com/kirr/neo/go/zodb/storage/fs1/fs1tools"
+)
+
+func main() {
+	fs1tools.Prog.Main()
+}

go/zodb/storage/fs1/filestorage.go

@@ -59,6 +59,9 @@
 // The fs1 package exposes all FileStorage data format details and most of
 // internal workings so that it is possible to implement FileStorage-specific
 // tools.
+//
+// See also package lab.nexedi.com/kirr/neo/go/zodb/storage/fs1/fs1tools and
+// associated fs1 command for basic tools related to FileStorage maintenance.
 package fs1
 
 import (

go/zodb/storage/fs1/fs1tools/main.go

+// Copyright (C) 2017  Nexedi SA and Contributors.
+//                     Kirill Smelkov <kirr@nexedi.com>
+//
+// This program is free software: you can Use, Study, Modify and Redistribute
+// it under the terms of the GNU General Public License version 3, or (at your
+// option) any later version, as published by the Free Software Foundation.
+//
+// You can also Link and Combine this program with other software covered by
+// the terms of any of the Free Software licenses or any of the Open Source
+// Initiative approved licenses and Convey the resulting work. Corresponding
+// source of such a combination shall include the source code for all other
+// software used.
+//
+// This program is distributed WITHOUT ANY WARRANTY; without even the implied
+// warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+//
+// See COPYING file for full licensing terms.
+// See https://www.nexedi.com/licensing for rationale and options.
+
+// Package fs1tools provides tools for managing and maintaining ZODB FileStorage v1 databases.
+package fs1tools
+
+import "lab.nexedi.com/kirr/go123/prog"
+
+var commands = prog.CommandRegistry{
+}
+
+var helpTopics = prog.HelpRegistry{
+	// XXX for now empty
+}
+
+// main fs1 driver
+var Prog = prog.MainProg{
+        Name:       "fs1",
+        Summary:    "Fs1 is a tool for managing and maintaining ZODB FileStorage v1 databases",
+        Commands:   commands,
+        HelpTopics: helpTopics,
+}